FwkCommand

java.lang.Object
- com.highqsoft.fwk.Fwk
- - com.highqsoft.fwk.FwkDescription
  - - com.highqsoft.fwk.FwkPropertyChange
    - - com.highqsoft.fwk.FwkCommand

All Implemented Interfaces:

FwkCommandInterface, FwkControlledByInterface, FwkDescriptionInterface, FwkInstructionInterface, FwkInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AddNewInstanceElementCommand, ApplicationElementCustomizer, AsamCommanderCustomizeCommand, AsamCommanderCustomizePresentorsCommand, AsamCommanderCustomizeSelectorsCommand, AsamCommanderDisconnectCommand, AsamCommanderNameServiceCommand, CommandContainer, DataManagerColumnDisplayCommand, DataManagerReadColumnsCommand, DataManagerRevokeCommand, DataManagerWriteColumnsCommand, Externalrefs, FwkAboutCommand, FwkColorCommand, FwkColorSelectCommand, FwkColumnDisplayCommand, FwkComponentSelectCommand, FwkComponentStartCommand, FwkConfigServiceCommand, FwkCopyToClipboardCommand, FwkDumpToXMLCommand, FwkExecCommand, FwkExitCommand, FwkFontCommand, FwkGCCommand, FwkHelpNextCommand, FwkHelpPrevCommand, FwkItemRevokeCommand, FwkLoadFromXMLCommand, FwkMethodCommand, FwkPageFormatCommand, FwkPrintCommand, FwkServiceInterrogateCommand, FwkServicePauseCommand, FwkServiceStartCommand, FwkServiceStopCommand, FwkStringSaveAsCommand, FwkSystemInfoCommand, FwkTextEditorCommand, FwkTextFieldEditorCommand, FwkToggleCommand, InstanceElementCustomizer, InstanceElementCustomizer, JasperInstanceElementPlugin, LayouterCommand, MEDCalculator, MEDConfigComponentsCommand, MEDCrosshair, MEDLayouterCommand, MEDMarkerGenerator, MEDMouseBehaviorAdapter, MEDPickComponents, MEDPlotControlCommand, MEDSelectColumnCommand, MoMaXCommand, OdsGraph, OdsxAppendToMeasurementCommand, OdsxApplElemDefaultChildrenSelector, OdsxATFFilterCommand, OdsxBaseElementFilterCommand, OdsxCheckModelCommand, OdsxCloseSessionCommand, OdsxCopyInstanceCommand, OdsxCreateMeasurementCommand, OdsxDebugLevelEditorCommand, OdsxDeleteInstanceCommand, OdsxDumpMeasurementCommand, OdsxFactoryCommand, OdsxFilter, OdsxFilterEditorCommand, OdsxInstanceCreateCommand, OdsxInstanceEditCommand, OdsxInstElemDefaultChildrenSelector, OdsxInstElemDefaultMenu, OdsxLayouterCommand, OdsxPublicValueMatrixCommand, OdsxSelectorPanel.DeleteMultiInstanceCommand, OdsxSelectorPanel.UpdateTreeCommand, OdsxSetContextCommand, OdsxTranslatePresentableCommand, OdsxUnpublicValueMatrixCommand, P2DColumnDisplayCommand, P2DConfigComponentsCommand, P2DMarkerColorCommand, P2DMarkerDeleteCommand, P2DMarkerNameCommand, P2DMarkerStatisticsCommand, P2DMarkerZoomCommand, P2DRangeCommand, P2DTest.GCCommand, P2DUnselectCommand, SessionCustomizer
```
public class FwkCommand
extends FwkPropertyChange
implements FwkCommandInterface
```
The default FwkCommandInterface implementation.

Since:

$Date: 2017/04/28 08:47:40 $

Version:

$Revision: 1.15 $

Author:

HighQSoft GmbH

See Also:
, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected FwkArrayInterface`	`actionListeners` The array that holds the action listener.
`protected java.lang.Class`	`buttonClass` The button class.
`protected java.lang.String`	`commandName` The command string.
`protected java.lang.String`	`helpID` The help id of the component to be created.
`protected FwkIconInterface`	`icon` The icon image.
`protected java.lang.String`	`iconKey` The icon property keyword.
`protected FwkInstructionInterface`	`instruction` The instruction interface implementation reference.
`protected boolean`	`menuEventEnabled` The flag that decides whether the command is enabled to react on menu events.
`protected java.lang.Class`	`menuItemClass` The menu item class.
`protected FwkArrayInterface`	`menuListeners` The array that holds the menu listener.
`protected int`	`mnemonic` The mnemonic of the command.
`protected java.util.Properties`	`properties` The properties of the command.
`protected boolean`	`radioGroupState` The radio group flag.
`protected java.util.Hashtable`	`registry` The registry.
`protected boolean`	`sensitive` The sensitive flag.
`protected boolean`	`separator` The separator flag.
`protected java.lang.String`	`text` The text of the command.
`protected java.lang.String`	`textKey` The text of the command.
`protected boolean`	`toggle` The toggle flag.
`protected boolean`	`toggleState` The toggle state flag.
`protected boolean`	`toolBarEnabled` The flag that decides whether the command is a toolbar command.
`protected java.lang.String`	`toolTipKey` The tool tip text key.
`protected java.lang.String`	`toolTipText` The tool tip text.
`static java.lang.String`	`version`
`protected boolean`	`visible` The visible flag.

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange
source

Fields inherited from class com.highqsoft.fwk.FwkDescription
author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, ICON, iconCount, internetAddress, name, titleName

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkCommandInterface
CONTROLLER_PROPERTY, MENU_REASON_CANCELED, MENU_REASON_DESELECTED, MENU_REASON_SELECTED

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface
AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Constructor Summary

Constructors
Constructor and Description
`FwkCommand()` The constructor.
`FwkCommand(FwkControllerInterface controller)` The constructor receiving the controller.
`FwkCommand(java.lang.String text)` The constructor receiving the text value.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addActionListener(java.awt.event.ActionListener actionListener)` Add an action listener to the command.
`void`	`addCommand(FwkCommandInterface command)` Add the command to the command array.
`void`	`addCommand(int index, FwkCommandInterface command)` Insert a command at the specified position.
`void`	`addMenuListener(javax.swing.event.MenuListener menuListener)` Add a menu listener to the command.
`void`	`addToGroup(int index, java.lang.String groupIdent, java.lang.String commandName)` Add a command to a group.
`void`	`addToGroup(java.lang.String groupIdent, java.lang.String commandName)` Add a command to a group.
`void`	`clearCommands()` Clear all commands.
`boolean`	`commandsAvailable()` This method returns a boolean that indicates whether the command array is initialized.
`void`	`deleteGroup(java.lang.String groupIdent)` Delete command group.
`boolean`	`execute(java.util.EventObject ev)` Execute the command.
`FwkArrayInterface`	`getActionListenerArray()` Get the action listener array of the command.
`java.lang.Class`	`getButtonClass()` Get the button class.
`FwkCommandInterface`	`getCommand(java.lang.String command)` Get a sub-command.
`java.lang.String`	`getCommandName()` Get the command name.
`FwkCommandInterface[]`	`getCommands()` Get the sub-commands of the command.
`FwkControllerInterface`	`getController()` Get the command controller.
`FwkCommandInterface[]`	`getGroup(java.lang.String groupIdent)` Retrieve the command group.
`java.lang.String`	`getHelpID()` Get the help id.
`FwkIconInterface`	`getIcon()` Get the icon image of the command.
`java.lang.String`	`getIconKey()` Get the icon property keyword.
`boolean`	`getMenuEventEnabled()` Get the menu event enabled flag.
`java.lang.Class`	`getMenuItemClass()` Get the menu item class.
`FwkArrayInterface`	`getMenuListenerArray()` Get the menu listener array of the command.
`int`	`getMnemonic()` Get the mnemonic of the command.
`java.util.Iterator`	`getProperties()` Get all keywords that define a property.
`java.lang.Object`	`getProperty(java.lang.String key)` Get the property for the specified property keyword.
`boolean`	`getRadioGroupState()` Gets the radio group state.
`boolean`	`getSensitivity()` Gets the sensitivity.
`boolean`	`getSeparator()` Gets the separator flag.
`java.lang.String`	`getText()` Get the command text.
`java.lang.String`	`getTextKey()` Get the command text key.
`boolean`	`getToggle()` Gets the toggle flag.
`boolean`	`getToggleState()` Gets the toggle state.
`boolean`	`getToolBarEnabled()` Returns a boolean whether the command is atoolbar command.
`java.lang.String`	`getToolTipKey()` Get the command tooltip key.
`java.lang.String`	`getToolTipText()` Get the command tooltip text.
`java.lang.String`	`getVersion()` Return the version string of the FWK component.
`boolean`	`getVisibility()` Gets the visiblity.
`boolean`	`groupExists(java.lang.String groupIdent)` Check whether a group exists.
`boolean`	`hasActionListeners()` Returns a boolean whether the command has action listeners.
`boolean`	`hasMenuListeners()` Returns a boolean whether the command has menu listeners.
`boolean`	`isParent()` Returns a boolean whether the command has children.
`boolean`	`menuSelect(javax.swing.event.MenuEvent event, int reason)` The callback for menuevents.
`void`	`register(java.lang.Object obj)` Register the object at the command.
`java.util.Enumeration`	`registeredObjects()` Retrieves the enumeration of registered objects.
`int`	`registrySize()` Return the total number of registered objects.
`void`	`removeActionListener(java.awt.event.ActionListener actionListener)` Remove an action listener from the command.
`void`	`removeCommand(FwkCommandInterface command)` Remove a sub-command.
`void`	`removeFromGroup(java.lang.String groupIdent, java.lang.String commandName)` Remove a command from a group.
`void`	`removeMenuListener(javax.swing.event.MenuListener menuListener)` Remove a menu listener from the command.
`void`	`setAsParent()` Set the FwkCommand as a parent.
`void`	`setButtonClass(java.lang.Class clazz)` Set the button class.
`void`	`setCommandName(java.lang.String commandName)` Set the command name.
`void`	`setCommands(FwkCommandInterface[] commands)` Set the sub-commands of the command.
`void`	`setController(FwkControllerInterface controller)` Set the command controller.
`void`	`setHelpID(java.lang.String helpID)` Set the command help ID.
`void`	`setIcon(FwkIconInterface icon)` Set the icon image of the command.
`void`	`setIconKey(java.lang.String iconKey)` Set the icon key to get the icon from properties.
`void`	`setMenuEventEnabled(boolean flag)` Set the menu event enabled flag.
`void`	`setMenuItemClass(java.lang.Class clazz)` Set the menu item class.
`void`	`setMnemonic(int mnemonic)` Set the mnemonic of the command.
`void`	`setProperty(java.lang.String key, java.lang.Object value)` Set a property for the specified property keyword.
`void`	`setRadioGroupState(boolean flag)` Sets the radio group state.
`void`	`setSensitivity(boolean flag)` Sets the sensitivity of the command.
`void`	`setSeparator(boolean flag)` Sets the command as separator.
`void`	`setText(java.lang.String text)` Set the command text.
`void`	`setTextKey(java.lang.String textKey)` Set the command text key to get the properties.
`void`	`setToggle(boolean flag)` Sets the command as toggle.
`void`	`setToggleState(boolean flag)` Sets the command toggle state.
`void`	`setToolBarEnabled(boolean flag)` Returns a boolean whether the command is atoolbar command.
`void`	`setToolTipKey(java.lang.String toolTipKey)` Set the command tooltip key to get the properties.
`void`	`setToolTipText(java.lang.String toolTipText)` Set the command tooltip text.
`void`	`setVisibility(boolean flag)` Sets the visibility of the command.
`java.lang.String`	`toString()` Return the string representation of the command.
`void`	`unregister(java.lang.Object obj)` Unregister the object.

Methods inherited from class com.highqsoft.fwk.Fwk
getNiceVersion, release

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface
getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface
release

- Field Detail
  - version
```
public static final java.lang.String version
```
    See Also:
    Constant Field Values
  - toolBarEnabled
```
protected boolean toolBarEnabled
```
    The flag that decides whether the command is a toolbar command.
  - menuEventEnabled
```
protected boolean menuEventEnabled
```
    The flag that decides whether the command is enabled to react on menu events.
  - text
```
protected java.lang.String text
```
    The text of the command.
  - textKey
```
protected java.lang.String textKey
```
    The text of the command.
  - commandName
```
protected java.lang.String commandName
```
    The command string.
  - mnemonic
```
protected int mnemonic
```
    The mnemonic of the command.
  - icon
```
protected FwkIconInterface icon
```
    The icon image.
  - iconKey
```
protected java.lang.String iconKey
```
    The icon property keyword.
  - toolTipText
```
protected java.lang.String toolTipText
```
    The tool tip text.
  - toolTipKey
```
protected java.lang.String toolTipKey
```
    The tool tip text key.
  - visible
```
protected boolean visible
```
    The visible flag. It is true by default.
  - sensitive
```
protected boolean sensitive
```
    The sensitive flag. It is true by default.
  - separator
```
protected boolean separator
```
    The separator flag. It is false by default.
  - toggle
```
protected boolean toggle
```
    The toggle flag. It is false by default.
  - toggleState
```
protected boolean toggleState
```
    The toggle state flag. It is false by default.
  - radioGroupState
```
protected boolean radioGroupState
```
    The radio group flag. It is false by default.
  - actionListeners
```
protected FwkArrayInterface actionListeners
```
    The array that holds the action listener.
  - menuListeners
```
protected FwkArrayInterface menuListeners
```
    The array that holds the menu listener.
  - helpID
```
protected java.lang.String helpID
```
    The help id of the component to be created.
  - registry
```
protected java.util.Hashtable registry
```
    The registry.
  - instruction
```
protected FwkInstructionInterface instruction
```
    The instruction interface implementation reference.
  - buttonClass
```
protected java.lang.Class buttonClass
```
    The button class.
  - menuItemClass
```
protected java.lang.Class menuItemClass
```
    The menu item class.
  - properties
```
protected java.util.Properties properties
```
    The properties of the command.
- Constructor Detail
  - FwkCommand
```
public FwkCommand()
```
    The constructor.
  - FwkCommand
```
public FwkCommand(FwkControllerInterface controller)
```
    The constructor receiving the controller.
    
    Parameters:
    controller - The command controller.
  - FwkCommand
```
public FwkCommand(java.lang.String text)
```
    The constructor receiving the text value.
    
    Parameters:
    text - The text value of the command.
- Method Detail
  - getVersion
```
public java.lang.String getVersion()
```
    Description copied from interface: FwkInterface
    
    Return the version string of the FWK component.
    
    Specified by:
    
    getVersion in interface FwkInterface
    
    Overrides:
    
    getVersion in class FwkPropertyChange
  - getCommandName
```
public java.lang.String getCommandName()
```
    Get the command name. If there isn't a text defined this routine will return the property belongs to the command string key. If the isn't property found the function returns either the command string key or null if undefined.
    
    Specified by:
    
    getCommandName in interface FwkCommandInterface
    
    Returns:
    The command string.
    See Also:
    setCommandName(String)
  - getController
```
public FwkControllerInterface getController()
```
    Get the command controller.
    
    Specified by:
    
    getController in interface FwkControlledByInterface
    
    Returns:
    The command controller.
    See Also:
    #setController(Object), #FwkMenuFactory
  - getHelpID
```
public java.lang.String getHelpID()
```
    Get the help id. If there isn't a HelpID defined the method return null.
    
    Specified by:
    
    getHelpID in interface FwkCommandInterface
    
    Returns:
    The help id.
    See Also:
    setHelpID(String)
  - getIcon
```
public FwkIconInterface getIcon()
```
    Get the icon image of the command. If there is currently no icon available, it sets the command string as icon key.
    
    Specified by:
    
    getIcon in interface FwkCommandInterface
    
    Specified by:
    
    getIcon in interface FwkDescriptionInterface
    
    Overrides:
    
    getIcon in class FwkDescription
    
    Returns:
    The icon image of the command.
    See Also:
    setIconKey(String), #setIconImage(Image), #getIconfilename()
  - getIconKey
```
public java.lang.String getIconKey()
```
    Get the icon property keyword.
    
    Specified by:
    
    getIconKey in interface FwkCommandInterface
    
    Specified by:
    
    getIconKey in interface FwkDescriptionInterface
    
    Overrides:
    
    getIconKey in class FwkDescription
    
    Returns:
    The icon property keyword.
    See Also:
    #getIconImage()
  - getMnemonic
```
public int getMnemonic()
```
    Get the mnemonic of the command.
    
    Specified by:
    
    getMnemonic in interface FwkCommandInterface
    
    Returns:
    the mnemonic of the command.
  - getRadioGroupState
```
public boolean getRadioGroupState()
```
    Gets the radio group state. That state indicates whether the command is a parent of an radio group.
    
    Specified by:
    
    getRadioGroupState in interface FwkCommandInterface
    
    Returns:
    A boolean represent the radio group state.
    See Also:
    setRadioGroupState(boolean)
  - getSensitivity
```
public boolean getSensitivity()
```
    Gets the sensitivity.
    
    Specified by:
    
    getSensitivity in interface FwkCommandInterface
    
    Returns:
    A boolean indicates wether the command is sensitive.
    See Also:
    setSensitivity(boolean)
  - getSeparator
```
public boolean getSeparator()
```
    Gets the separator flag.
    
    Specified by:
    
    getSeparator in interface FwkCommandInterface
    
    Returns:
    A boolean indicates wether the command is a separator.
    See Also:
    setSeparator(boolean)
  - getText
```
public java.lang.String getText()
```
    Get the command text. If there isn't a text defined this routine will return the property belongs to the text key. If the isn't property found the function returns either the text key or null if undefined.
    
    Specified by:
    
    getText in interface FwkCommandInterface
    
    Returns:
    The command text.
    See Also:
    setText(String), getTextKey()
  - getTextKey
```
public java.lang.String getTextKey()
```
    Get the command text key.
    
    Specified by:
    
    getTextKey in interface FwkCommandInterface
    
    Returns:
    The command text key.
    See Also:
    setTextKey(String), getText()
  - getToggle
```
public boolean getToggle()
```
    Gets the toggle flag.
    
    Specified by:
    
    getToggle in interface FwkCommandInterface
    
    Returns:
    A boolean indicates wether the command is a toggle.
    See Also:
    setToggle(boolean)
  - getToggleState
```
public boolean getToggleState()
```
    Gets the toggle state.
    
    Specified by:
    
    getToggleState in interface FwkCommandInterface
    
    Returns:
    A boolean represent the toggle state.
    See Also:
    setToggleState(boolean)
  - getToolTipKey
```
public java.lang.String getToolTipKey()
```
    Get the command tooltip key.
    
    Specified by:
    
    getToolTipKey in interface FwkCommandInterface
    
    Returns:
    The command tooltip key.
    See Also:
    setToolTipKey(String), getToolTipText()
  - getToolTipText
```
public java.lang.String getToolTipText()
```
    Get the command tooltip text. If there isn't a text defined this routine will return the property belongs to the tool tip key. If the isn't property found the function returns either the text key or null if undefined.
    
    Specified by:
    
    getToolTipText in interface FwkCommandInterface
    
    Returns:
    The command tooltip text.
    See Also:
    setToolTipText(String), getToolTipKey()
  - getVisibility
```
public boolean getVisibility()
```
    Gets the visiblity.
    
    Specified by:
    
    getVisibility in interface FwkCommandInterface
    
    Returns:
    A boolean indicates wether the command is visible.
    See Also:
    setVisibility(boolean)
  - setToolBarEnabled
```
public void setToolBarEnabled(boolean flag)
```
    Returns a boolean whether the command is atoolbar command. The command is automatically enabled for toolbar if it holds an icon.
    
    Specified by:
    
    setToolBarEnabled in interface FwkCommandInterface
    
    Parameters:
    true - If the command should be enabled for the toolbar.
  - getToolBarEnabled
```
public boolean getToolBarEnabled()
```
    Returns a boolean whether the command is atoolbar command.
    
    Specified by:
    
    getToolBarEnabled in interface FwkCommandInterface
    
    Returns:
    true if the command is a toolbar command.
  - isParent
```
public boolean isParent()
```
    Returns a boolean whether the command has children.
    
    Specified by:
    
    isParent in interface FwkCommandInterface
    
    Returns:
    true if the command has children.
  - setAsParent
```
public void setAsParent()
```
    Set the FwkCommand as a parent.
    
    Specified by:
    
    setAsParent in interface FwkCommandInterface
  - setCommandName
```
public void setCommandName(java.lang.String commandName)
```
    Set the command name. This method fires a PropertyChangeEvent on property Command.
    
    Specified by:
    
    setCommandName in interface FwkCommandInterface
    
    Parameters:
    command - The new command string of the command.
    See Also:
    getCommandName()
  - setController
```
public void setController(FwkControllerInterface controller)
```
    Set the command controller. This method fires a PropertyChangeEvent on property Controller.
    
    Specified by:
    
    setController in interface FwkControlledByInterface
    
    Parameters:
    controller - The new controller of the command.
    See Also:
    getController(), #FwkMenuFactory
  - setHelpID
```
public void setHelpID(java.lang.String helpID)
```
    Set the command help ID. This method fires a PropertyChangeEvent on property HelpID.
    
    Specified by:
    
    setHelpID in interface FwkCommandInterface
    
    Parameters:
    helpID - The new helpID of the command.
    See Also:
    getHelpID()
  - setIcon
```
public void setIcon(FwkIconInterface icon)
```
    Set the icon image of the command. This method fires a PropertyChangeEvent on property IconImage.
    
    Specified by:
    
    setIcon in interface FwkCommandInterface
    
    Specified by:
    
    setIcon in interface FwkDescriptionInterface
    
    Overrides:
    
    setIcon in class FwkDescription
    
    Parameters:
    image - The new icon of the command.
    See Also:
    #getIconImage(), #setIconfilename(String)
  - setIconKey
```
public void setIconKey(java.lang.String iconKey)
```
    Set the icon key to get the icon from properties. If the key isn't null the method tries to load the icon. The method uses the IconFile object to read the icon from file or URL. This method fires a PropertyChangeEvent on property IconKey.
    
    Specified by:
    
    setIconKey in interface FwkCommandInterface
    
    Specified by:
    
    setIconKey in interface FwkDescriptionInterface
    
    Overrides:
    
    setIconKey in class FwkDescription
    
    Parameters:
    iconKey - The new icon property keyword.
    See Also:
    getIconKey(), getIcon()
  - setMenuEventEnabled
```
public void setMenuEventEnabled(boolean flag)
```
    Set the menu event enabled flag.
    
    Specified by:
    
    setMenuEventEnabled in interface FwkCommandInterface
    
    Parameters:
    flag - if true the menu events are enabled.
  - getMenuEventEnabled
```
public boolean getMenuEventEnabled()
```
    Get the menu event enabled flag.
    
    Specified by:
    
    getMenuEventEnabled in interface FwkCommandInterface
    
    Returns:
    true the menu events are enabled.
  - menuSelect
```
public boolean menuSelect(javax.swing.event.MenuEvent event,
                 int reason)
```
    The callback for menuevents.
    
    Specified by:
    
    menuSelect in interface FwkCommandInterface
    
    Parameters:
    event - The menuevent
    reason - The reson. Use predefined constants above.
  - setMnemonic
```
public void setMnemonic(int mnemonic)
```
    Set the mnemonic of the command. This method fires a PropertyChangeEvent on property Mnemonic.
    
    Specified by:
    
    setMnemonic in interface FwkCommandInterface
    
    Parameters:
    mnemonic - The new mnemonic of the command.
    See Also:
    getMnemonic()
  - setRadioGroupState
```
public void setRadioGroupState(boolean flag)
```
    Sets the radio group state. This method fires a PropertyChangeEvent on property RadioGroupState.
    
    Specified by:
    
    setRadioGroupState in interface FwkCommandInterface
    
    Parameters:
    flag - true if command is a toggle.
    See Also:
    getRadioGroupState()
  - setSensitivity
```
public void setSensitivity(boolean flag)
```
    Sets the sensitivity of the command. This method fires a PropertyChangeEvent on property Sensitivity.
    
    Specified by:
    
    setSensitivity in interface FwkCommandInterface
    
    Parameters:
    flag - true if sensitive.
    See Also:
    getSensitivity()
  - setSeparator
```
public void setSeparator(boolean flag)
```
    Sets the command as separator. This method fires a PropertyChangeEvent on property Separator.
    
    Specified by:
    
    setSeparator in interface FwkCommandInterface
    
    Parameters:
    flag - true if separator.
    See Also:
    getSeparator()
  - setText
```
public void setText(java.lang.String text)
```
    Set the command text. This method fires a PropertyChangeEvent on property Text.
    
    Specified by:
    
    setText in interface FwkCommandInterface
    
    Parameters:
    text - The new text of the command.
    See Also:
    getText(), setTextKey(String)
  - setTextKey
```
public void setTextKey(java.lang.String textKey)
```
    Set the command text key to get the properties. This method fires a PropertyChangeEvent on property TextKey.
    
    Specified by:
    
    setTextKey in interface FwkCommandInterface
    
    Parameters:
    textKey - The new text key of the command.
    See Also:
    getTextKey(), getText()
  - setToggle
```
public void setToggle(boolean flag)
```
    Sets the command as toggle. This method fires a PropertyChangeEvent on property Toogle.
    
    Specified by:
    
    setToggle in interface FwkCommandInterface
    
    Parameters:
    flag - true if command is a toggle.
    See Also:
    getToggle()
  - setToggleState
```
public void setToggleState(boolean flag)
```
    Sets the command toggle state. If the toggle flag is not set, this property makes no sense. This method fires a PropertyChangeEvent on property ToogleState.
    
    Specified by:
    
    setToggleState in interface FwkCommandInterface
    
    Parameters:
    flag - true if command is a toggle.
    See Also:
    getToggle()
  - setToolTipText
```
public void setToolTipText(java.lang.String toolTipText)
```
    Set the command tooltip text. This method fires a PropertyChangeEvent on property ToolTipText.
    
    Specified by:
    
    setToolTipText in interface FwkCommandInterface
    
    Parameters:
    toolTipText - The new tooltip text of the command.
    See Also:
    getToolTipText(), getToolTipKey()
  - setToolTipKey
```
public void setToolTipKey(java.lang.String toolTipKey)
```
    Set the command tooltip key to get the properties. This method fires a PropertyChangeEvent on property ToolTipKey.
    
    Specified by:
    
    setToolTipKey in interface FwkCommandInterface
    
    Parameters:
    toolTipKey - The new tooltip key of the command.
    See Also:
    getToolTipKey(), getToolTipText()
  - setVisibility
```
public void setVisibility(boolean flag)
```
    Sets the visibility of the command. This method fires a PropertyChangeEvent on property Visibility.
    
    Specified by:
    
    setVisibility in interface FwkCommandInterface
    
    Parameters:
    flag - true if visible.
    See Also:
    getVisibility()
  - register
```
public void register(java.lang.Object obj)
```
    Register the object at the command.
    
    Specified by:
    
    register in interface FwkCommandInterface
    
    Parameters:
    obj - The object to be stored.
  - unregister
```
public void unregister(java.lang.Object obj)
```
    Unregister the object.
    
    Specified by:
    
    unregister in interface FwkCommandInterface
    
    Parameters:
    obj - The object to be unregistered,
  - registeredObjects
```
public java.util.Enumeration registeredObjects()
```
    Retrieves the enumeration of registered objects.
    
    Specified by:
    
    registeredObjects in interface FwkCommandInterface
    
    Returns:
    An object enumeration
  - registrySize
```
public int registrySize()
```
    Return the total number of registered objects.
    
    Specified by:
    
    registrySize in interface FwkCommandInterface
    
    Returns:
    The total number of registered objects.
  - hasActionListeners
```
public boolean hasActionListeners()
```
    Returns a boolean whether the command has action listeners.
    
    Specified by:
    
    hasActionListeners in interface FwkCommandInterface
    
    Returns:
    true if the command has action listeners.
  - hasMenuListeners
```
public boolean hasMenuListeners()
```
    Returns a boolean whether the command has menu listeners.
    
    Specified by:
    
    hasMenuListeners in interface FwkCommandInterface
    
    Returns:
    true if the command has menu listeners.
  - getActionListenerArray
```
public FwkArrayInterface getActionListenerArray()
```
    Get the action listener array of the command.
    
    Specified by:
    
    getActionListenerArray in interface FwkCommandInterface
    
    Returns:
    An array containing all action listeners of the command.
  - getMenuListenerArray
```
public FwkArrayInterface getMenuListenerArray()
```
    Get the menu listener array of the command.
    
    Specified by:
    
    getMenuListenerArray in interface FwkCommandInterface
    
    Returns:
    An array containing all menu listeners of the command.
  - addActionListener
```
public void addActionListener(java.awt.event.ActionListener actionListener)
```
    Add an action listener to the command. This method fires a property change event on the property AddActionListener. The old value object of the event is this the new value object is the added listener.
    
    Specified by:
    
    addActionListener in interface FwkCommandInterface
    
    Parameters:
    actionListener - The action listener to be added.
  - addMenuListener
```
public void addMenuListener(javax.swing.event.MenuListener menuListener)
```
    Add a menu listener to the command. This method fires a property change event on the property AddMenuListener. The old value object of the event is this the new value object is the added listener.
    
    Specified by:
    
    addMenuListener in interface FwkCommandInterface
    
    Parameters:
    menuListener - The menu listener to be added.
  - removeActionListener
```
public void removeActionListener(java.awt.event.ActionListener actionListener)
```
    Remove an action listener from the command. This method fires a property change event on the property RemoveActionListener. The new value object of the event is this the old value object is the removed listener.
    
    Specified by:
    
    removeActionListener in interface FwkCommandInterface
    
    Parameters:
    actionListener - The action listener to be removed.
  - removeMenuListener
```
public void removeMenuListener(javax.swing.event.MenuListener menuListener)
```
    Remove a menu listener from the command. This method fires a property change event on the property RemoveMenuListener. The new value object of the event is this the old value object is the removed listener.
    
    Specified by:
    
    removeMenuListener in interface FwkCommandInterface
    
    Parameters:
    menuListener - The menu listener to be removed.
  - execute
```
public boolean execute(java.util.EventObject ev)
```
    Execute the command. This method make sense only, if there is a listener registered that implements FwkCommandActionInterface.
    
    Specified by:
    
    execute in interface FwkCommandInterface
    
    Parameters:
    ev - The event that is the trigger of this command. May be null
    
    Returns:
    true if a listener was found that executes this command.
  - addCommand
```
public void addCommand(FwkCommandInterface command)
```
    Add the command to the command array.
    If the incoming command hasn't a controller it will be receive the controller of this object.
    
    Specified by:
    
    addCommand in interface FwkInstructionInterface
    
    Parameters:
    command - The command to be added.
  - addCommand
```
public void addCommand(int index,
              FwkCommandInterface command)
```
    Insert a command at the specified position. If the position is out of range. The method inserts the command at the beginning or appand it to existing array.
    
    Specified by:
    
    addCommand in interface FwkInstructionInterface
    
    Parameters:
    index - The position where the command has to be inserted.
    command - The command to be added.
  - getCommand
```
public FwkCommandInterface getCommand(java.lang.String command)
```
    Get a sub-command. This method looks for a command with belong to the given action command string.
    
    Specified by:
    
    getCommand in interface FwkInstructionInterface
    
    Parameters:
    command - The action command string.
    
    Returns:
    The found command or null.
  - getCommands
```
public FwkCommandInterface[] getCommands()
```
    Get the sub-commands of the command.
    
    Specified by:
    
    getCommands in interface FwkInstructionInterface
    
    Returns:
    An array containing the sub-commands.
  - removeCommand
```
public void removeCommand(FwkCommandInterface command)
```
    Remove a sub-command. This method fires a property change event on the property RemoveCommand. The new value object of the event is this the old value object is the removed sub-command.
    
    Specified by:
    
    removeCommand in interface FwkInstructionInterface
    
    Parameters:
    command - The sub-command to be removed.
  - setCommands
```
public void setCommands(FwkCommandInterface[] commands)
```
    Set the sub-commands of the command. All existing sub-commands will be removed.
    
    Specified by:
    
    setCommands in interface FwkInstructionInterface
    
    Parameters:
    commands - An array containing all sub-Commands.
    See Also:
    addCommand(FwkCommand command)
  - getProperty
```
public java.lang.Object getProperty(java.lang.String key)
```
    Get the property for the specified property keyword.
    
    Specified by:
    
    getProperty in interface FwkCommandInterface
    
    Parameters:
    key - The property keyword.
    
    Returns:
    the requested property.
  - getProperties
```
public java.util.Iterator getProperties()
```
    Get all keywords that define a property.
    
    Specified by:
    
    getProperties in interface FwkCommandInterface
    
    Returns:
    a string array containing all property keywords.
  - setProperty
```
public void setProperty(java.lang.String key,
               java.lang.Object value)
```
    Set a property for the specified property keyword.
    
    Specified by:
    
    setProperty in interface FwkCommandInterface
    
    Parameters:
    key - The property keyword.
    object - The property value.
  - commandsAvailable
```
public boolean commandsAvailable()
```
    This method returns a boolean that indicates whether the command array is initialized.
    
    Specified by:
    
    commandsAvailable in interface FwkInstructionInterface
    
    Returns:
    true if the command array is already initialized.
  - clearCommands
```
public void clearCommands()
```
    Clear all commands.
    
    Specified by:
    
    clearCommands in interface FwkInstructionInterface
  - addToGroup
```
public void addToGroup(int index,
              java.lang.String groupIdent,
              java.lang.String commandName)
```
    Add a command to a group.
    
    Specified by:
    
    addToGroup in interface FwkInstructionInterface
    
    Parameters:
    index - Index where the command should be placed.
    groupIdent - The string identified of the group.
    commandName - The name of the command.
  - addToGroup
```
public void addToGroup(java.lang.String groupIdent,
              java.lang.String commandName)
```
    Add a command to a group.
    
    Specified by:
    
    addToGroup in interface FwkInstructionInterface
    
    Parameters:
    groupIdent - The string identified of the group.
    commandName - The name of the command.
  - deleteGroup
```
public void deleteGroup(java.lang.String groupIdent)
```
    Delete command group.
    
    Specified by:
    
    deleteGroup in interface FwkInstructionInterface
    
    Parameters:
    groupIdent - The string identified of the group.
  - getGroup
```
public FwkCommandInterface[] getGroup(java.lang.String groupIdent)
```
    Retrieve the command group.
    
    Specified by:
    
    getGroup in interface FwkInstructionInterface
    
    Parameters:
    groupIdent - The string identified of the group.
    
    Returns:
    An array containing the group commands or null if empty.
  - groupExists
```
public boolean groupExists(java.lang.String groupIdent)
```
    Check whether a group exists.
    
    Specified by:
    
    groupExists in interface FwkInstructionInterface
    
    Returns:
    true if the group exists.
  - removeFromGroup
```
public void removeFromGroup(java.lang.String groupIdent,
                   java.lang.String commandName)
```
    Remove a command from a group.
    
    Specified by:
    
    removeFromGroup in interface FwkInstructionInterface
    
    Parameters:
    groupIdent - The string identified of the group.
    commandName - The name of the command.
  - toString
```
public java.lang.String toString()
```
    Return the string representation of the command.
    
    Overrides:
    
    toString in class FwkDescription
    
    Returns:
    The repesentation string.
  - setButtonClass
```
public void setButtonClass(java.lang.Class clazz)
```
    Set the button class.
    
    Specified by:
    
    setButtonClass in interface FwkCommandInterface
    
    Parameters:
    the - button class to be used when creating a button out of the command.
  - getButtonClass
```
public java.lang.Class getButtonClass()
```
    Get the button class.
    The return value may be null. In this case use the button you like.
    
    Specified by:
    
    getButtonClass in interface FwkCommandInterface
    
    Returns:
    the button class to be used when creating a button out of the command.
  - setMenuItemClass
```
public void setMenuItemClass(java.lang.Class clazz)
```
    Set the menu item class.
    
    Specified by:
    
    setMenuItemClass in interface FwkCommandInterface
    
    Parameters:
    the - menu item class to be used when creating a menu item out of the command.
  - getMenuItemClass
```
public java.lang.Class getMenuItemClass()
```
    Get the menu item class. The return value may be null. In this case use the menu item you like.
    
    Specified by:
    
    getMenuItemClass in interface FwkCommandInterface
    
    Returns:
    the menu item class to be used when creating a menu item out of the command.

Class FwkCommand

Field Summary

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

Fields inherited from class com.highqsoft.fwk.FwkDescription

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkCommandInterface

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

Constructor Summary

Method Summary

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

Methods inherited from class com.highqsoft.fwk.FwkDescription

Methods inherited from class com.highqsoft.fwk.Fwk

Methods inherited from class java.lang.Object

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

Field Detail

version

toolBarEnabled

menuEventEnabled

text

textKey

commandName

mnemonic

icon

iconKey

toolTipText

toolTipKey

visible

sensitive

separator

toggle

toggleState

radioGroupState

actionListeners

menuListeners

helpID

registry

instruction

buttonClass

menuItemClass

properties

Constructor Detail

FwkCommand

FwkCommand

FwkCommand

Method Detail

getVersion

getCommandName

getController

getHelpID

getIcon

getIconKey

getMnemonic

getRadioGroupState

getSensitivity

getSeparator

getText

getTextKey

getToggle

getToggleState

getToolTipKey

getToolTipText

getVisibility

setToolBarEnabled

getToolBarEnabled

isParent

setAsParent

setCommandName

setController

setHelpID

setIcon

setIconKey

setMenuEventEnabled

getMenuEventEnabled

menuSelect

setMnemonic

setRadioGroupState

setSensitivity

setSeparator

setText