|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.swing.AbstractAction
com.pepper.platform.program.actions.ProgramAbstractAction
public abstract class ProgramAbstractAction
Abstract base class used by most common actions in the Keeper Framework.
Field Summary | |
---|---|
static String |
IMAGE_DIR
Image Dir |
static String |
LARGE_ICON
Large Icon |
protected static org.apache.commons.logging.Log |
log
|
Fields inherited from class javax.swing.AbstractAction |
---|
changeSupport, enabled |
Fields inherited from interface javax.swing.Action |
---|
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON |
Constructor Summary | |
---|---|
ProgramAbstractAction()
Creates a new ProgramAbstractAction instance. |
|
ProgramAbstractAction(String packageId)
Create a new action associated with a particular package ID |
|
ProgramAbstractAction(String actionName,
Icon icon)
Create a new action with a name and icon |
|
ProgramAbstractAction(String packageId,
String actionName)
Create a new action associated with a particular package ID with the specified actionName |
Method Summary | |
---|---|
String |
getActionCommand()
Gets the value from the key Action.ACTION_COMMAND_KEY . |
PepperProgramConfig |
getConfig()
Returns the PepperProgramConfig instance for this action. |
GuiServicesProvider |
getGSP()
Returns the GuiServicesProvider instance for the keeper |
ImageIcon |
getIcon(String name)
Returns the Icon associated with the name from the resources. |
String |
getLongDescription()
Gets the value from the key Action.LONG_DESCRIPTION . |
Integer |
getMnemonicKey()
Gets the value from the key Action.MNEMONIC_KEY . |
String |
getName()
Gets the value from the key Action.NAME . |
String |
getPackageId()
Get the packageId that this action is associated with |
PepperProgramProcess |
getProcess()
Returns the PepperProgramProcess associated with this action, or the currently displayed PepperProgramProcess |
AbstractPepperProgram |
getProgram()
Returns the PepperProgram associated with this action, or the currently displayed PepperProgram |
String |
getShortDescription()
Gets the value from the key Action.SHORT_DESCRIPTION |
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, toString, wait, wait, wait |
Methods inherited from interface java.awt.event.ActionListener |
---|
actionPerformed |
Field Detail |
---|
public static final String IMAGE_DIR
public static final String LARGE_ICON
protected static org.apache.commons.logging.Log log
Constructor Detail |
---|
public ProgramAbstractAction()
ProgramAbstractAction
instance.
public ProgramAbstractAction(String packageId)
packageId
- a String
valuepublic ProgramAbstractAction(String packageId, String actionName)
packageId
- The packageId of the packageactionName
- The name of the actionpublic ProgramAbstractAction(String actionName, Icon icon)
actionName
- a String
valueicon
- an Icon
valueMethod Detail |
---|
public String getPackageId()
String
valuepublic AbstractPepperProgram getProgram()
AbstractPepperProgram
instance.public PepperProgramProcess getProcess()
PepperProgramProcess
valuepublic PepperProgramConfig getConfig()
PepperProgramConfig
instance for this action.
PepperProgramConfig
valuepublic GuiServicesProvider getGSP()
GuiServicesProvider
instance for the keeper
public String getActionCommand()
Action.ACTION_COMMAND_KEY
.
String
containing the action's command key.public String getShortDescription()
Action.SHORT_DESCRIPTION
String
containing the action's short description.public String getLongDescription()
Action.LONG_DESCRIPTION
.
String
containing the action's long description.public String getName()
Action.NAME
.
String
containing the action's name.public Integer getMnemonicKey()
Action.MNEMONIC_KEY
.
Integer
value containing the action's mnemonic key number.public ImageIcon getIcon(String name)
name
- name of the icon file i.e., help16.gif
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |