oracle.ide.model

Interface LabelProvider<T>

Type Parameters:

T - the type of object for which this provider can supply labels

All Known Implementing Classes:

AuditTaskMarkerLabelProvider

public interface LabelProvider<T>

The LabelProvider interface defines the contract for an object tha can provide a label (String) for a given object and key.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LabelProvider.Key The LabelProvider.Key enumerated type is for convenience when working with common label provider keys.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LONG_LABEL Long label (description) key.
static java.lang.String	SHORT_LABEL Short label (name) key.
static java.lang.String	TO_STRING Used to get a relatively comprehensive string representation/description of the object.
static java.lang.String	TOOLTIP Tooltip key.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	labelFor(T obj, java.lang.String key) Get the label for the given object and the given key.

Field Detail

SHORT_LABEL

static final java.lang.String SHORT_LABEL

Short label (name) key.

LONG_LABEL

static final java.lang.String LONG_LABEL

Long label (description) key.

TOOLTIP

static final java.lang.String TOOLTIP

Tooltip key.

TO_STRING

static final java.lang.String TO_STRING

Used to get a relatively comprehensive string representation/description of the object.

Method Detail

labelFor

java.lang.String labelFor(T obj,
                        java.lang.String key)

Get the label for the given object and the given key. This method should NOT return a null value, it should return an empty (0 length) string instead.

Parameters:

obj - the object

key - the key

Returns:

the label for the given object and the given key