|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.5.0) E13403-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.ide.view.DefaultViewable
javax.ide.menu.IDEAction
public class IDEAction
IDEAction
encapsulates the meta-data describing an executable action.
Field Summary | |
---|---|
static java.lang.String |
PROP_CHECKED Identifies the bound property 'checked'. |
static java.lang.String |
PROP_ENABLED Identifies the bound property 'enabled'. |
static java.lang.String |
PROP_MNEMONIC Identifies the bound property 'mnemonic'. |
static java.lang.String |
PROP_TOGGLE_ITEM Identifies the bound property 'toggleItem'. |
static java.lang.String |
PROP_TOOLTIP Identifies the bound property 'toolTip'. |
Fields inherited from interface javax.ide.view.Viewable |
---|
PROP_ICON_PATH, PROP_LABEL, PROP_VISIBLE |
Constructor Summary | |
---|---|
IDEAction(java.lang.String id) Constructor. |
Method Summary | |
---|---|
java.util.List |
getControllers() Get the controllers for this action. |
IconDescription |
getIcon() Gets a relative path to the icon. |
java.lang.String |
getID() Gets this object's unique identifier. |
java.lang.String |
getLabel() Get a short descriptive label that can be shown to the user. |
int |
getMnemonic() |
java.lang.String |
getToolTip() Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Viewable . |
int |
hashCode() |
boolean |
isChecked() Find out whether the state of this IDEAction is checked or unchecked. |
boolean |
isEnabled() |
boolean |
isToggleItem() Get whether this action is a toggle action. |
void |
setChecked(boolean checked) Set the state of the IDEAction . |
void |
setEnabled(boolean enabled) Set the enabled state of the IDEAction . |
void |
setIcon(IconDescription icon) Set the action icon path. |
void |
setLabel(java.lang.String label) Set the action label. |
void |
setMnemonic(int mnemonic) Set the action label mnemonic character. |
void |
setToggleItem(boolean isToggleItem) |
void |
setToolTip(java.lang.String toolTip) Set the action tooltip. |
java.lang.String |
toString() Returns the label. |
Methods inherited from class javax.ide.view.DefaultViewable |
---|
addPropertyChangeListener, firePropertyChange, isVisible, removePropertyChangeListener, setVisible |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface javax.ide.view.Viewable |
---|
addPropertyChangeListener, isVisible, removePropertyChangeListener |
Field Detail |
---|
public static final java.lang.String PROP_MNEMONIC
public static final java.lang.String PROP_CHECKED
public static final java.lang.String PROP_ENABLED
public static final java.lang.String PROP_TOOLTIP
public static final java.lang.String PROP_TOGGLE_ITEM
Constructor Detail |
---|
public IDEAction(java.lang.String id)
id
must be a unique string identifier. This ID can be used to find the action using the ActionRegistry
.
id
- A unique string identifying the command. The id
of an action has an undefined type, an the id name set to the string identifying the action.Method Detail |
---|
public boolean isChecked()
IDEAction
is checked or unchecked.IDEAction
.public void setChecked(boolean checked)
IDEAction
. Bound property.checked
- The state of the IDEAction
.public boolean isEnabled()
true
if the IDEAction
is enabled. false
otherwise.public void setEnabled(boolean enabled)
IDEAction
. Bound property.enabled
- The state of the IDEAction
.public boolean isToggleItem()
public java.lang.String getLabel()
DefaultViewable
getLabel
in interface Viewable
getLabel
in class DefaultViewable
public void setLabel(java.lang.String label)
public int getMnemonic()
public void setMnemonic(int mnemonic)
mnemonic
- The character to be used as mnemonic.public java.lang.String getToolTip()
Viewable
Viewable
.getToolTip
in interface Viewable
getToolTip
in class DefaultViewable
Viewable
.public void setToolTip(java.lang.String toolTip)
public IconDescription getIcon()
Viewable
getIcon
in interface Viewable
getIcon
in class DefaultViewable
public void setIcon(IconDescription icon)
public java.util.List getControllers()
public java.lang.String toString()
Viewable
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 interface Viewable
toString
in class DefaultViewable
Viewable
.Object.toString()
, Viewable.getLabel()
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String getID()
Identifiable
getID
in interface Identifiable
public void setToggleItem(boolean isToggleItem)
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.5.0) E13403-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |