Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.jface.viewers
Class TreeColumnViewerLabelProvider

java.lang.Object
  extended by 

org.eclipse.core.commands.common.EventManager
      extended by 

org.eclipse.jface.viewers.BaseLabelProvider
          extended by 

org.eclipse.jface.viewers.CellLabelProvider
              extended by 

org.eclipse.jface.viewers.ColumnLabelProvider
                  extended by 
org.eclipse.jface.viewers.TreeColumnViewerLabelProvider
All Implemented Interfaces:
IBaseLabelProvider, IColorProvider, IFontProvider, ILabelProvider

public class TreeColumnViewerLabelProvider
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)
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

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire