| java.lang.Object
 org.eclipse.jface.viewers.LabelDecorator
| LabelDecorator | | abstract public class LabelDecorator implements ILabelDecorator(Code) | | The LabelDecorator is an abstract superclass of ILabelDecorators
that support IDecorationContext.
See Also: IDecorationContext
since:
3.2 |
| Method Summary | |
| abstract public Image | decorateImage(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 public String | decorateText(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 public boolean | prepareDecoration(Object element, String originalText, IDecorationContext context)
Prepare the element for decoration. |
| decorateImage | | abstract public Image decorateImage(Image image, Object element, IDecorationContext context)(Code) | | 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.
See Also: LabelProviderChangedEvent
See Also: IBaseLabelProvider.addListener
Parameters:
image - the input image to decorate, or null if the element has no image
Parameters:
element - the element whose image is being decorated
Parameters:
context - additional context information about the element being decorated the decorated image, or null if no decoration is to be applied
See Also: org.eclipse.jface.resource.CompositeImageDescriptor |
| decorateText | | abstract public String decorateText(String text, Object element, IDecorationContext context)(Code) | | 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.
See Also: LabelProviderChangedEvent
See Also: IBaseLabelProvider.addListener
Parameters:
text - the input text label to decorate
Parameters:
element - the element whose image is being decorated
Parameters:
context - additional context information about the element being decorated the decorated text label, or null if no decoration is to be applied |
| prepareDecoration | | abstract public boolean prepareDecoration(Object element, String originalText, IDecorationContext context)(Code) | | 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 decorated
Parameters:
originalText - The starting text.
Parameters:
context - The decoration context boolean true if the decoration is ready for this element |
|
|