public interface Viewable
Viewable
s are objects that map directly to visible
GUI elements that users can select.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'.
|
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.
|
static final java.lang.String PROP_LABEL
static final java.lang.String PROP_ICON_PATH
static final java.lang.String PROP_VISIBLE
boolean isVisible()
java.lang.String getLabel()
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
.Viewable
that can be shown to the user.java.lang.String getToolTip()
Viewable
.Viewable
.IconDescription getIcon()
java.lang.String toString()
toString
method in
java.lang.Object
.
Implementors of the Viewable
interface should
override this as appropriate. The default implementation is
the same as getLabel()
toString
in class java.lang.Object
Viewable
.Object.toString()
,
getLabel()
void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
PropertyChangeListener
to the listener list.
A PropertyChangeEvent
will be fired in response to setting
a bound property.listener
- A PropertyChangeListener
.void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
PropertyChangeListener
from the listener list.listener
- A PropertyChangeListener
.