Eclipse Plug-in Developer Guide (Galileo) - TreeColumnViewerLabelProvider (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

public class TreeColumnViewerLabelProvider
extends ColumnLabelProvider
extends ColumnLabelProvider

TreeViewerLabelProvider is the ViewerLabelProvider that handles TreePaths.

Since:: 3.3

Constructor Summary

TreeColumnViewerLabelProvider ( IBaseLabelProvider labelProvider)
          Create a new instance of the receiver with the supplied labelProvider.

Method Summary

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. 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 -

Method Detail

updateLabel

public void updateLabel(
ViewerLabel label,
                        
TreePath elementPath)

Update the label for the element with TreePath.

Parameters:: label -; elementPath -

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 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)