org.eclipse.xtext.ui.label

Class DeclarativeLabelProvider

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.jface.viewers.BaseLabelProvider

org.eclipse.jface.viewers.LabelProvider

org.eclipse.xtext.ui.label.AbstractLabelProvider

org.eclipse.xtext.ui.label.DeclarativeLabelProvider

All Implemented Interfaces:

org.eclipse.emf.edit.provider.IItemLabelProvider, org.eclipse.jface.viewers.DelegatingStyledCellLabelProvider.IStyledLabelProvider, org.eclipse.jface.viewers.IBaseLabelProvider, org.eclipse.jface.viewers.ILabelProvider, ILabelProviderImageDescriptorExtension

Direct Known Subclasses:

DefaultDescriptionLabelProvider, DefaultEditorInputLabelProvider, DefaultEObjectLabelProvider

public class DeclarativeLabelProvider
extends AbstractLabelProvider

A label provider that dispatches to typed Object image() and Object text() methods.

Author:

Jan Koehnlein - Initial contribution and API

Constructor Summary

Constructors

Constructor and Description
DeclarativeLabelProvider()
DeclarativeLabelProvider(org.eclipse.jface.viewers.ILabelProvider delegate)

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	doGetImage(Object element) Expected to be overridden by clients.
protected Object	doGetText(Object element) Expected to be overridden by clients.
protected Object	handleImageError(Object[] params, Throwable e)
protected Object	handleTextError(Object[] params, Throwable e)
Object	image(Object element)
Object	image(Void element)
Object	text(Object element)
Object	text(Void element)

Methods inherited from class org.eclipse.xtext.ui.label.AbstractLabelProvider

convertToImage, convertToImageDescriptor, convertToString, convertToStyledString, getDefaultImage, getDefaultStyledText, getDefaultText, getImage, getImageDescriptor, getStyledText, getText, setImageHelper

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

DeclarativeLabelProvider

public DeclarativeLabelProvider()

DeclarativeLabelProvider

public DeclarativeLabelProvider(org.eclipse.jface.viewers.ILabelProvider delegate)

Method Detail

doGetText

protected Object doGetText(Object element)

Description copied from class: AbstractLabelProvider

Expected to be overridden by clients.

Overrides:

doGetText in class AbstractLabelProvider

Returns:

a StyledString or a a String.

doGetImage

protected Object doGetImage(Object element)

Description copied from class: AbstractLabelProvider

Expected to be overridden by clients.

Overrides:

doGetImage in class AbstractLabelProvider

Returns:

a String, an ImageDescriptor or an Image passed to AbstractLabelProvider.convertToImage(Object) to determine the actual Image.

image

public Object image(Object element)

text

public Object text(Object element)

image

public Object image(Void element)

text

public Object text(Void element)

handleTextError

protected Object handleTextError(Object[] params,
                     Throwable e)

handleImageError

protected Object handleImageError(Object[] params,
                      Throwable e)