|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.jface.viewers.BaseLabelProvider
org.eclipse.jface.viewers.LabelProvider
org.eclipse.jface.databinding.viewers.ObservableMapLabelProvider
public class ObservableMapLabelProvider
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 overriding getColumnText(Object, int),
getColumnImage(Object, int), for tables or trees with columns, or by
implementing additional mixin interfaces for colors, fonts etc.
| Field Summary | |
|---|---|
protected IObservableMap[] |
attributeMaps
Observable maps typically mapping from viewer elements to label values. |
| Constructor Summary | |
|---|---|
ObservableMapLabelProvider(IObservableMap attributeMap)
|
|
ObservableMapLabelProvider(IObservableMap[] attributeMaps)
|
|
| Method Summary | |
|---|---|
void |
dispose()
The BaseLabelProvider implementation of this
IBaseLabelProvider method clears its internal listener list. |
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.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 |
| Methods inherited from interface org.eclipse.jface.viewers.IBaseLabelProvider |
|---|
addListener, isLabelProperty, removeListener |
| Field Detail |
|---|
protected IObservableMap[] attributeMaps
| Constructor Detail |
|---|
public ObservableMapLabelProvider(IObservableMap attributeMap)
attributeMap - public ObservableMapLabelProvider(IObservableMap[] attributeMaps)
attributeMaps - | Method Detail |
|---|
public void dispose()
BaseLabelProviderBaseLabelProvider implementation of this
IBaseLabelProvider method clears its internal listener list.
Subclasses may extend but should call the super implementation.
dispose in interface IBaseLabelProviderdispose in class BaseLabelProviderpublic Image getImage(java.lang.Object element)
LabelProviderLabelProvider implementation of this
ILabelProvider method returns null.
Subclasses may override.
getImage in interface ILabelProvidergetImage in class LabelProviderelement - the element for which to provide the label image
null
if there is no image for the given objectpublic java.lang.String getText(java.lang.Object element)
LabelProviderLabelProvider implementation of this
ILabelProvider method returns the element's
toString string. Subclasses may override.
getText in interface ILabelProvidergetText in class LabelProviderelement - the element for which to provide the label text
null
if there is no text label for the given object
public Image getColumnImage(java.lang.Object element,
int columnIndex)
ITableLabelProvider
getColumnImage in interface ITableLabelProviderelement - the object representing the entire row, or
null indicating that no input object is set
in the viewercolumnIndex - the zero-based index of the column in which
the label appears
null if there is no image for the
given object at columnIndex
public java.lang.String getColumnText(java.lang.Object element,
int columnIndex)
ITableLabelProvider
getColumnText in interface ITableLabelProviderelement - the object representing the entire row, or
null indicating that no input object is set
in the viewercolumnIndex - the zero-based index of the column in which the label appears
null if there is no text for the
given object at columnIndex
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.