FwkCommandInterface

All Superinterfaces:

FwkControlledByInterface, FwkInstructionInterface, FwkInterface, FwkPresentationInterface, FwkPropertyChangeInterface, java.io.Serializable

All Known Subinterfaces:

AsamCommanderFileMenuInterface, AsamCommanderMenuInterface, CommandContainerInterface, CommandInterface, MEDCalculatorInterface, OdsxApplElemChildrenSelectorInterface, OdsxApplElemCustomizerInterface, OdsxApplElemMenuInterface, OdsxFilterInterface, OdsxInstElemChildrenSelectorInterface, OdsxInstElemCustomizerInterface, OdsxInstElemMenuInterface, OdsxSelectorMultiItemMenuInterface, OdsxSessionCustomizerInterface, OdsxSessionMenuInterface, OdsxTextPresentorMenuInterface

All Known Implementing Classes:

AddNewInstanceElementCommand, ApplicationElementCustomizer, AsamCommanderCustomizeCommand, AsamCommanderCustomizePresentorsCommand, AsamCommanderCustomizeSelectorsCommand, AsamCommanderDisconnectCommand, AsamCommanderNameServiceCommand, Cmd, CmdClose, CmdConnect, CmdDescribe, CmdEcho, CmdExit, CmdHelp, CmdJournal, CmdList, CmdSelect, CmdSource, CommandContainer, DataManagerColumnDisplayCommand, DataManagerCommandContainer, DataManagerReadColumnsCommand, DataManagerRevokeCommand, DataManagerWriteColumnsCommand, Externalrefs, FwkAboutCommand, FwkColorCommand, FwkColorSelectCommand, FwkColumnDisplayCommand, FwkCommand, 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, MEDCut, MEDDataGenerators, MEDDataManipulators, MEDLayouterCommand, MEDLevelCut, MEDLinearOffset, MEDMarkerCrosshair, MEDMarkerDelete, MEDMarkerGenerator, MEDMarkerGenerators, MEDMarkerThreshold, MEDMouseBehaviorAdapter, MEDMouseBehaviors, MEDMousePointer, MEDMousePointers, MEDPickComponents, MEDPlotControlCommand, MEDPlotControls, MEDScale, MEDSelectColumnCommand, MEDSmooth, MEDZoomCrosshair, MoMaXCommand, OdsGraph, OdsxAppendToMeasurementCommand, OdsxApplElemDefaultChildrenSelector, OdsxATFFilterCommand, OdsxBaseElementFilterCommand, OdsxCheckModelCommand, OdsxCloseSessionCommand, OdsxCopyInstanceCommand, OdsxCreateMeasurementCommand, OdsxDebugLevelEditorCommand, OdsxDeleteInstanceCommand, OdsxDumpMeasurementCommand, OdsxEnablePresentableCommand, OdsxFactoryCommand, OdsxFilter, OdsxFilterEditorCommand, OdsxInstanceCreateCommand, OdsxInstanceEditCommand, OdsxInstElemDefaultChildrenSelector, OdsxInstElemDefaultMenu, OdsxLayouterCommand, OdsxPublicValueMatrixCommand, OdsxSelectorPanel.DeleteMultiInstanceCommand, OdsxSelectorPanel.UpdateTreeCommand, OdsxSetContextCommand, OdsxTranslatePresentableCommand, OdsxUnpublicValueMatrixCommand, OdsxVisiblePresentableCommand, P2DBasicStrokeSelectCommand, P2DColumnDisplayCommand, P2DConfigComponentsCommand, P2DMarkerColorCommand, P2DMarkerDeleteCommand, P2DMarkerNameCommand, P2DMarkerRangeCommand, P2DMarkerStatisticsCommand, P2DMarkerZoomCommand, P2DPrintCanvasCommand, P2DRangeCommand, P2DShapeStrokeSelectCommand, P2DStrokeWidthSelectCommand, P2DTest.GCCommand, P2DUnselectCommand, SessionCustomizer
```
public interface FwkCommandInterface
extends FwkInstructionInterface, FwkControlledByInterface, FwkPropertyChangeInterface
```
The FwkCommandInterface interface defines the basic methods for a command component.

Since:

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

Version:

$Revision: 1.13 $

Author:

HighQSoft GmbH

See Also:

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CONTROLLER_PROPERTY` The property constant for the controller.
`static int`	`MENU_REASON_CANCELED` The reason constant if a menu was canceled.
`static int`	`MENU_REASON_DESELECTED` The reason constant if a menu was deselected.
`static int`	`MENU_REASON_SELECTED` The reason constant if a menu was selected.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addActionListener(java.awt.event.ActionListener actionListener)` Add an action listener to the command.
`void`	`addMenuListener(javax.swing.event.MenuListener menuListener)` Add a menu listener to the command.
`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.
`java.lang.String`	`getCommandName()` Get the command string.
`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 a toolbar command.
`java.lang.String`	`getToolTipKey()` Get the command tooltip key.
`java.lang.String`	`getToolTipText()` Get the command tooltip text.
`boolean`	`getVisibility()` Gets the visiblity.
`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 component.
`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`	`removeMenuListener(javax.swing.event.MenuListener menuListener)` Remove a menu listener from the command.
`void`	`setAsParent()` Set the FWK command to be a parent.
`void`	`setButtonClass(java.lang.Class clazz)` Set the button class.
`void`	`setCommandName(java.lang.String commandName)` Set the command string.
`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 property keyword of the icon.
`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)` Sets a boolean to make the command a toolbar 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.
`void`	`unregister(java.lang.Object obj)` Unregister the object.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface
addCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getCommands, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

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

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControlledByInterface
getController, setController

- Field Detail
  - CONTROLLER_PROPERTY
```
static final java.lang.String CONTROLLER_PROPERTY
```
    The property constant for the controller.
    
    See Also:
    Constant Field Values
  - MENU_REASON_CANCELED
```
static final int MENU_REASON_CANCELED
```
    The reason constant if a menu was canceled.
    
    See Also:
    Constant Field Values
  - MENU_REASON_DESELECTED
```
static final int MENU_REASON_DESELECTED
```
    The reason constant if a menu was deselected.
    
    See Also:
    Constant Field Values
  - MENU_REASON_SELECTED
```
static final int MENU_REASON_SELECTED
```
    The reason constant if a menu was selected.
    
    See Also:
    Constant Field Values
- Method Detail
  - setText
```
void setText(java.lang.String text)
```
    Set the command text.
    
    Parameters:
    Text - The new text of the command.
    See Also:
    getText(), setTextKey(String)
  - getText
```
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.
    
    Returns:
    The command text.
    See Also:
    setText(String), getTextKey()
  - setTextKey
```
void setTextKey(java.lang.String textKey)
```
    Set the command text key to get the properties.
    
    Parameters:
    textKey - The new text key of the command.
    See Also:
    getTextKey(), getText()
  - getTextKey
```
java.lang.String getTextKey()
```
    Get the command text key.
    
    Returns:
    The command text key.
    See Also:
    setTextKey(String), getText()
  - setCommandName
```
void setCommandName(java.lang.String commandName)
```
    Set the command string.
    
    Parameters:
    commandName - The new command string (name) of the command.
    See Also:
    #getCommand()
  - getCommandName
```
java.lang.String getCommandName()
```
    Get the command string. 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.
    
    Returns:
    The command string.
    See Also:
    #setCommand(String)
  - setMnemonic
```
void setMnemonic(int mnemonic)
```
    Set the mnemonic of the command. This method fires a PropertyChangeEvent on property Mnemonic.
    
    Parameters:
    mnemonic - The new mnemonic of the command.
    See Also:
    getMnemonic()
  - getProperty
```
java.lang.Object getProperty(java.lang.String key)
```
    Get the property for the specified property keyword.
    
    Parameters:
    key - The property keyword.
    
    Returns:
    the requested property.
  - getProperties
```
java.util.Iterator getProperties()
```
    Get all keywords that define a property.
    
    Returns:
    an iterator containing all property keywords.
  - getMnemonic
```
int getMnemonic()
```
    Get the mnemonic of the command.
    
    Returns:
    the mnemonic of the command.
  - setHelpID
```
void setHelpID(java.lang.String helpID)
```
    Set the command help ID. This method fires a PropertyChangeEvent on property HelpID.
    
    Parameters:
    helpID - The new helpID of the command.
    See Also:
    getHelpID()
  - getHelpID
```
java.lang.String getHelpID()
```
    Get the help id. If there isn't a HelpID defined the method return null.
    
    Returns:
    The help id.
    See Also:
    setHelpID(String)
  - setIconKey
```
void setIconKey(java.lang.String iconKey)
```
    Set the property keyword of the icon.
    
    Parameters:
    iconKey - The new property keyword of the icon.
    See Also:
    getIconKey()
  - getIconKey
```
java.lang.String getIconKey()
```
    Get the icon property keyword.
    
    Returns:
    The property keyword of the icon.
    See Also:
    setIconKey(String)
  - setIcon
```
void setIcon(FwkIconInterface icon)
```
    Set the icon image of the command.
    
    Parameters:
    image - The new icon of the command.
    See Also:
    #getIconImage(), #setIconURL(String)
  - getIcon
```
FwkIconInterface getIcon()
```
    Get the icon image of the command. If there is no image it tries to read the icon URL to get the image.
    
    Returns:
    The icon image of the command.
    See Also:
    #setIconImage(Image), #getIconURL()
  - setMenuEventEnabled
```
void setMenuEventEnabled(boolean flag)
```
    Set the menu event enabled flag.
    
    Parameters:
    flag - if true the menu events are enabled.
  - getMenuEventEnabled
```
boolean getMenuEventEnabled()
```
    Get the menu event enabled flag.
    
    Returns:
    true the menu events are enabled.
  - menuSelect
```
boolean menuSelect(javax.swing.event.MenuEvent event,
                 int reason)
```
    The callback for menuevents.
    
    Parameters:
    event - The menuevent
    reason - The reson. Use predefined constants above.
  - setProperty
```
void setProperty(java.lang.String key,
               java.lang.Object value)
```
    Set a property for the specified property keyword.
    
    Parameters:
    key - The property keyword.
    object - The property value.
  - setToolTipText
```
void setToolTipText(java.lang.String toolTipText)
```
    Set the command tooltip text.
    
    Parameters:
    toolTipText - The new tooltip text of the command.
    See Also:
    getToolTipText(), getToolTipKey()
  - getToolTipText
```
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.
    
    Returns:
    The command tooltip text.
    See Also:
    setToolTipText(String), getToolTipKey()
  - setToolTipKey
```
void setToolTipKey(java.lang.String toolTipKey)
```
    Set the command tooltip key to get the properties.
    
    Parameters:
    toolTipKey - The new tooltip key of the command.
    See Also:
    getToolTipKey(), getToolTipText()
  - getToolTipKey
```
java.lang.String getToolTipKey()
```
    Get the command tooltip key.
    
    Returns:
    The command tooltip key.
    See Also:
    setToolTipKey(String), getToolTipText()
  - getVisibility
```
boolean getVisibility()
```
    Gets the visiblity.
    
    Returns:
    A boolean idicates wether the command is visible.
    See Also:
    setVisibility(boolean)
  - setVisibility
```
void setVisibility(boolean flag)
```
    Sets the visibility of the command.
    
    Parameters:
    flag - true if visible.
    See Also:
    getVisibility()
  - getSensitivity
```
boolean getSensitivity()
```
    Gets the sensitivity.
    
    Returns:
    A boolean indicates wether the command is sensitive.
    See Also:
    setSensitivity(boolean)
  - setSensitivity
```
void setSensitivity(boolean flag)
```
    Sets the sensitivity of the command.
    
    Parameters:
    flag - true if sensitive.
    See Also:
    getSensitivity()
  - getSeparator
```
boolean getSeparator()
```
    Gets the separator flag.
    
    Returns:
    A boolean indicates wether the command is a separator.
    See Also:
    setSeparator(boolean)
  - setSeparator
```
void setSeparator(boolean flag)
```
    Sets the command as separator.
    
    Parameters:
    flag - true if separator.
    See Also:
    getSeparator()
  - getToggle
```
boolean getToggle()
```
    Gets the toggle flag.
    
    Returns:
    A boolean indicates wether the command is a toggle.
    See Also:
    setToggle(boolean)
  - setToggle
```
void setToggle(boolean flag)
```
    Sets the command as toggle.
    
    Parameters:
    flag - true if command is a toggle.
    See Also:
    getToggle()
  - getToggleState
```
boolean getToggleState()
```
    Gets the toggle state.
    
    Returns:
    A boolean represent the toggle state.
    See Also:
    setToggleState(boolean)
  - setToggleState
```
void setToggleState(boolean flag)
```
    Sets the command toggle state. If the toggle flag is not set, this property makes no sense.
    
    Parameters:
    flag - true if command is a toggle.
    See Also:
    getToggle()
  - getRadioGroupState
```
boolean getRadioGroupState()
```
    Gets the radio group state. That state indicates whether the command is a parent of an radio group.
    
    Returns:
    A boolean represent the radio group state.
    See Also:
    setRadioGroupState(boolean)
  - setRadioGroupState
```
void setRadioGroupState(boolean flag)
```
    Sets the radio group state.
    
    Parameters:
    flag - true if command is a toggle.
    See Also:
    getRadioGroupState()
  - setToolBarEnabled
```
void setToolBarEnabled(boolean flag)
```
    Sets a boolean to make the command a toolbar command. The command is automatically enabled for toolbar if it holds an icon.
    
    Parameters:
    true - If the command should be enabled for the toolbar.
  - getToolBarEnabled
```
boolean getToolBarEnabled()
```
    Returns a boolean whether the command is a toolbar command.
    
    Returns:
    true if the command is a toolbar command.
  - setAsParent
```
void setAsParent()
```
    Set the FWK command to be a parent.
  - isParent
```
boolean isParent()
```
    Returns a boolean whether the command has children.
    
    Returns:
    true if the command has children.
  - hasActionListeners
```
boolean hasActionListeners()
```
    Returns a boolean whether the command has action listeners.
    
    Returns:
    true if the command has action listeners.
  - hasMenuListeners
```
boolean hasMenuListeners()
```
    Returns a boolean whether the command has menu listeners.
    
    Returns:
    true if the command has menu listeners.
  - register
```
void register(java.lang.Object obj)
```
    Register the object at the command component.
    
    Parameters:
    obj - The object to be stored.
  - unregister
```
void unregister(java.lang.Object obj)
```
    Unregister the object.
    
    Parameters:
    obj - The object to be unregistered,
  - registrySize
```
int registrySize()
```
    Return the total number of registered objects.
    
    Returns:
    The total number of registered objects.
  - registeredObjects
```
java.util.Enumeration registeredObjects()
```
    Retrieves the enumeration of registered objects.
    
    Returns:
    An object enumeration
  - getActionListenerArray
```
FwkArrayInterface getActionListenerArray()
```
    Get the action listener array of the command.
    
    Returns:
    An array containing all action listeners of the command.
  - getMenuListenerArray
```
FwkArrayInterface getMenuListenerArray()
```
    Get the menu listener array of the command.
    
    Returns:
    An array containing all menu listeners of the command.
  - addActionListener
```
void addActionListener(java.awt.event.ActionListener actionListener)
```
    Add an action listener to the command.
    
    Parameters:
    actionListener - The action listener to be added.
  - addMenuListener
```
void addMenuListener(javax.swing.event.MenuListener menuListener)
```
    Add a menu listener to the command.
    
    Parameters:
    menuListener - The menu listener to be added.
  - removeActionListener
```
void removeActionListener(java.awt.event.ActionListener actionListener)
```
    Remove an action listener from the command.
    
    Parameters:
    actionListener - The action listener to be removed.
  - removeMenuListener
```
void removeMenuListener(javax.swing.event.MenuListener menuListener)
```
    Remove a menu listener from the command.
    
    Parameters:
    menuListener - The menu listener to be removed.
  - execute
```
boolean execute(java.util.EventObject ev)
```
    Execute the command. This method make sense only, if there is a listener registered that implements FwkCommandActionInterface.
    
    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.
  - setButtonClass
```
void setButtonClass(java.lang.Class clazz)
```
    Set the button class.
    
    Parameters:
    the - button class to be used when creating a button out of the command.
  - getButtonClass
```
java.lang.Class getButtonClass()
```
    Get the button class.
    
    Returns:
    the button class to be used when creating a button out of the command.
  - setMenuItemClass
```
void setMenuItemClass(java.lang.Class clazz)
```
    Set the menu item class.
    
    Parameters:
    the - menu item class to be used when creating a menu item out of the command.
  - getMenuItemClass
```
java.lang.Class getMenuItemClass()
```
    Get the menu item class.
    
    Returns:
    the menu item class to be used when creating a menu item out of the command.

Interface FwkCommandInterface

Field Summary

Method Summary

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

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.FwkControlledByInterface

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

Field Detail

CONTROLLER_PROPERTY

MENU_REASON_CANCELED

MENU_REASON_DESELECTED

MENU_REASON_SELECTED

Method Detail

setText

getText

setTextKey

getTextKey

setCommandName

getCommandName

setMnemonic

getProperty

getProperties

getMnemonic

setHelpID

getHelpID

setIconKey

getIconKey

setIcon

getIcon

setMenuEventEnabled

getMenuEventEnabled

menuSelect

setProperty

setToolTipText

getToolTipText

setToolTipKey

getToolTipKey

getVisibility

setVisibility

getSensitivity

setSensitivity

getSeparator

setSeparator

getToggle

setToggle

getToggleState

setToggleState

getRadioGroupState

setRadioGroupState

setToolBarEnabled

getToolBarEnabled

setAsParent

isParent

hasActionListeners

hasMenuListeners

register

unregister

registrySize

registeredObjects

getActionListenerArray

getMenuListenerArray

addActionListener

addMenuListener

removeActionListener

removeMenuListener

execute

setButtonClass

getButtonClass

setMenuItemClass

getMenuItemClass