public abstract class ExtLabelProvider extends LabelProvider implements IExtensiblePrivider, com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider, ILabelDecorator, IFontProvider, IColorProvider
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 and Description |
---|
ExtLabelProvider() |
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() |
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() |
addListener, fireLabelProviderChanged, isLabelProperty, removeListener
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addListener, isLabelProperty, removeListener
public boolean canHandle(Object object)
com.ibm.rational.common.editor.framework.kernel.extensions.IExtensiblePrivider#canHandle(java.lang.Object)
public void dispose()
dispose
in interface IBaseLabelProvider
dispose
in class BaseLabelProvider
@Deprecated public void flushCachedData()
ExtLabelProvider.dispose()
public Image decorateImage(Image image, Object element)
decorateImage
in interface ILabelDecorator
public String decorateText(String text, Object element)
decorateText
in interface ILabelDecorator
public void setTestEditor(TestEditor testEditor)
setTestEditor
in interface IExtensiblePrivider
public TestEditor getTestEditor()
getTestEditor
in interface IExtensiblePrivider
public String getTooltipText(CBActionElement element)
getTooltipText
in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider
"statusLine"
attribute. If null
, calls getStatusLine()
.IDisplayNameProvider.getTooltipText(com.ibm.rational.test.common.models.behavior.CBActionElement)
public String getStatusLine(CBActionElement element)
getStatusLine
in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider
"statusLine"
attribute. If null
, calls getText()
.IDisplayNameProvider.getStatusLine(com.ibm.rational.test.common.models.behavior.CBActionElement)
public String getSectionDescription(CBActionElement element)
getSectionDescription
in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider
"description"
attribute. If null
, calls getText()
.IDisplayNameProvider.getSectionDescription(com.ibm.rational.test.common.models.behavior.CBActionElement)
public String getMenuText(CBActionElement element)
String text = m_confElement.getAttribute( "menuText" ); //$NON-NLS-1$ if( text == null ) text = ( element == null ) ? getDisplayName() : getText( element ); return text;
getMenuText
in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider
IDisplayNameProvider.getMenuText(com.ibm.rational.test.common.models.behavior.CBActionElement)
public String getText(Object element)
getText
in interface ILabelProvider
getText
in class LabelProvider
"label"
attribute. If null
, calls super.getText()ILabelProvider.getText(java.lang.Object)
public void setInitializationData(IConfigurationElement config, String propertyName, Object data) throws CoreException
setInitializationData
in interface IExecutableExtension
CoreException
public String getDisplayName()
getDisplayName
in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider
public ImageDescriptor getImageDescriptor(CBActionElement element)
getImageDescriptor
in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IDisplayNameProvider
public Image getImage(Object element)
getImage
in interface ILabelProvider
getImage
in class LabelProvider
protected abstract ImageRegistry getImageRegistry()
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.
null
.public Font getFont(Object element)
getFont
in interface IFontProvider
public Color getForeground(Object element)
getForeground
in interface IColorProvider
public Color getBackground(Object element)
getBackground
in interface IColorProvider
public Image getDisabledImage(Image baseImage)
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.
baseImage
- Image typically obtained from the call to ExtLabelProvider.getImage(Object)
.baseImage
which has a disabled look (cached).public Image getGreyScaleImage(Image baseImage)
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.
baseImage
- Image typically obtained from the call to ExtLabelProvider.getImage(Object)
.baseImage
which has a grey-scale look (cached).public static boolean showColoredLabels()
© Copyright IBM Corp. 2013. All rights reserved.