Package org.eclipse.jface.viewers
Class LabelDecorator
java.lang.Object
org.eclipse.jface.viewers.LabelDecorator
- All Implemented Interfaces:
IBaseLabelProvider,ILabelDecorator
The LabelDecorator is an abstract superclass of ILabelDecorators
that support IDecorationContext.
- Since:
- 3.2
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract ImagedecorateImage(Image image, Object element, IDecorationContext context) Returns an image that is based on the given image, but decorated with additional information relating to the state of the provided element taking into account the provided context.abstract StringdecorateText(String text, Object element, IDecorationContext context) Returns a text label that is based on the given text label, but decorated with additional information relating to the state of the provided element taking into account the provided context.abstract booleanprepareDecoration(Object element, String originalText, IDecorationContext context) Prepare the element for decoration.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.jface.viewers.IBaseLabelProvider
addListener, dispose, isLabelProperty, removeListenerMethods inherited from interface org.eclipse.jface.viewers.ILabelDecorator
decorateImage, decorateText
-
Constructor Details
-
LabelDecorator
public LabelDecorator()
-
-
Method Details
-
decorateImage
Returns an image that is based on the given image, but decorated with additional information relating to the state of the provided element taking into account the provided context. Text and image decoration updates can occur as a result of other updates within the workbench including deferred decoration by background processes. Clients should handle labelProviderChangedEvents for the given element to get the complete decoration.- Parameters:
image- the input image to decorate, ornullif the element has no imageelement- the element whose image is being decoratedcontext- additional context information about the element being decorated- Returns:
- the decorated image, or
nullif no decoration is to be applied - See Also:
-
decorateText
Returns a text label that is based on the given text label, but decorated with additional information relating to the state of the provided element taking into account the provided context. Text and image decoration updates can occur as a result of other updates within the workbench including deferred decoration by background processes. Clients should handle labelProviderChangedEvents for the given element to get the complete decoration.- Parameters:
text- the input text label to decorateelement- the element whose image is being decoratedcontext- additional context information about the element being decorated- Returns:
- the decorated text label, or
nullif no decoration is to be applied - See Also:
-
prepareDecoration
public abstract boolean prepareDecoration(Object element, String originalText, IDecorationContext context) Prepare the element for decoration. If it is already decorated and ready for update return true. If decoration is pending return false.- Parameters:
element- The element to be decoratedoriginalText- The starting text.context- The decoration context- Returns:
- boolean
trueif the decoration is ready for this element
-