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, ILabelProviderImageDescriptorExtension

Direct Known Subclasses:

DeclarativeLabelProvider, OutlineNodeLabelProvider.Delegate, OutlinePage.BusyLabelProvider

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

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

Author:

Jan Koehnlein - Initial contribution and API

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLabelProvider()
protected	AbstractLabelProvider(org.eclipse.jface.viewers.ILabelProvider delegate)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.eclipse.swt.graphics.Image	convertToImage(Object imageDescription)
protected org.eclipse.jface.resource.ImageDescriptor	convertToImageDescriptor(Object imageDescription)
protected String	convertToString(Object text)
protected org.eclipse.jface.viewers.StyledString	convertToStyledString(Object text)
protected Object	doGetImage(Object element) Expected to be overridden by clients.
protected Object	doGetText(Object element) Expected to be overridden by clients.
protected Object	getDefaultImage()
protected org.eclipse.jface.viewers.StyledString	getDefaultStyledText()
protected String	getDefaultText()
org.eclipse.swt.graphics.Image	getImage(Object element) Subclasses should rather override doGetImage(java.lang.Object).
org.eclipse.jface.resource.ImageDescriptor	getImageDescriptor(Object element)
org.eclipse.jface.viewers.StyledString	getStyledText(Object element) Subclasses should rather override doGetText(java.lang.Object).
String	getText(Object element)
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(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

getImageDescriptor

public org.eclipse.jface.resource.ImageDescriptor getImageDescriptor(Object element)

Specified by:

getImageDescriptor in interface ILabelProviderImageDescriptorExtension

Returns:

the image descriptor for the given element or null.

Since:

2.4

convertToImageDescriptor

protected org.eclipse.jface.resource.ImageDescriptor convertToImageDescriptor(Object imageDescription)

Since:

2.4

convertToImage

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

Parameters:

imageDescription - a String, an ImageDescriptor or an Image

Returns:

the Image associated with the description or null

doGetImage

protected Object doGetImage(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 Object getDefaultImage()

getStyledText

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

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

Specified by:

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

convertToStyledString

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

Parameters:

text - a StyledString or a a String

Returns:

a StyledString representing the parameter or null.

getText

public String getText(Object element)

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

convertToString

protected String convertToString(Object text)

Parameters:

text - a StyledString or a a String

Returns:

a String representing the parameter or null.

doGetText

protected Object doGetText(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 String getDefaultText()

setImageHelper

protected void setImageHelper(IImageHelper imageHelper)