org.eclipse.xtext.ui.label
Class GlobalDescriptionLabelProvider

java.lang.Object
  org.eclipse.core.commands.common.EventManager
      org.eclipse.jface.viewers.BaseLabelProvider
          org.eclipse.xtext.ui.label.GlobalDescriptionLabelProvider

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

public class GlobalDescriptionLabelProvider
extends org.eclipse.jface.viewers.BaseLabelProvider
implements org.eclipse.jface.viewers.ILabelProvider, org.eclipse.emf.edit.provider.IItemLabelProvider, org.eclipse.jface.viewers.DelegatingStyledCellLabelProvider.IStyledLabelProvider

Delegates to the IDescriptionLabelProvider looked up in the IResourceServiceProvider.Registry

Author:

Jan Koehnlein - Initial contribution and API

Constructor Summary

GlobalDescriptionLabelProvider()

Method Summary

org.eclipse.swt.graphics.Image	getImage(java.lang.Object element) Returns the image for the label of the given element.
org.eclipse.jface.viewers.StyledString	getStyledText(java.lang.Object element) Returns the styled text label for the given element
java.lang.String	getText(java.lang.Object element) Returns the text for the label of the given element.

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

GlobalDescriptionLabelProvider

public GlobalDescriptionLabelProvider()

Method Detail

getImage

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

Description copied from interface: org.eclipse.jface.viewers.ILabelProvider

Returns the image for the label of the given element. The image is owned by the label provider and must not be disposed directly. Instead, dispose the label provider when no longer needed.

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

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

getText

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

Description copied from interface: org.eclipse.jface.viewers.ILabelProvider

Returns the text for the label of the given element.

Specified by:

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

Specified by:

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

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

getStyledText

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

Description copied from interface: org.eclipse.jface.viewers.DelegatingStyledCellLabelProvider.IStyledLabelProvider

Returns the styled text label for the given element

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.