Eclipse JDT Plug-in Developer Guide (Galileo) - JavaElementLabelProvider (Eclipse JDT API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse JDT
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jdt.ui
Class JavaElementLabelProvider


java.lang.Object
  

org.eclipse.core.commands.common.EventManager
      

org.eclipse.jface.viewers.BaseLabelProvider
          

org.eclipse.jface.viewers.LabelProvider
              
org.eclipse.jdt.ui.JavaElementLabelProvider

All Implemented Interfaces:: DelegatingStyledCellLabelProvider.IStyledLabelProvider, IBaseLabelProvider, ILabelProvider

public class JavaElementLabelProvider
extends LabelProvider
implements DelegatingStyledCellLabelProvider.IStyledLabelProvider
extends LabelProvider
implements DelegatingStyledCellLabelProvider.IStyledLabelProvider

Standard label provider for Java elements. Use this class when you want to present the Java elements in a viewer.

The implementation also handles non-Java elements by forwarding the requests to the IWorkbenchAdapter of the element.

This class may be instantiated; it is not intended to be subclassed.

Since 3.4, this class also implements DelegatingStyledCellLabelProvider.IStyledLabelProvider for colored labels.

Restriction:: This class is not intended to be subclassed by clients.

Field Summary

static int SHOW_BASICS
          Constant (value 0) indicating that the label should show the basic images only.

static int SHOW_CONTAINER
          Deprecated. Use SHOW_QUALIFIED or SHOW_ROOT instead

static int SHOW_CONTAINER_QUALIFICATION
          Deprecated. Use SHOW_QUALIFIED instead

static int SHOW_DEFAULT
          Constant indicating the default label rendering.

static int SHOW_OVERLAY_ICONS
          Flag (bit mask) indicating that the label should include overlay icons for element type and modifiers.

static int SHOW_PARAMETERS
          Flag (bit mask) indicating that method label include parameter types.

static int SHOW_POST_QUALIFIED
          Flag (bit mask) indicating that compilation units, class files, types, declarations and members should be rendered qualified.The qualification is appended.

static int SHOW_POSTIFIX_QUALIFICATION
          Deprecated. SHOW_POST_QUALIFIED instead

static int SHOW_QUALIFIED
          Flag (bit mask) indicating that compilation units, class files, types, declarations and members should be rendered qualified.

static int SHOW_RETURN_TYPE
          Flag (bit mask) indicating that methods labels include the method return type (appended).

static int SHOW_ROOT
          Flag (bit mask) indicating that the label should include the name of the package fragment root (appended).

static int SHOW_SMALL_ICONS
          Flag (bit mask) indicating that the label should show the icons with no space reserved for overlays.

static int SHOW_TYPE
          Flag (bit mask) indicating that a field label should include the declared type.

static int SHOW_VARIABLE
          Flag (bit mask) indicating that the package fragment roots from class path variables should be rendered with the variable in the name

Constructor Summary

JavaElementLabelProvider ()
          Creates a new label provider with SHOW_DEFAULT flag.

JavaElementLabelProvider (int flags)
          Creates a new label provider.

Method Summary

void dispose ()


Image getImage ( Object element)


StyledString getStyledText ( Object element)
          Returns the styled text label for the given element

String getText ( Object element)


void turnOff (int flags)
          Turns off the rendering options specified in the given flags.

void turnOn (int flags)
          Turns on the rendering options specified in the given flags.

Methods inherited from class org.eclipse.jface.viewers. BaseLabelProvider

addListener, 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, isLabelProperty, removeListener

Field Detail

SHOW_RETURN_TYPE

public static final int SHOW_RETURN_TYPE

Flag (bit mask) indicating that methods labels include the method return type (appended).

See Also:: Constant Field Values

SHOW_PARAMETERS

public static final int SHOW_PARAMETERS

Flag (bit mask) indicating that method label include parameter types.

See Also:: Constant Field Values

SHOW_CONTAINER

public static final int SHOW_CONTAINER

Deprecated. Use SHOW_QUALIFIED or SHOW_ROOT instead

Flag (bit mask) indicating that the label of a member should include the container. For example, include the name of the type enclosing a field.

See Also:: Constant Field Values

SHOW_CONTAINER_QUALIFICATION

public static final int SHOW_CONTAINER_QUALIFICATION

Deprecated. Use SHOW_QUALIFIED instead

Flag (bit mask) indicating that the label of a type should be fully qualified. For example, include the fully qualified name of the type enclosing a type.

See Also:: Constant Field Values

SHOW_OVERLAY_ICONS

public static final int SHOW_OVERLAY_ICONS

Flag (bit mask) indicating that the label should include overlay icons for element type and modifiers.

See Also:: Constant Field Values

SHOW_TYPE

public static final int SHOW_TYPE

Flag (bit mask) indicating that a field label should include the declared type.

See Also:: Constant Field Values

SHOW_ROOT

public static final int SHOW_ROOT

Flag (bit mask) indicating that the label should include the name of the package fragment root (appended).

See Also:: Constant Field Values

SHOW_POSTIFIX_QUALIFICATION

public static final int SHOW_POSTIFIX_QUALIFICATION

Deprecated. SHOW_POST_QUALIFIED instead

Flag (bit mask) indicating that the label qualification of a type should be shown after the name.

See Also:: Constant Field Values

SHOW_SMALL_ICONS

public static final int SHOW_SMALL_ICONS

Flag (bit mask) indicating that the label should show the icons with no space reserved for overlays.

See Also:: Constant Field Values

SHOW_VARIABLE

public static final int SHOW_VARIABLE

Flag (bit mask) indicating that the package fragment roots from class path variables should be rendered with the variable in the name

See Also:: Constant Field Values

SHOW_QUALIFIED

public static final int SHOW_QUALIFIED

Flag (bit mask) indicating that compilation units, class files, types, declarations and members should be rendered qualified. Examples: java.lang.String, java.util.Vector.size()

Since:: 2.0
See Also:: Constant Field Values

SHOW_POST_QUALIFIED

public static final int SHOW_POST_QUALIFIED

Flag (bit mask) indicating that compilation units, class files, types, declarations and members should be rendered qualified.The qualification is appended. Examples: String - java.lang, size() - java.util.Vector

Since:: 2.0
See Also:: Constant Field Values

SHOW_BASICS

public static final int SHOW_BASICS

Constant (value 0) indicating that the label should show the basic images only.

See Also:: Constant Field Values

SHOW_DEFAULT

public static final int SHOW_DEFAULT

Constant indicating the default label rendering. Currently the default is equivalent to SHOW_PARAMETERS | SHOW_OVERLAY_ICONS.

Constructor Detail

JavaElementLabelProvider

public JavaElementLabelProvider()

Creates a new label provider with SHOW_DEFAULT flag.

Since:: 2.0
See Also:: SHOW_DEFAULT

JavaElementLabelProvider

public JavaElementLabelProvider(int flags)

Creates a new label provider.

Parameters:: flags - the initial options; a bitwise OR of SHOW_* constants

Method Detail

turnOn

public void turnOn(int flags)

Turns on the rendering options specified in the given flags.

Parameters:: flags - the options; a bitwise OR of SHOW_* constants

turnOff

public void turnOff(int flags)

Turns off the rendering options specified in the given flags.

Parameters:: flags - the initial options; a bitwise OR of SHOW_* constants

getImage

public 
Image getImage(
Object element)

Specified by:: getImage in interface DelegatingStyledCellLabelProvider.IStyledLabelProvider
Specified by:: getImage in interface ILabelProvider
Overrides:: getImage in class LabelProvider

getText

public 
String getText(
Object element)

Specified by:: getText in interface ILabelProvider
Overrides:: getText in class LabelProvider

getStyledText

public 
StyledString getStyledText(
Object element)

Returns the styled text label for the given element

Specified by:: getStyledText in interface DelegatingStyledCellLabelProvider.IStyledLabelProvider

Parameters:: element - the element to evaluate the styled string for
Returns:: the styled string.
Since:: 3.4

dispose

public void dispose()

Specified by:: dispose in interface IBaseLabelProvider
Overrides:: dispose in class BaseLabelProvider

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse JDT
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jdt.ui Class JavaElementLabelProvider

SHOW_RETURN_TYPE

SHOW_PARAMETERS

SHOW_CONTAINER

SHOW_CONTAINER_QUALIFICATION

SHOW_OVERLAY_ICONS

SHOW_TYPE

SHOW_ROOT

SHOW_POSTIFIX_QUALIFICATION

SHOW_SMALL_ICONS

SHOW_VARIABLE

SHOW_QUALIFIED

SHOW_POST_QUALIFIED

SHOW_BASICS

SHOW_DEFAULT

JavaElementLabelProvider

JavaElementLabelProvider

turnOn

turnOff

getImage

getText

getStyledText

dispose

org.eclipse.jdt.ui
Class JavaElementLabelProvider