Package org.eclipse.ui.model
Class WorkbenchPartLabelProvider
- java.lang.Object
-
- org.eclipse.core.commands.common.EventManager
-
- org.eclipse.jface.viewers.BaseLabelProvider
-
- org.eclipse.jface.viewers.LabelProvider
-
- 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 typeIWorkbenchPart) in tree- and table-structured viewers.Clients may instantiate this class. It is not intended to be subclassed.
- Since:
- 3.0
-
-
Constructor Summary
Constructors Constructor Description WorkbenchPartLabelProvider()Creates a new label provider for workbench parts.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddispose()TheBaseLabelProviderimplementation of thisIBaseLabelProvidermethod clears its internal listener list.ImagegetColumnImage(Object element, int columnIndex)Returns the label image for the given column of the given element.StringgetColumnText(Object element, int columnIndex)Returns the label text for the given column of the given element.ImagegetImage(Object element)TheLabelProviderimplementation of thisILabelProvidermethod returnsnull.StringgetText(Object element)TheLabelProviderimplementation of thisILabelProvidermethod returns the element'stoStringstring.-
Methods inherited from class org.eclipse.jface.viewers.BaseLabelProvider
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
-
-
-
-
Method Detail
-
getImage
public Image getImage(Object element)
Description copied from class:LabelProviderTheLabelProviderimplementation of thisILabelProvidermethod returnsnull. Subclasses may override.- Specified by:
getImagein interfaceILabelProvider- Overrides:
getImagein classLabelProvider- Parameters:
element- the element for which to provide the label image- Returns:
- the image used to label the element, or
nullif there is no image for the given object
-
getText
public String getText(Object element)
Description copied from class:LabelProviderTheLabelProviderimplementation of thisILabelProvidermethod returns the element'stoStringstring. Subclasses may override.- Specified by:
getTextin interfaceILabelProvider- Overrides:
getTextin classLabelProvider- Parameters:
element- the element for which to provide the label text- Returns:
- the text string used to label the element, or
nullif there is no text label for the given object
-
getColumnImage
public Image getColumnImage(Object element, int columnIndex)
Description copied from interface:ITableLabelProviderReturns the label image for the given column of the given element.- Specified by:
getColumnImagein interfaceITableLabelProvider- Parameters:
element- the object representing the entire row, ornullindicating that no input object is set in the viewercolumnIndex- the zero-based index of the column in which the label appears- Returns:
- Image or
nullif there is no image for the given object at columnIndex - See Also:
ITableLabelProvider.getColumnImage(java.lang.Object, int)
-
getColumnText
public String getColumnText(Object element, int columnIndex)
Description copied from interface:ITableLabelProviderReturns the label text for the given column of the given element.- Specified by:
getColumnTextin interfaceITableLabelProvider- Parameters:
element- the object representing the entire row, ornullindicating that no input object is set in the viewercolumnIndex- the zero-based index of the column in which the label appears- Returns:
- String or or
nullif 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:BaseLabelProviderTheBaseLabelProviderimplementation of thisIBaseLabelProvidermethod clears its internal listener list. Subclasses may extend but should call the super implementation.- Specified by:
disposein interfaceIBaseLabelProvider- Overrides:
disposein classBaseLabelProvider
-
-