com.ibm.rational.common.test.editor.framework.extensions

Class ExtLabelProvider

    • Constructor Detail

      • ExtLabelProvider

        public ExtLabelProvider()
    • Method Detail

      • canHandle

        public boolean canHandle(Object object)
        Deprecated. version 6.1.2
        See Also:
        com.ibm.rational.common.editor.framework.kernel.extensions.IExtensiblePrivider#canHandle(java.lang.Object)
      • flushCachedData

        @Deprecated
        public void flushCachedData()
        Deprecated. 
        Since RPT 8.5 a provider can no longer be reused from an editor to another.
        See Also:
        ExtLabelProvider.dispose()
      • getTooltipText

        public String getTooltipText(CBActionElement element)
        Specified by:
        getTooltipText in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider
        Returns:
        the value of "statusLine" attribute. If null, calls getStatusLine().
        See Also:
        IDisplayNameProvider.getTooltipText(com.ibm.rational.test.common.models.behavior.CBActionElement)
      • getStatusLine

        public String getStatusLine(CBActionElement element)
        Specified by:
        getStatusLine in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider
        Returns:
        the value of "statusLine" attribute. If null, calls getText().
        See Also:
        IDisplayNameProvider.getStatusLine(com.ibm.rational.test.common.models.behavior.CBActionElement)
      • getSectionDescription

        public String getSectionDescription(CBActionElement element)
        Specified by:
        getSectionDescription in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider
        Returns:
        the value of "description" attribute. If null, calls getText().
        See Also:
        IDisplayNameProvider.getSectionDescription(com.ibm.rational.test.common.models.behavior.CBActionElement)
      • getMenuText

        public String getMenuText(CBActionElement element)
        Default implementation:

          String text = m_confElement.getAttribute( "menuText" ); //$NON-NLS-1$
          if( text == null )
              text = ( element == null ) ? getDisplayName() : getText( element ); 
          return text;
         
         
        Specified by:
        getMenuText in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider
        Returns:
        text to be used in "Add" and "Insert" menus.
        See Also:
        IDisplayNameProvider.getMenuText(com.ibm.rational.test.common.models.behavior.CBActionElement)
      • getDisplayName

        public String getDisplayName()
        Specified by:
        getDisplayName in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider
      • getImageDescriptor

        public ImageDescriptor getImageDescriptor(CBActionElement element)
        Specified by:
        getImageDescriptor in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider
      • getImageRegistry

        protected abstract ImageRegistry getImageRegistry()
        This method is called from getImage and getImageDescriptor. If ImageRegistry is not null, it will be searched first for a preloaded image/imageDescriptor.

        If no image/imageDescriptor is found in the ImageRegistry, the loaded object will be saved there.

        To efficiently manage resources, extending plugins should override this method and return ImageRegistry from their Plugin class.

        Returns:
        ImageRegistry associated with calling plugin. The default implementation returns null.
      • getDisabledImage

        public Image getDisabledImage(Image baseImage)
        Returns a copy of the baseImage created with SWT.IMAGE_DISABLE flag. If the baseImage is null, then null is returned. The disabled image is cached, so any subsequent call to this method with different baseImage will return a cached copy and nota new disabled image.

        Normal use is to call getDisabledImage( getImage( modelElement )), even though typically clients have no need to ever call this method.

        Parameters:
        baseImage - Image typically obtained from the call to ExtLabelProvider.getImage(Object).
        Returns:
        Image the copy of the baseImage which has a disabled look (cached).
        Since:
        7.0
      • getGreyScaleImage

        public Image getGreyScaleImage(Image baseImage)
        Returns a copy of the baseImage created with SWT.IMAGE_GRAY flag. If the baseImage is null, then null is returned. The grey-scale image is cached, so any subsequent call to this method with different baseImage will return a cached copy and nota new grey-scale image.

        Normal use is to call getDisabledImage( getImage( modelElement )), even though typically clients have no need to ever call this method.

        Parameters:
        baseImage - Image typically obtained from the call to ExtLabelProvider.getImage(Object).
        Returns:
        Image the copy of the baseImage which has a grey-scale look (cached).
        Since:
        7.0
      • getDisabledPrefix

        public static String getDisabledPrefix(String mainText)
      • showColoredLabels

        public static boolean showColoredLabels()
IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2013. All rights reserved.