Eclipse Platform
Release 3.3

org.eclipse.jface.viewers
Class LabelProvider

java.lang.Object
  extended byorg.eclipse.core.commands.common.EventManager
      extended byorg.eclipse.jface.viewers.BaseLabelProvider
          extended byorg.eclipse.jface.viewers.LabelProvider
All Implemented Interfaces:
IBaseLabelProvider, ILabelProvider
Direct Known Subclasses:
ComboBoxLabelProvider, DecoratingLabelProvider, EnvironmentTab.EnvironmentVariableLabelProvider, FileEditorMappingLabelProvider, NamedHandleObjectLabelProvider, ObservableMapLabelProvider, PerspectiveLabelProvider, PreferenceLabelProvider, RefactoringHistoryLabelProvider, WorkbenchLabelProvider, WorkbenchPartLabelProvider

public class LabelProvider
extends BaseLabelProvider
implements ILabelProvider

A label provider implementation which, by default, uses an element's toString value for its text and null for its image.

This class may be used as is, or subclassed to provide richer labels. Subclasses may override any of the following methods:


Constructor Summary
LabelProvider()
          Creates a new label provider.
 
Method Summary
 Image getImage(Object element)
          The LabelProvider implementation of this ILabelProvider method returns null.
 String getText(Object element)
          The LabelProvider implementation of this ILabelProvider method returns the element's toString string.
 
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

LabelProvider

public LabelProvider()
Creates a new label provider.

Method Detail

getImage

public Image getImage(Object element)
The LabelProvider implementation of this ILabelProvider method returns null. Subclasses may override.

Specified by:
getImage in interface ILabelProvider
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 String getText(Object element)
The LabelProvider implementation of this ILabelProvider method returns the element's toString string. Subclasses may override.

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

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

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