Eclipse Platform
Release 3.1

org.eclipse.jface.viewers
Interface ITableLabelProvider

All Superinterfaces:
IBaseLabelProvider
All Known Implementing Classes:
EnvironmentTab.EnvironmentVariableLabelProvider, FileEditorMappingLabelProvider, PerspectiveLabelProvider, WorkbenchPartLabelProvider

public interface ITableLabelProvider
extends IBaseLabelProvider

Extends IBaseLabelProvider with the methods to provide the text and/or image for each column of a given element. Used by table viewers.

See Also:
TableViewer

Method Summary
 Image getColumnImage(Object element, int columnIndex)
          Returns the label image for the given column of the given element.
 String getColumnText(Object element, int columnIndex)
          Returns the label text for the given column of the given element.
 
Methods inherited from interface org.eclipse.jface.viewers.IBaseLabelProvider
addListener, dispose, isLabelProperty, removeListener
 

Method Detail

getColumnImage

public Image getColumnImage(Object element,
                            int columnIndex)
Returns the label image for the given column of the given element.

Parameters:
element - the object representing the entire row, or null indicating that no input object is set in the viewer
columnIndex - the zero-based index of the column in which the label appears
Returns:
Image or null if there is no image for the given object at columnIndex

getColumnText

public String getColumnText(Object element,
                            int columnIndex)
Returns the label text for the given column of the given element.

Parameters:
element - the object representing the entire row, or null indicating that no input object is set in the viewer
columnIndex - the zero-based index of the column in which the label appears
Returns:
String or or null if there is no text for the given object at columnIndex

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.