Package org.eclipse.jface.databinding.viewers

Class ObservableMapCellLabelProvider

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.jface.viewers.BaseLabelProvider

org.eclipse.jface.viewers.CellLabelProvider

org.eclipse.jface.databinding.viewers.ObservableMapCellLabelProvider

All Implemented Interfaces:

IBaseLabelProvider, IToolTipProvider

public class ObservableMapCellLabelProvider
extends CellLabelProvider

A label provider based on one or more observable maps that track attributes that this label provider uses for display. The default behavior is to display the first attribute's value. Clients may customize by subclassing and overriding update(ViewerCell).

Since:

1.3

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

Modifier	Constructor	Description
	ObservableMapCellLabelProvider(IObservableMap<?,?> attributeMap)	Creates a new label provider that tracks changes to one attribute.
protected	ObservableMapCellLabelProvider(IObservableMap<?,?>[] attributeMaps)	Creates a new label provider that tracks changes to more than one attribute.

Method Summary

Modifier and Type	Method	Description
void	dispose()	The BaseLabelProvider implementation of this IBaseLabelProvider method clears its internal listener list.
void	update(ViewerCell cell)	Updates the label of the cell with the value for the cell element.

Methods inherited from class org.eclipse.jface.viewers.CellLabelProvider

dispose, getToolTipBackgroundColor, getToolTipDisplayDelayTime, getToolTipFont, getToolTipForegroundColor, getToolTipImage, getToolTipShift, getToolTipStyle, getToolTipText, getToolTipTimeDisplayed, initialize, useNativeToolTip

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

Field Details

attributeMaps

protected IObservableMap<Object,Object>[] attributeMaps

Observable maps typically mapping from viewer elements to label values. Subclasses may use these maps to provide custom labels.

Since:

1.4

Constructor Details

ObservableMapCellLabelProvider

public ObservableMapCellLabelProvider(IObservableMap<?,?> attributeMap)

Creates a new label provider that tracks changes to one attribute.

Parameters:

attributeMap - attribute map to track

ObservableMapCellLabelProvider

protected ObservableMapCellLabelProvider(IObservableMap<?,?>[] attributeMaps)

Creates a new label provider that tracks changes to more than one attribute. This constructor should be used by subclasses that override update(ViewerCell) and make use of more than one attribute.

Parameters:

attributeMaps - attribute maps to track

Method Details

dispose

public void dispose()

Description copied from class: BaseLabelProvider

The BaseLabelProvider implementation of this IBaseLabelProvider method clears its internal listener list. Subclasses may extend but should call the super implementation.

Specified by:

dispose in interface IBaseLabelProvider

Overrides:

dispose in class BaseLabelProvider

update

public void update(ViewerCell cell)

Updates the label of the cell with the value for the cell element. Note: The value for the first map is always used, for all columns.

Specified by:

update in class CellLabelProvider

Parameters:

cell - The cell to be updated.