Package org.eclipse.jface.viewers
Class TreeColumnViewerLabelProvider
- java.lang.Object
-
- org.eclipse.core.commands.common.EventManager
-
- org.eclipse.jface.viewers.BaseLabelProvider
-
- org.eclipse.jface.viewers.CellLabelProvider
-
- org.eclipse.jface.viewers.ColumnLabelProvider
-
- org.eclipse.jface.viewers.TreeColumnViewerLabelProvider
-
- All Implemented Interfaces:
IBaseLabelProvider
,IColorProvider
,IFontProvider
,ILabelProvider
,IToolTipProvider
public class TreeColumnViewerLabelProvider extends ColumnLabelProvider
TreeViewerLabelProvider is the ViewerLabelProvider that handles TreePaths.- Since:
- 3.3
-
-
Constructor Summary
Constructors Constructor Description TreeColumnViewerLabelProvider(IBaseLabelProvider labelProvider)
Create a new instance of the receiver with the supplied labelProvider.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Color
getBackground(Object element)
Provides a background color for the given element.Font
getFont(Object element)
Provides a font for the given element.Color
getForeground(Object element)
Provides a foreground color for the given element.Image
getImage(Object element)
Returns the image for the label of the given element.String
getText(Object element)
Returns the text for the label of the given element.ITreePathLabelProvider
getTreePathProvider()
Return the ITreePathLabelProvider for the receiver.void
setProviders(Object provider)
Set the any providers for the receiver that can be adapted from provider.void
update(ViewerCell cell)
Update the label for cell.void
updateLabel(ViewerLabel label, TreePath elementPath)
Update the label for the element with TreePath.-
Methods inherited from class org.eclipse.jface.viewers.ColumnLabelProvider
createImageProvider, createTextImageProvider, createTextProvider
-
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 Detail
-
TreeColumnViewerLabelProvider
public TreeColumnViewerLabelProvider(IBaseLabelProvider labelProvider)
Create a new instance of the receiver with the supplied labelProvider.- Parameters:
labelProvider
- the label provider
-
-
Method Detail
-
updateLabel
public void updateLabel(ViewerLabel label, TreePath elementPath)
Update the label for the element with TreePath.- Parameters:
label
- the label to updateelementPath
- the path of the element being decorated
-
setProviders
public void setProviders(Object provider)
Set the any providers for the receiver that can be adapted from provider.- Parameters:
provider
-Object
-
getTreePathProvider
public ITreePathLabelProvider getTreePathProvider()
Return the ITreePathLabelProvider for the receiver.- Returns:
- Returns the treePathProvider.
-
update
public void update(ViewerCell cell)
Description copied from class:CellLabelProvider
Update the label for cell.- Parameters:
cell
-ViewerCell
-
getFont
public Font getFont(Object element)
Description copied from interface:IFontProvider
Provides a font for the given element.- Specified by:
getFont
in interfaceIFontProvider
- Overrides:
getFont
in classColumnLabelProvider
- Parameters:
element
- the element- Returns:
- the font for the element, or
null
to use the default font
-
getBackground
public Color getBackground(Object element)
Description copied from interface:IColorProvider
Provides a background color for the given element.- Specified by:
getBackground
in interfaceIColorProvider
- Overrides:
getBackground
in classColumnLabelProvider
- Parameters:
element
- the element- Returns:
- the background color for the element, or
null
to use the default background color
-
getText
public String getText(Object element)
Description copied from interface:ILabelProvider
Returns the text for the label of the given element.- Specified by:
getText
in interfaceILabelProvider
- Overrides:
getText
in classColumnLabelProvider
- 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
-
getImage
public Image getImage(Object element)
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
- Overrides:
getImage
in classColumnLabelProvider
- 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
-
getForeground
public Color getForeground(Object element)
Description copied from interface:IColorProvider
Provides a foreground color for the given element.- Specified by:
getForeground
in interfaceIColorProvider
- Overrides:
getForeground
in classColumnLabelProvider
- Parameters:
element
- the element- Returns:
- the foreground color for the element, or
null
to use the default foreground color
-
-