org.eclipse.xtext.ui.label
Class AbstractLabelProvider

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

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

Direct Known Subclasses:

DeclarativeLabelProvider, OutlineNodeLabelProvider.Delegate

public abstract class AbstractLabelProvider
extends org.eclipse.jface.viewers.LabelProvider
implements org.eclipse.jface.viewers.DelegatingStyledCellLabelProvider.IStyledLabelProvider, org.eclipse.emf.edit.provider.IItemLabelProvider

A label provider that implements ILabelProvider as well as DelegatingStyledCellLabelProvider.IStyledLabelProvider with an optional delegate.

Author:

Jan Koehnlein - Initial contribution and API

Constructor Summary

protected	AbstractLabelProvider()
protected	AbstractLabelProvider(org.eclipse.jface.viewers.ILabelProvider delegate)

Method Summary

protected org.eclipse.swt.graphics.Image	convertToImage(java.lang.Object imageDescription)
protected java.lang.String	convertToString(java.lang.Object text)
protected org.eclipse.jface.viewers.StyledString	convertToStyledString(java.lang.Object text)
protected java.lang.Object	doGetImage(java.lang.Object element) Expected to be overridden by clients.
protected java.lang.Object	doGetText(java.lang.Object element) Expected to be overridden by clients.
protected java.lang.Object	getDefaultImage()
protected org.eclipse.jface.viewers.StyledString	getDefaultStyledText()
protected java.lang.String	getDefaultText()
org.eclipse.swt.graphics.Image	getImage(java.lang.Object element) Subclasses should rather override doGetImage(java.lang.Object).
org.eclipse.jface.viewers.StyledString	getStyledText(java.lang.Object element) Subclasses should rather override doGetText(java.lang.Object).
java.lang.String	getText(java.lang.Object element) The LabelProvider implementation of this ILabelProvider method returns the element's toString string.
protected void	setImageHelper(IImageHelper imageHelper)

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

AbstractLabelProvider

protected AbstractLabelProvider()

AbstractLabelProvider

protected AbstractLabelProvider(org.eclipse.jface.viewers.ILabelProvider delegate)

Method Detail

getImage

public org.eclipse.swt.graphics.Image getImage(java.lang.Object element)

Subclasses should rather override doGetImage(java.lang.Object).

Specified by:

getImage in interface org.eclipse.emf.edit.provider.IItemLabelProvider

Specified by:

getImage in interface org.eclipse.jface.viewers.DelegatingStyledCellLabelProvider.IStyledLabelProvider

Specified by:

getImage in interface org.eclipse.jface.viewers.ILabelProvider

Overrides:

getImage in class org.eclipse.jface.viewers.LabelProvider

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

convertToImage

protected org.eclipse.swt.graphics.Image convertToImage(java.lang.Object imageDescription)

Parameters:

imageDescription - a String, an ImageDescriptor or an Image

Returns:

the Image associated with the description or null

doGetImage

protected java.lang.Object doGetImage(java.lang.Object element)

Expected to be overridden by clients.

Returns:

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

getDefaultImage

protected java.lang.Object getDefaultImage()

getStyledText

public org.eclipse.jface.viewers.StyledString getStyledText(java.lang.Object element)

Subclasses should rather override doGetText(java.lang.Object).

Specified by:

getStyledText in interface org.eclipse.jface.viewers.DelegatingStyledCellLabelProvider.IStyledLabelProvider

Parameters:

element - the element to evaluate the styled string for

Returns:

the styled string.

convertToStyledString

protected org.eclipse.jface.viewers.StyledString convertToStyledString(java.lang.Object text)

Parameters:

text - a StyledString or a a String

Returns:

a StyledString representing the parameter or null.

getText

public java.lang.String getText(java.lang.Object element)

Description copied from class: org.eclipse.jface.viewers.LabelProvider

The LabelProvider implementation of this ILabelProvider method returns the element's toString string. Subclasses may override.

Specified by:

getText in interface org.eclipse.emf.edit.provider.IItemLabelProvider

Specified by:

getText in interface org.eclipse.jface.viewers.ILabelProvider

Overrides:

getText in class org.eclipse.jface.viewers.LabelProvider

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

convertToString

protected java.lang.String convertToString(java.lang.Object text)

Parameters:

text - a StyledString or a a String

Returns:

a String representing the parameter or null.

doGetText

protected java.lang.Object doGetText(java.lang.Object element)

Expected to be overridden by clients.

Returns:

a StyledString or a a String.

getDefaultStyledText

protected org.eclipse.jface.viewers.StyledString getDefaultStyledText()

getDefaultText

protected java.lang.String getDefaultText()

setImageHelper

protected void setImageHelper(IImageHelper imageHelper)