Viewable

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> javax >> ide >> [ view overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.ide.view
Interface Viewable

All Known Implementing Classes:: DefaultViewable

public interface Viewable

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

Field Summary

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

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Add a java.beans.PropertyChangeListener to the listener list.

javax.ide.util.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 java.beans.PropertyChangeListener from the listener list.

java.lang.String toString()
          Returns the label.

Field Detail

PROP_LABEL

public static final java.lang.String PROP_LABEL

Identifies the bound property 'label'.

See Also:: Constant Field Values

PROP_ICON_PATH

public static final java.lang.String PROP_ICON_PATH

Identifies the bound property 'iconPath'.

See Also:: Constant Field Values

PROP_VISIBLE

public static final java.lang.String PROP_VISIBLE

Identifies the bound property 'visible'.

See Also:: Constant Field Values

Method Detail

isVisible

public boolean isVisible()

Get the object visible state.

getLabel

public java.lang.String getLabel()

Returns a short label that can be displayed to the user. Generally, the value of the returned java.lang.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.

getToolTip

public java.lang.String getToolTip()

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

getIcon

public javax.ide.util.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.

toString

public 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()

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

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

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a java.beans.PropertyChangeListener from the listener list.