Package org.eclipse.jface.viewers
Class LabelProvider
- java.lang.Object
-
- org.eclipse.core.commands.common.EventManager
-
- org.eclipse.jface.viewers.BaseLabelProvider
-
- org.eclipse.jface.viewers.LabelProvider
-
- All Implemented Interfaces:
IBaseLabelProvider
,ILabelProvider
- Direct Known Subclasses:
ComboBoxLabelProvider
,DecoratingLabelProvider
,EnvironmentTab.EnvironmentVariableLabelProvider
,FileEditorMappingLabelProvider
,NamedHandleObjectLabelProvider
,ObservableMapLabelProvider
,PerspectiveLabelProvider
,PreferenceLabelProvider
,RefactoringHistoryLabelProvider
,URLLabelProvider
,WorkbenchLabelProvider
,WorkbenchPartLabelProvider
public class LabelProvider extends BaseLabelProvider implements ILabelProvider
A label provider implementation which, by default, uses an element'stoString
value for its text andnull
for its image.This class may be used as is, or subclassed to provide richer labels. Subclasses may override any of the following methods:
isLabelProperty
getImage
getText
dispose
-
-
Constructor Summary
Constructors Constructor Description LabelProvider()
Creates a new label provider.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LabelProvider
createImageProvider(Function<Object,Image> imageFunction)
Creates aLabelProvider
which implements thegetImage(java.lang.Object)
method by calling the argument function.static LabelProvider
createTextImageProvider(Function<Object,String> textFunction, Function<Object,Image> imageFunction)
Creates aLabelProvider
which implements both thegetText(java.lang.Object)
andgetImage(java.lang.Object)
methods by calling the argument functions.static LabelProvider
createTextProvider(Function<Object,String> textFunction)
Creates aLabelProvider
which implements thegetText(java.lang.Object)
method by calling the argument function.Image
getImage(Object element)
TheLabelProvider
implementation of thisILabelProvider
method returnsnull
.String
getText(Object element)
TheLabelProvider
implementation of thisILabelProvider
method returns the element'stoString
string.-
Methods inherited from class org.eclipse.jface.viewers.BaseLabelProvider
addListener, dispose, fireLabelProviderChanged, isLabelProperty, removeListener
-
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
-
Methods inherited from interface org.eclipse.jface.viewers.IBaseLabelProvider
addListener, dispose, isLabelProperty, removeListener
-
-
-
-
Method Detail
-
getImage
public Image getImage(Object element)
TheLabelProvider
implementation of thisILabelProvider
method returnsnull
. Subclasses may override.- Specified by:
getImage
in interfaceILabelProvider
- Parameters:
element
- the element for which to provide the label image- Returns:
- the image used to label the element, or
null
if there is no image for the given object
-
getText
public String getText(Object element)
TheLabelProvider
implementation of thisILabelProvider
method returns the element'stoString
string. Subclasses may override.- Specified by:
getText
in interfaceILabelProvider
- Parameters:
element
- the element for which to provide the label text- Returns:
- the text string used to label the element, or
null
if there is no text label for the given object
-
createTextProvider
public static LabelProvider createTextProvider(Function<Object,String> textFunction)
Creates aLabelProvider
which implements thegetText(java.lang.Object)
method by calling the argument function.- Parameters:
textFunction
- the function which returns the text- Returns:
- The new LabelProvider
- Since:
- 3.19
-
createImageProvider
public static LabelProvider createImageProvider(Function<Object,Image> imageFunction)
Creates aLabelProvider
which implements thegetImage(java.lang.Object)
method by calling the argument function.- Parameters:
imageFunction
- the function which returns the image- Returns:
- The new LabelProvider
- Since:
- 3.19
-
createTextImageProvider
public static LabelProvider createTextImageProvider(Function<Object,String> textFunction, Function<Object,Image> imageFunction)
Creates aLabelProvider
which implements both thegetText(java.lang.Object)
andgetImage(java.lang.Object)
methods by calling the argument functions.- Parameters:
textFunction
- the function which returns the textimageFunction
- the function which returns the image- Returns:
- The new LabelProvider
- Since:
- 3.19
-
-