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,TreeColumnViewerLabelProvider
public class ColumnLabelProvider extends CellLabelProvider implements IFontProvider, IColorProvider, ILabelProvider
The ColumnLabelProvider is the label provider for viewers that have column support such asTreeViewerandTableViewerThis classes is intended to be subclassed
- Since:
- 3.3
-
-
Constructor Summary
Constructors Constructor Description ColumnLabelProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ColorgetBackground(Object element)Provides a background color for the given element.FontgetFont(Object element)Provides a font for the given element.ColorgetForeground(Object element)Provides a foreground color for the given element.ImagegetImage(Object element)Returns the image for the label of the given element.StringgetText(Object element)Returns the text for the label of the given element.voidupdate(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
-
-
-
-
Method Detail
-
update
public void update(ViewerCell cell)
Description copied from class:CellLabelProviderUpdate the label for cell.- Specified by:
updatein classCellLabelProvider- Parameters:
cell-ViewerCell
-
getFont
public Font getFont(Object element)
Description copied from interface:IFontProviderProvides a font for the given element.- Specified by:
getFontin interfaceIFontProvider- Parameters:
element- the element- Returns:
- the font for the element, or
nullto use the default font
-
getBackground
public Color getBackground(Object element)
Description copied from interface:IColorProviderProvides a background color for the given element.- Specified by:
getBackgroundin interfaceIColorProvider- Parameters:
element- the element- Returns:
- the background color for the element, or
nullto use the default background color
-
getForeground
public Color getForeground(Object element)
Description copied from interface:IColorProviderProvides a foreground color for the given element.- Specified by:
getForegroundin interfaceIColorProvider- Parameters:
element- the element- Returns:
- the foreground color for the element, or
nullto use the default foreground color
-
getImage
public Image getImage(Object element)
Description copied from interface:ILabelProviderReturns 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:
getImagein interfaceILabelProvider- Parameters:
element- the element for which to provide the label image- Returns:
- the image used to label the element, or
nullif there is no image for the given object
-
getText
public String getText(Object element)
Description copied from interface:ILabelProviderReturns the text for the label of the given element.- Specified by:
getTextin interfaceILabelProvider- Parameters:
element- the element for which to provide the label text- Returns:
- the text string used to label the element, or
nullif there is no text label for the given object
-
-