javax.ide.view

Interface Viewable

All Known Implementing Classes:

DefaultViewable, Editor, IDEAction, LogPage, TextEditor, View

public interface Viewable

Viewables are objects that map directly to visible GUI elements that users can select.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_ICON_PATH Identifies the bound property 'iconPath'.
static java.lang.String	PROP_LABEL Identifies the bound property 'label'.
static java.lang.String	PROP_VISIBLE Identifies the bound property 'visible'.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add a PropertyChangeListener to the listener list.
IconDescription	getIcon() Gets a relative path to the icon.
java.lang.String	getLabel() Returns a short label that can be displayed to the user.
java.lang.String	getToolTip() Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Viewable.
boolean	isVisible() Get the object visible state.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a PropertyChangeListener from the listener list.
java.lang.String	toString() Returns the label.

Field Detail

PROP_LABEL

static final java.lang.String PROP_LABEL

Identifies the bound property 'label'.

See Also:

Constant Field Values

PROP_ICON_PATH

static final java.lang.String PROP_ICON_PATH

Identifies the bound property 'iconPath'.

See Also:

Constant Field Values

PROP_VISIBLE

static final java.lang.String PROP_VISIBLE

Identifies the bound property 'visible'.

See Also:

Constant Field Values

Method Detail

isVisible

boolean isVisible()

Get the object visible state.

Returns:

The command visible state.

getLabel

java.lang.String getLabel()

Returns a short label that can be displayed to the user. Generally, the value of the returned String is considered translatable and should therefore be placed in an appropriate resource file. When possible, the returned label should be reasonably short enough to show in the navigator or explorer windows but long enough to clearly identify and distinguish the Viewable.

Returns:

a short descriptive label of the Viewable that can be shown to the user.

getToolTip

java.lang.String getToolTip()

Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Viewable.

Returns:

the tooltip to show when the mouse pointer pauses over a UI component that represents this Viewable.

getIcon

IconDescription getIcon()

Gets a relative path to the icon. Generally, the is considered translatable, therefore, the path value be placed in an appropriate resource file. The path must be relative the Viewable implementation class file location or the resource file location if one is provided.

Returns:

The icon relative path.

toString

java.lang.String toString()

Returns the label. This overrides the toString method in java.lang.Object.

Implementors of the Viewable interface should override this as appropriate. The default implementation is the same as getLabel()

Overrides:

toString in class java.lang.Object

Returns:

A short label describing this Viewable.

See Also:

Object.toString(), getLabel()

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Add a PropertyChangeListener to the listener list. A PropertyChangeEvent will be fired in response to setting a bound property.

Parameters:

listener - A PropertyChangeListener.

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a PropertyChangeListener from the listener list.

Parameters:

listener - A PropertyChangeListener.