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

Class ExtLabelProvider

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.jface.viewers.BaseLabelProvider

org.eclipse.jface.viewers.LabelProvider

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

All Implemented Interfaces:

IExtensiblePrivider, com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider, IExecutableExtension, IBaseLabelProvider, IColorProvider, IFontProvider, ILabelDecorator, ILabelProvider

public abstract class ExtLabelProvider
extends LabelProvider
implements IExtensiblePrivider, com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider, ILabelDecorator, IFontProvider, IColorProvider

Field Summary

Fields inherited from interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider

AS_DISPLAY_NAME_FORMATTED, AS_DISPLAY_NAME_UNFORMATTED, AS_HYPER_LINK, AS_MENU_TEXT_FORMATTED, AS_MENU_TEXT_UNFORMATTED, AS_STATUS_LINE, AS_TOOLTIP_FORMATTED, AS_TOOLTIP_UNFORMATTED, TYPE_FORMATTED, TYPE_UNFORMATTED

Constructor Summary

Constructors

Constructor and Description
ExtLabelProvider()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHandle(Object object) Deprecated. version 6.1.2
Image	decorateImage(Image image, Object element)
String	decorateText(String text, Object element)
void	dispose()
void	flushCachedData() Deprecated.
Color	getBackground(Object element)
Image	getDisabledImage(Image baseImage) Returns a copy of the baseImage created with SWT.IMAGE_DISABLE flag.
static String	getDisabledPrefix(String mainText)
String	getDisplayName() This implementation returns the value of the "label" attribute in the modelObject declaration.
Font	getFont(Object element)
Color	getForeground(Object element)
Image	getGreyScaleImage(Image baseImage) Returns a copy of the baseImage created with SWT.IMAGE_GRAY flag.
Image	getImage(Object element)
ImageDescriptor	getImageDescriptor(CBActionElement element)
protected abstract ImageRegistry	getImageRegistry() This method is called from getImage and getImageDescriptor.
String	getMenuText(CBActionElement element) Default implementation: String text = m_confElement.getAttribute( "menuText" ); //$NON-NLS-1$ if( text == null ) text = ( element == null ) ?
String	getSectionDescription(CBActionElement element)
String	getStatusLine(CBActionElement element)
TestEditor	getTestEditor()
String	getText(Object element)
String	getTooltipText(CBActionElement element)
void	setInitializationData(IConfigurationElement config, String propertyName, Object data)
void	setTestEditor(TestEditor testEditor)
static boolean	showColoredLabels()

Methods inherited from class org.eclipse.jface.viewers.BaseLabelProvider

addListener, fireLabelProviderChanged, isLabelProperty, removeListener

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.jface.viewers.IBaseLabelProvider

addListener, isLabelProperty, removeListener

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)

dispose

public void dispose()

Specified by:

dispose in interface IBaseLabelProvider

Overrides:

dispose in class BaseLabelProvider

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()

decorateImage

public Image decorateImage(Image image,
                  Object element)

Specified by:

decorateImage in interface ILabelDecorator

decorateText

public String decorateText(String text,
                  Object element)

Specified by:

decorateText in interface ILabelDecorator

setTestEditor

public void setTestEditor(TestEditor testEditor)

Specified by:

setTestEditor in interface IExtensiblePrivider

getTestEditor

public TestEditor getTestEditor()

Specified by:

getTestEditor in interface IExtensiblePrivider

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)

getText

public String getText(Object element)

Specified by:

getText in interface ILabelProvider

Overrides:

getText in class LabelProvider

Returns:

value of "treeLabel" attribute from the label provider declaration. If null, returns the label of the model object declaration. If still null, returns super.getText().

See Also:

ILabelProvider.getText(java.lang.Object)

setInitializationData

public void setInitializationData(IConfigurationElement config,
                         String propertyName,
                         Object data)
                           throws CoreException

Specified by:

setInitializationData in interface IExecutableExtension

Throws:

CoreException

getDisplayName

public String getDisplayName()

This implementation returns the value of the "label" attribute in the modelObject declaration.

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

getImage

public Image getImage(Object element)

Specified by:

getImage in interface ILabelProvider

Overrides:

getImage in class LabelProvider

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.

getFont

public Font getFont(Object element)

Specified by:

getFont in interface IFontProvider

getForeground

public Color getForeground(Object element)

Specified by:

getForeground in interface IColorProvider

getBackground

public Color getBackground(Object element)

Specified by:

getBackground in interface IColorProvider

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()