com.highqsoft.odsx.hql

Class Cmd

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkPropertyChange

com.highqsoft.fwk.FwkPersistence

com.highqsoft.fwk.FwkItem

com.highqsoft.fwk.FwkInfoBusMember

com.highqsoft.fwk.FwkMimeType

com.highqsoft.fwk.FwkInfoBusConsumer

com.highqsoft.odsx.hql.Cmd

All Implemented Interfaces:

FwkCommandInterface, FwkCompareInterface, FwkControlledByInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInfoBusConsumerInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkMimeTypeInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, CommandInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, java.util.EventListener, javax.infobus.DataItem, javax.infobus.InfoBusDataConsumer, javax.infobus.InfoBusEventListener, javax.infobus.InfoBusMember

Direct Known Subclasses:

CmdClose, CmdConnect, CmdDescribe, CmdEcho, CmdExit, CmdHelp, CmdJournal, CmdList, CmdSelect, CmdSource

public class Cmd
extends FwkInfoBusConsumer
implements CommandInterface

The basic command implementation.

Author:

Andreas Hofmann $Revision: 1.13 $ $Date: 2017/04/06 13:29:54 $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	APPEND_ERR
static int	APPEND_OUT
protected java.lang.String	commandString The source command string.
protected static int	counter
protected FwkCommand	fwkCommand The command decorator.
protected HQL	hql The HQL interpreter.
protected FwkPropertyGroup	keys The property group containing all option key value pairs.
static int	OPEN_ERR
static int	OPEN_OUT
protected java.lang.String[]	params The array containing all parameters.
protected OdsxResultSetInterface	result The result of the command.
protected int	streamOpened
protected long	timeNeeded The elapsed time to execute the command.
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkMimeType

FWKMIMETYPE

Fields inherited from class com.highqsoft.fwk.FwkInfoBusMember

infoBusMemberSupport

Fields inherited from class com.highqsoft.fwk.FwkItem

changeManager, properties, suspendChangeManager

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, ICON, iconCount, iconKey, 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.FwkInfoBusConsumerInterface

BUSNAME

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

INFOBUS_SOURCE

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
Cmd() The default constructor.
Cmd(FwkControllerInterface controller) The constructor receiving an infobus controller.

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.
java.lang.String	commandString() Get the command string.
boolean	execute() Execute 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.
OdsxResultSetInterface	getResult() Get the result columns of the command.
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.
java.lang.String	getVersion() Get the version of the HQL implementation.
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	initializeExecution() Initialize execution.
boolean	isParent() Returns a boolean whether the command has children.
boolean	menuSelect(javax.swing.event.MenuEvent event, int reason) The callback for menuevents.
boolean	parseParams(java.lang.String pString) Set the parameter string to the command.
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	release() Release the command object.
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	setInterpreter(HQL hql) Set the interpreter.
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	terminateExecution() Terminate execution.
long	timeNeeded() Get the time in milli seconds needed by execution.
void	unregister(java.lang.Object obj) Unregister the object.

Methods inherited from class com.highqsoft.fwk.FwkInfoBusConsumer

dataItemAvailable, dataItemRevoked, finalize, findDataItem, findDataItem, findMultipleDataItems, findMultipleDataItems, getController, initialize, isAssignable, propertyChange, register, setController, setInfoBusName, unregister

Methods inherited from class com.highqsoft.fwk.FwkMimeType

addMimeType, getDataFlavor, getDataFlavors, getMimeTypes, removeMimeType

Methods inherited from class com.highqsoft.fwk.FwkInfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, getInfoBusName, getMemberName, isConnected, joinInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus, setMemberName, setName

Methods inherited from class com.highqsoft.fwk.FwkItem

addDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getPropertyGroup, getSource, isChangeManagerSuspended, removeDataItemChangeListener, setPropertyGroup, suspendChangeManager

Methods inherited from class com.highqsoft.fwk.FwkPersistence

addCommand, addCommand, addToGroup, addToGroup, addVetoableChangeListener, addVetoableChangeListener, clearCommands, commandsAvailable, compareTo, deleteGroup, destroyController, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getAuthor, getBuild, getCommand, getCommands, getCommands, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getFwkMimeTypes, getGroup, getIcon, getIconKey, getPersistentObjectNames, getSupportEMail, getTitle, getTitleName, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, groupExists, removeCommand, removeFromGroup, removeVetoableChangeListener, removeVetoableChangeListener, setAuthor, setBuild, setCommands, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setDateFormatString, setDescription, setDescriptor, setDescriptor, setIcon, setIconKey, setSource, setSupportEMail, setTitleName

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, suspendPropertyChangeEvents

Methods inherited from class com.highqsoft.fwk.FwkDescription

getClassName, getPresentationString, getPresentationString, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setClassName, setCreationDate, toString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getController, setController

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

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

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

addMimeType, getDataFlavor, getDataFlavors, getMimeTypes, removeMimeType

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

getInfoBusName, getMemberName, isConnected, setMemberName

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

fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getPropertyGroup, setPropertyGroup, suspendChangeManager

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

getCommands, getPersistentObjectNames

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

destroyController

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

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, removeVetoableChangeListener, removeVetoableChangeListener

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

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface javax.infobus.DataItem

getSource

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

fwkCommand

protected FwkCommand fwkCommand

The command decorator.

params

protected java.lang.String[] params

The array containing all parameters.

keys

protected FwkPropertyGroup keys

The property group containing all option key value pairs.

commandString

protected java.lang.String commandString

The source command string.

timeNeeded

protected long timeNeeded

The elapsed time to execute the command.

result

protected OdsxResultSetInterface result

The result of the command.

See Also:

OdsxResultSetInterface

hql

protected HQL hql

The HQL interpreter.

streamOpened

protected int streamOpened

OPEN_OUT

public static final int OPEN_OUT

See Also:

Constant Field Values

OPEN_ERR

public static final int OPEN_ERR

See Also:

Constant Field Values

APPEND_OUT

public static final int APPEND_OUT

See Also:

Constant Field Values

APPEND_ERR

public static final int APPEND_ERR

See Also:

Constant Field Values

counter

protected static int counter

Constructor Detail

Cmd

public Cmd()

The default constructor.

Cmd

public Cmd(FwkControllerInterface controller)

The constructor receiving an infobus controller.

Parameters:

controller - the infobus controller.

Method Detail

getVersion

public java.lang.String getVersion()

Get the version of the HQL implementation.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkMimeType

Returns:

the version string.

parseParams

public boolean parseParams(java.lang.String pString)

Set the parameter string to the command.

Specified by:

parseParams in interface CommandInterface

Parameters:

pString - the string containing the whole interpreter string expect the command name.

Returns:

true if successful.

commandString

public java.lang.String commandString()

Get the command string.

Specified by:

commandString in interface CommandInterface

Returns:

the command string.

release

public void release()

Release the command object.

Specified by:

release in interface FwkInterface

Specified by:

release in interface javax.infobus.DataItem

Overrides:

release in class FwkInfoBusConsumer

setInterpreter

public void setInterpreter(HQL hql)

Set the interpreter.

Specified by:

setInterpreter in interface CommandInterface

Parameters:

hql - the HQL interpreter.

execute

public boolean execute()

Execute the command.

Specified by:

execute in interface CommandInterface

Returns:

true if successful.

initializeExecution

public boolean initializeExecution()

Initialize execution. This is currently needed to initialize the time measurement only.

Specified by:

initializeExecution in interface CommandInterface

Returns:

true if the command was already executed.

terminateExecution

public void terminateExecution()

Terminate execution. This is currently used to terminate the time measurement only.

Specified by:

terminateExecution in interface CommandInterface

timeNeeded

public long timeNeeded()

Get the time in milli seconds needed by execution.

Specified by:

timeNeeded in interface CommandInterface

Returns:

the elapsed time.

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 object. (currently not used)

Returns:

true if a listener was found that executes this command.

setText

public void setText(java.lang.String text)

Set the command text.

Specified by:

setText in interface FwkCommandInterface

Parameters:

text - The new text of the command.

See Also:

getText(), setTextKey(String)

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()

setTextKey

public void setTextKey(java.lang.String textKey)

Set the command text key to get the properties.

Specified by:

setTextKey in interface FwkCommandInterface

Parameters:

textKey - The new text key of the command.

See Also:

getTextKey(), getText()

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()

setCommandName

public void setCommandName(java.lang.String commandName)

Set the command string.

Specified by:

setCommandName in interface FwkCommandInterface

Parameters:

commandName - The new command string (name) of the command.

See Also:

#getCommand()

getCommandName

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

Specified by:

getCommandName in interface FwkCommandInterface

Returns:

The command string.

See Also:

#setCommand(String)

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()

getProperty

public java.lang.Object getProperty(java.lang.String key)

Get the property for the specified property keyword.

Specified by:

getProperty in interface FwkCommandInterface

Specified by:

getProperty in interface FwkItemInterface

Specified by:

getProperty in interface javax.infobus.DataItem

Overrides:

getProperty in class FwkItem

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:

an iterator containing all property keywords.

getMnemonic

public int getMnemonic()

Get the mnemonic of the command.

Specified by:

getMnemonic in interface FwkCommandInterface

Returns:

the mnemonic of the command.

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()

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)

setIconKey

public void setIconKey(java.lang.String iconKey)

Set the property keyword of the icon.

Specified by:

setIconKey in interface FwkCommandInterface

Specified by:

setIconKey in interface FwkDescriptionInterface

Overrides:

setIconKey in class FwkPersistence

Parameters:

iconKey - The new property keyword of the icon.

See Also:

getIconKey()

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 FwkPersistence

Returns:

The property keyword of the icon.

See Also:

setIconKey(String)

setIcon

public void setIcon(FwkIconInterface icon)

Set the icon image of the command.

Specified by:

setIcon in interface FwkCommandInterface

Specified by:

setIcon in interface FwkDescriptionInterface

Overrides:

setIcon in class FwkPersistence

Parameters:

icon - The new icon of the command.

See Also:

#getIconImage(), #setIconURL(String)

getIcon

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

Specified by:

getIcon in interface FwkCommandInterface

Specified by:

getIcon in interface FwkDescriptionInterface

Overrides:

getIcon in class FwkPersistence

Returns:

The icon image of the command.

See Also:

#setIconImage(Image), #getIconURL()

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.

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

Specified by:

setProperty in interface FwkItemInterface

Overrides:

setProperty in class FwkItem

Parameters:

key - The property keyword.

value - The property value.

setToolTipText

public void setToolTipText(java.lang.String toolTipText)

Set the command tooltip text.

Specified by:

setToolTipText in interface FwkCommandInterface

Parameters:

toolTipText - The new tooltip text of the command.

See Also:

getToolTipText(), getToolTipKey()

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()

setToolTipKey

public void setToolTipKey(java.lang.String toolTipKey)

Set the command tooltip key to get the properties.

Specified by:

setToolTipKey in interface FwkCommandInterface

Parameters:

toolTipKey - The new tooltip key of the command.

See Also:

getToolTipKey(), getToolTipText()

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()

getVisibility

public boolean getVisibility()

Gets the visiblity.

Specified by:

getVisibility in interface FwkCommandInterface

Returns:

A boolean idicates wether the command is visible.

See Also:

setVisibility(boolean)

setVisibility

public void setVisibility(boolean flag)

Sets the visibility of the command.

Specified by:

setVisibility in interface FwkCommandInterface

Parameters:

flag - true if visible.

See Also:

getVisibility()

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)

setSensitivity

public void setSensitivity(boolean flag)

Sets the sensitivity of the command.

Specified by:

setSensitivity in interface FwkCommandInterface

Parameters:

flag - true if sensitive.

See Also:

getSensitivity()

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)

setSeparator

public void setSeparator(boolean flag)

Sets the command as separator.

Specified by:

setSeparator in interface FwkCommandInterface

Parameters:

flag - true if separator.

See Also:

getSeparator()

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)

setToggle

public void setToggle(boolean flag)

Sets the command as toggle.

Specified by:

setToggle in interface FwkCommandInterface

Parameters:

flag - true if command is a toggle.

See Also:

getToggle()

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)

setToggleState

public void setToggleState(boolean flag)

Sets the command toggle state. If the toggle flag is not set, this property makes no sense.

Specified by:

setToggleState in interface FwkCommandInterface

Parameters:

flag - true if command is a toggle.

See Also:

getToggle()

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)

setRadioGroupState

public void setRadioGroupState(boolean flag)

Sets the radio group state.

Specified by:

setRadioGroupState in interface FwkCommandInterface

Parameters:

flag - true if command is a toggle.

See Also:

getRadioGroupState()

setToolBarEnabled

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

Specified by:

setToolBarEnabled in interface FwkCommandInterface

Parameters:

flag - true If the command should be enabled for the toolbar.

getToolBarEnabled

public boolean getToolBarEnabled()

Returns a boolean whether the command is a toolbar command.

Specified by:

getToolBarEnabled in interface FwkCommandInterface

Returns:

true if the command is a toolbar command.

setAsParent

public void setAsParent()

Set the FWK command to be a parent.

Specified by:

setAsParent in interface FwkCommandInterface

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.

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.

register

public void register(java.lang.Object obj)

Register the object at the command component.

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,

registrySize

public int registrySize()

Return the total number of registered objects.

Specified by:

registrySize in interface FwkCommandInterface

Returns:

The total number of registered objects.

registeredObjects

public java.util.Enumeration registeredObjects()

Retrieves the enumeration of registered objects.

Specified by:

registeredObjects in interface FwkCommandInterface

Returns:

An object enumeration

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.

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.

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.

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.

Specified by:

removeMenuListener in interface FwkCommandInterface

Parameters:

menuListener - The menu listener to be removed.

setButtonClass

public void setButtonClass(java.lang.Class clazz)

Set the button class.

Specified by:

setButtonClass in interface FwkCommandInterface

Parameters:

clazz - the button class to be used when creating a button out of the command.

getButtonClass

public java.lang.Class getButtonClass()

Get the button class.

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:

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

Specified by:

getMenuItemClass in interface FwkCommandInterface

Returns:

the menu item class to be used when creating a menu item out of the command.

getResult

public OdsxResultSetInterface getResult()

Get the result columns of the command.

Specified by:

getResult in interface CommandInterface

Returns:

the result columns.