org.eclipse.jface.viewers
Interface ILabelDecorator

All Superinterfaces:

IBaseLabelProvider

public interface ILabelDecorator

extends IBaseLabelProvider

A label decorator decorates the label text and image for some element. The original label text and image are obtained by some other means, for example by a label provider.

See Also:

ILabelProvider

Method Summary

Image	decorateImage(Image image, Object element) Returns an image that is based on the given image, but decorated with additional information relating to the state of the provided element.
String	decorateText(String text, Object element) 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.

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

addListener, dispose, isLabelProperty, removeListener

Method Detail

decorateImage

public Image decorateImage(Image image,
                           Object element)

Returns an image that is based on the given image, but decorated with additional information relating to the state of the provided element.

Parameters:

image - the input image to decorate, or null if the element has no image

element - the element whose image is being decorated

Returns:

the decorated image, or null if no decoration is to be applied

See Also:

CompositeImageDescriptor

decorateText

public String decorateText(String text,
                           Object element)

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.

Parameters:

text - the input text label to decorate

element - the element whose image is being decorated

Returns:

the decorated text label, or null if no decoration is to be applied