Eclipse Platform
Release 3.2

org.eclipse.ui.model
Class WorkbenchPartLabelProvider

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.jface.viewers.LabelProvider
          extended by org.eclipse.ui.model.WorkbenchPartLabelProvider
All Implemented Interfaces:
IBaseLabelProvider, ILabelProvider, ITableLabelProvider

public final class WorkbenchPartLabelProvider
extends LabelProvider
implements ITableLabelProvider

A table label provider implementation for showing workbench views and editors (objects of type IWorkbenchPart) in tree- and table-structured viewers.

Clients may instantiate this class. It is not intended to be subclassed.

Since:
3.0

Constructor Summary
WorkbenchPartLabelProvider()
          Creates a new label provider for workbench parts.
 
Method Summary
 void dispose()
          The LabelProvider implementation of this IBaseLabelProvider method does nothing.
 Image getColumnImage(java.lang.Object element, int columnIndex)
          Returns the label image for the given column of the given element.
 java.lang.String getColumnText(java.lang.Object element, int columnIndex)
          Returns the label text for the given column of the given element.
 Image getImage(java.lang.Object element)
          The LabelProvider implementation of this ILabelProvider method returns null.
 java.lang.String getText(java.lang.Object element)
          The LabelProvider implementation of this ILabelProvider method returns the element's toString string.
 
Methods inherited from class org.eclipse.jface.viewers.LabelProvider
addListener, 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, isLabelProperty, removeListener
 

Constructor Detail

WorkbenchPartLabelProvider

public WorkbenchPartLabelProvider()
Creates a new label provider for workbench parts.

Method Detail

getImage

public final Image getImage(java.lang.Object element)
Description copied from class: LabelProvider
The LabelProvider implementation of this ILabelProvider method returns null. Subclasses may override.

Specified by:
getImage in interface ILabelProvider
Overrides:
getImage in class LabelProvider
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

getText

public final java.lang.String getText(java.lang.Object element)
Description copied from class: LabelProvider
The LabelProvider implementation of this ILabelProvider method returns the element's toString string. Subclasses may override.

Specified by:
getText in interface ILabelProvider
Overrides:
getText in class LabelProvider
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

getColumnImage

public final Image getColumnImage(java.lang.Object element,
                                  int columnIndex)
Description copied from interface: ITableLabelProvider
Returns the label image for the given column of the given element.

Specified by:
getColumnImage in interface ITableLabelProvider
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
See Also:
ITableLabelProvider.getColumnImage(java.lang.Object, int)

getColumnText

public final java.lang.String getColumnText(java.lang.Object element,
                                            int columnIndex)
Description copied from interface: ITableLabelProvider
Returns the label text for the given column of the given element.

Specified by:
getColumnText in interface ITableLabelProvider
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
See Also:
ITableLabelProvider.getColumnText(java.lang.Object, int)

dispose

public void dispose()
Description copied from class: LabelProvider
The LabelProvider implementation of this IBaseLabelProvider method does nothing. Subclasses may extend.

Specified by:
dispose in interface IBaseLabelProvider
Overrides:
dispose in class LabelProvider

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

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