Package org.eclipse.jface.viewers
Class ColumnLabelProvider
java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.jface.viewers.BaseLabelProvider
org.eclipse.jface.viewers.CellLabelProvider
org.eclipse.jface.viewers.ColumnLabelProvider
- All Implemented Interfaces:
IBaseLabelProvider
,IColorProvider
,IFontProvider
,ILabelProvider
,IToolTipProvider
- Direct Known Subclasses:
PropertyColumnLabelProvider
,TableColumnViewerLabelProvider
public class ColumnLabelProvider
extends CellLabelProvider
implements IFontProvider, IColorProvider, ILabelProvider
The ColumnLabelProvider is the label provider for viewers
that have column support such as
TreeViewer
and
TableViewer
This classes is intended to be subclassed
- Since:
- 3.3
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ColumnLabelProvider
createImageProvider
(Function<Object, Image> imageFunction) Creates aColumnLabelProvider
which implements thegetImage(java.lang.Object)
method by calling the argument function.static ColumnLabelProvider
Creates aColumnLabelProvider
which implements both thegetText(java.lang.Object)
andgetImage(java.lang.Object)
methods by calling the argument functions.static ColumnLabelProvider
createTextProvider
(Function<Object, String> textFunction) Creates aColumnLabelProvider
which implements thegetText(java.lang.Object)
method by calling the argument function.getBackground
(Object element) Provides a background color for the given element.Provides a font for the given element.getForeground
(Object element) Provides a foreground color for the given element.Returns the image for the label of the given element.Returns the text for the label of the given element.void
update
(ViewerCell cell) Update the label for cell.Methods inherited from class org.eclipse.jface.viewers.CellLabelProvider
dispose, getToolTipBackgroundColor, getToolTipDisplayDelayTime, getToolTipFont, getToolTipForegroundColor, getToolTipImage, getToolTipShift, getToolTipStyle, getToolTipText, getToolTipTimeDisplayed, initialize, useNativeToolTip
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
-
Constructor Details
-
ColumnLabelProvider
public ColumnLabelProvider()
-
-
Method Details
-
update
Description copied from class:CellLabelProvider
Update the label for cell.- Specified by:
update
in classCellLabelProvider
- Parameters:
cell
-ViewerCell
-
getFont
Description copied from interface:IFontProvider
Provides a font for the given element.- Specified by:
getFont
in interfaceIFontProvider
- Parameters:
element
- the element- Returns:
- the font for the element, or
null
to use the default font
-
getBackground
Description copied from interface:IColorProvider
Provides a background color for the given element.- Specified by:
getBackground
in interfaceIColorProvider
- Parameters:
element
- the element- Returns:
- the background color for the element, or
null
to use the default background color
-
getForeground
Description copied from interface:IColorProvider
Provides a foreground color for the given element.- Specified by:
getForeground
in interfaceIColorProvider
- Parameters:
element
- the element- Returns:
- the foreground color for the element, or
null
to use the default foreground color
-
getImage
Description copied from interface:ILabelProvider
Returns the image for the label of the given element. The image is owned by the label provider and must not be disposed directly. Instead, dispose the label provider when no longer needed.- 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
Description copied from interface:ILabelProvider
Returns the text for the label of the given element.- 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
Creates aColumnLabelProvider
which implements thegetText(java.lang.Object)
method by calling the argument function.- Parameters:
textFunction
- the function which returns the text- Returns:
- The new ColumnLabelProvider
- Since:
- 3.19
-
createImageProvider
Creates aColumnLabelProvider
which implements thegetImage(java.lang.Object)
method by calling the argument function.- Parameters:
imageFunction
- the function which returns the image- Returns:
- The new ColumnLabelProvider
- Since:
- 3.19
-
createTextImageProvider
public static ColumnLabelProvider createTextImageProvider(Function<Object, String> textFunction, Function<Object, Image> imageFunction) Creates aColumnLabelProvider
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 ColumnLabelProvider
- Since:
- 3.19
-