|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.swing.AbstractAction
org.jdesktop.swingx.action.AbstractActionExt
public abstract class AbstractActionExt
Extends the concept of the Action to include toggle or group states.
| Field Summary | |
|---|---|
static java.lang.String |
GROUP
The key for the button group |
static java.lang.String |
IS_STATE
The key for the flag which indicates that this is a state type. |
static java.lang.String |
LARGE_ICON
The key for the large icon |
| Fields inherited from class javax.swing.AbstractAction |
|---|
changeSupport, enabled |
| Fields inherited from interface javax.swing.Action |
|---|
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON |
| Constructor Summary | |
|---|---|
AbstractActionExt()
Default constructor, does nothing. |
|
AbstractActionExt(AbstractActionExt action)
Copy constructor copies the state. |
|
AbstractActionExt(java.lang.String name)
|
|
AbstractActionExt(java.lang.String name,
javax.swing.Icon icon)
|
|
AbstractActionExt(java.lang.String name,
java.lang.String command)
Constructs an Action with the label and command |
|
AbstractActionExt(java.lang.String name,
java.lang.String command,
javax.swing.Icon icon)
|
|
| Method Summary | |
|---|---|
void |
dispose()
Will perform cleanup on the object. |
javax.swing.KeyStroke |
getAccelerator()
Returns the key stroke which represents an accelerator for the action. |
java.lang.Object |
getActionCommand()
Returns the action command. |
java.lang.Object |
getGroup()
|
javax.swing.Icon |
getLargeIcon()
Returns a large icon which represents the action. |
java.lang.String |
getLongDescription()
Returns a long description of the action. |
int |
getMnemonic()
Return the mnemonic key code for the action. |
java.lang.String |
getName()
Returns the name of the action. |
java.lang.String |
getShortDescription()
Returns a short description of the action. |
javax.swing.Icon |
getSmallIcon()
Returns a small icon which represents the action. |
boolean |
isSelected()
|
boolean |
isStateAction()
Indicates if this action has states. |
void |
itemStateChanged(java.awt.event.ItemEvent e)
Callback method as ItemListener. |
void |
setAccelerator(javax.swing.KeyStroke key)
Sets the key stroke which represents an accelerator for the action. |
void |
setActionCommand(java.lang.Object key)
Sets the action command key. |
void |
setGroup(java.lang.Object group)
Sets the group identity of the state action. |
void |
setLargeIcon(javax.swing.Icon icon)
Sets the large icon which represents the action. |
void |
setLongDescription(java.lang.String desc)
Sets the long description of the action. |
void |
setMnemonic(int mnemonic)
Sets the mnemonic key code for the action. |
void |
setMnemonic(java.lang.String mnemonic)
|
void |
setName(java.lang.String name)
Sets the name of the action. |
void |
setSelected(boolean newValue)
Changes the state of the action |
void |
setShortDescription(java.lang.String desc)
Sets the short description of the action. |
void |
setSmallIcon(javax.swing.Icon icon)
Sets the small icon which represents the action. |
void |
setStateAction()
Set the state property to true. |
void |
setStateAction(boolean state)
Set the state property. |
java.lang.String |
toString()
|
| Methods inherited from class javax.swing.AbstractAction |
|---|
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface java.awt.event.ActionListener |
|---|
actionPerformed |
| Field Detail |
|---|
public static final java.lang.String LARGE_ICON
public static final java.lang.String GROUP
public static final java.lang.String IS_STATE
| Constructor Detail |
|---|
public AbstractActionExt()
public AbstractActionExt(AbstractActionExt action)
public AbstractActionExt(java.lang.String name)
public AbstractActionExt(java.lang.String name,
javax.swing.Icon icon)
public AbstractActionExt(java.lang.String name,
java.lang.String command)
name - name of the action usually used as a labelcommand - command key of the action
public AbstractActionExt(java.lang.String name,
java.lang.String command,
javax.swing.Icon icon)
name - display name of the actioncommand - the value of the action command keyicon - icon to display| Method Detail |
|---|
public java.lang.String getShortDescription()
public void setShortDescription(java.lang.String desc)
This is a convenience method for putValue with the
Action.SHORT_DESCRIPTION key.
desc - the short description; can be nullwAction.SHORT_DESCRIPTION,
Action.putValue(java.lang.String, java.lang.Object)public java.lang.String getLongDescription()
public void setLongDescription(java.lang.String desc)
This is a convenience method for putValue with the
Action.LONG_DESCRIPTION key.
desc - the long description; can be nullAction.LONG_DESCRIPTION,
Action.putValue(java.lang.String, java.lang.Object)public javax.swing.Icon getSmallIcon()
public void setSmallIcon(javax.swing.Icon icon)
This is a convenience method for putValue with the
Action.SMALL_ICON key.
icon - the small icon; can be nullAction.SMALL_ICON,
Action.putValue(java.lang.String, java.lang.Object)public javax.swing.Icon getLargeIcon()
public void setLargeIcon(javax.swing.Icon icon)
This is a convenience method for putValue with the
LARGE_ICON key.
icon - the large icon; can be nullLARGE_ICON,
Action.putValue(java.lang.String, java.lang.Object)public void setName(java.lang.String name)
This is a convenience method for putValue with the
Action.NAME key.
name - the name of the action; can be nullAction.NAME,
Action.putValue(java.lang.String, java.lang.Object)public java.lang.String getName()
public void setMnemonic(java.lang.String mnemonic)
public void setMnemonic(int mnemonic)
This is a convenience method for putValue with the
Action.MNEMONIC_KEY key.
This method does not validate the value. Please see
AbstractButton.setMnemonic(int) for details
concerning the value of the mnemonic.
mnemonic - an int key code mnemonic or 0AbstractButton.setMnemonic(int),
Action.MNEMONIC_KEY,
Action.putValue(java.lang.String, java.lang.Object)public int getMnemonic()
public void setActionCommand(java.lang.Object key)
This is a convenience method for putValue with the
Action.ACTION_COMMAND_KEY key.
key - the action commandAction.ACTION_COMMAND_KEY,
Action.putValue(java.lang.String, java.lang.Object)public java.lang.Object getActionCommand()
public javax.swing.KeyStroke getAccelerator()
public void setAccelerator(javax.swing.KeyStroke key)
This is a convenience method for putValue with the
Action.ACCELERATOR_KEY key.
key - the key stroke; can be nullAction.ACCELERATOR_KEY,
Action.putValue(java.lang.String, java.lang.Object)public void setGroup(java.lang.Object group)
public java.lang.Object getGroup()
public void dispose()
public boolean isStateAction()
public void setStateAction()
public void setStateAction(boolean state)
state - if true then this action will fire ItemEventspublic boolean isSelected()
public void setSelected(boolean newValue)
newValue - true to set the action as selected of the action.public java.lang.String toString()
toString in class java.lang.Objectpublic void itemStateChanged(java.awt.event.ItemEvent e)
ItemListener. Updates internal state based
on the given ItemEvent. Here: synchs selected property if isStateAction(), does nothing otherwise.
itemStateChanged in interface java.awt.event.ItemListenere - the ItemEvent fired by a ItemSelectable on changing the selected
state.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||