Class ObservableMapLabelProvider
- java.lang.Object
-
- org.eclipse.core.commands.common.EventManager
-
- org.eclipse.jface.viewers.BaseLabelProvider
-
- org.eclipse.jface.viewers.LabelProvider
-
- org.eclipse.jface.databinding.viewers.ObservableMapLabelProvider
-
- All Implemented Interfaces:
IBaseLabelProvider
,ILabelProvider
,ITableLabelProvider
public class ObservableMapLabelProvider extends LabelProvider implements ITableLabelProvider
A label provider based on one or more observable maps that track attributes that this label provider uses for display. Clients may customize by subclassing and overridinggetColumnText(Object, int)
,getColumnImage(Object, int)
, for tables or trees with columns, or by implementing additional mixin interfaces for colors, fonts etc.- Since:
- 1.1
-
-
Field Summary
Fields Modifier and Type Field Description protected IObservableMap<Object,Object>[]
attributeMaps
Observable maps typically mapping from viewer elements to label values.
-
Constructor Summary
Constructors Constructor Description ObservableMapLabelProvider(IObservableMap<?,?> attributeMap)
ObservableMapLabelProvider(IObservableMap<?,?>[] attributeMaps)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
dispose()
TheBaseLabelProvider
implementation of thisIBaseLabelProvider
method clears its internal listener list.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.Image
getImage(Object element)
TheLabelProvider
implementation of thisILabelProvider
method returnsnull
.String
getText(Object element)
TheLabelProvider
implementation of thisILabelProvider
method returns the element'stoString
string.-
Methods inherited from class org.eclipse.jface.viewers.LabelProvider
createImageProvider, createTextImageProvider, createTextProvider
-
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
-
-
-
-
Field Detail
-
attributeMaps
protected IObservableMap<Object,Object>[] attributeMaps
Observable maps typically mapping from viewer elements to label values. Subclasses may reference these maps to provide custom labels.- Since:
- 1.4
-
-
Constructor Detail
-
ObservableMapLabelProvider
public ObservableMapLabelProvider(IObservableMap<?,?> attributeMap)
- Parameters:
attributeMap
- the tracked attribute map
-
ObservableMapLabelProvider
public ObservableMapLabelProvider(IObservableMap<?,?>[] attributeMaps)
- Parameters:
attributeMaps
- the tracked attribute maps
-
-
Method Detail
-
dispose
public void dispose()
Description copied from class:BaseLabelProvider
TheBaseLabelProvider
implementation of thisIBaseLabelProvider
method clears its internal listener list. Subclasses may extend but should call the super implementation.- Specified by:
dispose
in interfaceIBaseLabelProvider
- Overrides:
dispose
in classBaseLabelProvider
-
getImage
public Image getImage(Object element)
Description copied from class:LabelProvider
TheLabelProvider
implementation of thisILabelProvider
method returnsnull
. Subclasses may override.- Specified by:
getImage
in interfaceILabelProvider
- Overrides:
getImage
in classLabelProvider
- 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)
Description copied from class:LabelProvider
TheLabelProvider
implementation of thisILabelProvider
method returns the element'stoString
string. Subclasses may override.- Specified by:
getText
in interfaceILabelProvider
- Overrides:
getText
in classLabelProvider
- 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 Image getColumnImage(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 interfaceITableLabelProvider
- Parameters:
element
- the object representing the entire row, ornull
indicating that no input object is set in the viewercolumnIndex
- 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)
Description copied from interface:ITableLabelProvider
Returns the label text for the given column of the given element.- Specified by:
getColumnText
in interfaceITableLabelProvider
- Parameters:
element
- the object representing the entire row, ornull
indicating 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
null
if there is no text for the given object at columnIndex
-
-