Package org.eclipse.ui.model

Class PerspectiveLabelProvider

java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.jface.viewers.BaseLabelProvider
org.eclipse.jface.viewers.LabelProvider
org.eclipse.ui.model.PerspectiveLabelProvider
All Implemented Interfaces:
IBaseLabelProvider, ILabelProvider, ITableLabelProvider
public final class PerspectiveLabelProvider extends LabelProvider implements ITableLabelProvider
A table label provider implementation for showing workbench perspectives (objects of type IPerspectiveDescriptor) in table- and tree-structured viewers.

Clients may instantiate this class. It is not intended to be subclassed.

Since:
3.0

  • Constructor Details

    • PerspectiveLabelProvider

      public PerspectiveLabelProvider()
      Creates a new label provider for perspectives. The default perspective is visually marked.

    • PerspectiveLabelProvider

      public PerspectiveLabelProvider(boolean markDefault)
      Creates a new label provider for perspectives.
      Parameters:
      markDefault - true if the default perspective is to be visually marked, and false if the default perspective is not treated as anything special

  • Method Details

    • getImage

      public Image getImage(Object element)
      Description copied from class: LabelProvider
      The LabelProvider implementation of this ILabelProvider method returns null. Subclasses may override.
      Specified by:
      getImage in interface ILabelProvider
      Overrides:
      getImage in class 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

    • dispose

      public void dispose()
      Description copied from class: BaseLabelProvider
      The BaseLabelProvider implementation of this IBaseLabelProvider method clears its internal listener list. Subclasses may extend but should call the super implementation.
      Specified by:
      dispose in interface IBaseLabelProvider
      Overrides:
      dispose in class BaseLabelProvider

    • getText

      public String getText(Object element)
      Description copied from class: LabelProvider
      The LabelProvider implementation of this ILabelProvider method returns the element's toString string. Subclasses may override.
      Specified by:
      getText in interface ILabelProvider
      Overrides:
      getText in class 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

    • getColumnImage

      public Image getColumnImage(Object element, int columnIndex)
      Description copied from interface: ITableLabelProvider
      Returns the label image for the given column of the given element.
      Specified by:
      getColumnImage in interface ITableLabelProvider
      Parameters:
      element - the object representing the entire row, or null indicating that no input object is set in the viewer
      columnIndex - the zero-based index of the column in which the label appears
      Returns:
      Image or null if there is no image for the given object at columnIndex
      See Also:

    • getColumnText

      public String getColumnText(Object element, int columnIndex)
      Description copied from interface: ITableLabelProvider
      Returns the label text for the given column of the given element.
      Specified by:
      getColumnText in interface ITableLabelProvider
      Parameters:
      element - the object representing the entire row, or null indicating that no input object is set in the viewer
      columnIndex - the zero-based index of the column in which the label appears
      Returns:
      String or or null if there is no text for the given object at columnIndex
      See Also: