|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.viewers.LabelDecorator
The LabelDecorator is an abstract superclass of ILabelDecorators that support IDecorationContext.
IDecorationContext
Constructor Summary | |
---|---|
LabelDecorator()
|
Method Summary | |
---|---|
abstract 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 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 boolean |
prepareDecoration(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, wait |
Methods inherited from interface org.eclipse.jface.viewers.ILabelDecorator |
---|
decorateImage, decorateText |
Methods inherited from interface org.eclipse.jface.viewers.IBaseLabelProvider |
---|
addListener, dispose, isLabelProperty, removeListener |
Constructor Detail |
public LabelDecorator()
Method Detail |
public abstract Image decorateImage(Image image, Object element, IDecorationContext context)
image
- the input image to decorate, or null
if the element has no imageelement
- the element whose image is being decoratedcontext
- additional context information about the element being decorated
null
if no decoration is to be appliedLabelProviderChangedEvent
,
IBaseLabelProvider.addListener(org.eclipse.jface.viewers.ILabelProviderListener)
,
CompositeImageDescriptor
public abstract String decorateText(String text, Object element, IDecorationContext context)
text
- the input text label to decorateelement
- the element whose image is being decoratedcontext
- additional context information about the element being decorated
null
if no decoration is to be appliedLabelProviderChangedEvent
,
IBaseLabelProvider.addListener(org.eclipse.jface.viewers.ILabelProviderListener)
public abstract boolean prepareDecoration(Object element, String originalText, IDecorationContext context)
element
- The element to be decoratedoriginalText
- The starting text.context
- The decoration context
true
if the decoration is ready for this element
|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.