public class LabelProvider extends EventManager implements ILabelProvider
toString value for its text and null for its image.
This class may be used as is, or subclassed to provide richer labels. Subclasses may override any of the following methods:
isLabelPropertygetImagegetTextdispose| Constructor and Description |
|---|
LabelProvider()
Creates a new label provider.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addListener(ILabelProviderListener listener)
Adds a listener to this label provider.
|
void |
dispose()
The
LabelProvider implementation of this
IBaseLabelProvider method does nothing. |
protected void |
fireLabelProviderChanged(LabelProviderChangedEvent event)
Fires a label provider changed event to all registered listeners
Only listeners registered at the time this method is called are notified.
|
Image |
getImage(Object element)
The
LabelProvider implementation of this
ILabelProvider method returns null. |
String |
getText(Object element)
The
LabelProvider implementation of this
ILabelProvider method returns the element's toString
string. |
boolean |
isLabelProperty(Object element,
String property)
The
LabelProvider implementation of this
IBaseLabelProvider method returns true. |
void |
removeListener(ILabelProviderListener listener)
Removes a listener to this label provider.
|
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObjectpublic void addListener(ILabelProviderListener listener)
IBaseLabelProviderLabel provider listeners are informed about state changes that affect the rendering of the viewer that uses this label provider.
addListener in interface IBaseLabelProviderlistener - a label provider listenerpublic void dispose()
LabelProvider implementation of this
IBaseLabelProvider method does nothing. Subclasses may extend.dispose in interface IBaseLabelProviderprotected void fireLabelProviderChanged(LabelProviderChangedEvent event)
event - a label provider changed eventILabelProviderListener.labelProviderChanged(org.eclipse.jface.viewers.LabelProviderChangedEvent)public Image getImage(Object element)
LabelProvider implementation of this
ILabelProvider method returns null. Subclasses may
override.getImage in interface ILabelProviderelement - the element for which to provide the label imagenull
if there is no image for the given objectpublic String getText(Object element)
LabelProvider implementation of this
ILabelProvider method returns the element's toString
string. Subclasses may override.getText in interface ILabelProviderelement - the element for which to provide the label textnull
if there is no text label for the given objectpublic boolean isLabelProperty(Object element, String property)
LabelProvider implementation of this
IBaseLabelProvider method returns true. Subclasses may
override.isLabelProperty in interface IBaseLabelProviderelement - the elementproperty - the propertytrue if the label would be affected,
and false if it would be unaffectedpublic void removeListener(ILabelProviderListener listener)
IBaseLabelProviderremoveListener in interface IBaseLabelProviderlistener - a label provider listenerGuidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.