|
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.core.commands.common.EventManager
org.eclipse.jface.viewers.LabelProvider
public class LabelProvider
A label provider implementation which, by default, uses an element's
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 Summary | |
|---|---|
LabelProvider()
Creates a new label provider. |
|
| Method Summary | |
|---|---|
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. |
| Methods inherited from class org.eclipse.core.commands.common.EventManager |
|---|
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public LabelProvider()
| Method Detail |
|---|
public 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 image
null
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 text
null
if there is no text label for the given object
public boolean isLabelProperty(Object element,
String property)
LabelProvider implementation of this
IBaseLabelProvider method returns true. Subclasses may
override.
isLabelProperty in interface IBaseLabelProviderelement - the elementproperty - the property
true if the label would be affected,
and false if it would be unaffectedpublic void removeListener(ILabelProviderListener listener)
IBaseLabelProvider
removeListener in interface IBaseLabelProviderlistener - a label provider listener
|
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.