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.TableColumnViewerLabelProvider
org.eclipse.jface.viewers.TreeColumnViewerLabelProvider
All Implemented Interfaces:
IBaseLabelProvider, IColorProvider, IFontProvider, ILabelProvider, IToolTipProvider
public class TreeColumnViewerLabelProvider extends TableColumnViewerLabelProvider
TreeViewerLabelProvider is the ViewerLabelProvider that handles TreePaths.
Since:
3.3

  • Constructor Details

    • TreeColumnViewerLabelProvider

      public TreeColumnViewerLabelProvider(IBaseLabelProvider labelProvider)
      Create a new instance of the receiver with the supplied labelProvider.
      Parameters:
      labelProvider - the label provider

  • Method Details

    • updateLabel

      public void updateLabel(ViewerLabel label, TreePath elementPath)
      Update the label for the element with TreePath.
      Parameters:
      label - the label to update
      elementPath - 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.

    • getFont

      public Font getFont(Object element)
      Description copied from interface: IFontProvider
      Provides a font for the given element.
      Specified by:
      getFont in interface IFontProvider
      Overrides:
      getFont in class ColumnLabelProvider
      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 interface IColorProvider
      Overrides:
      getBackground in class ColumnLabelProvider
      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 interface ILabelProvider
      Overrides:
      getText in class ColumnLabelProvider
      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 interface ILabelProvider
      Overrides:
      getImage in class ColumnLabelProvider
      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 interface IColorProvider
      Overrides:
      getForeground in class ColumnLabelProvider
      Parameters:
      element - the element
      Returns:
      the foreground color for the element, or null to use the default foreground color