com.highqsoft.interfaces.fwk

Interface FwkInstructionInterface

All Superinterfaces:

FwkInterface, FwkPresentationInterface, java.io.Serializable

All Known Subinterfaces:

AsamCommanderFileMenuInterface, AsamCommanderMenuInterface, CommandContainerInterface, CommandInterface, FwkAliasInterface, FwkApplicationConsumerInterface, FwkApplicationInterface, FwkApplicationProducerInterface, FwkCommandInterface, FwkFFTItemInterface, FwkHelpBrokerInterface, FwkInfoBusConsumerInterface, FwkInfoBusControllerInterface, FwkInfoBusDropProducerInterface, FwkInfoBusMemberInterface, FwkInfoBusProducerInterface, FwkIOInterface, FwkItemInterface, FwkMimeTypeInterface, FwkPanelInterface, FwkPersistenceInterface, FwkPortInterface, FwkPortLimitInterface, FwkPrintableInterface, FwkPSDItemInterface, FwkRainflowItemInterface, FwkServiceControlManagerInterface, MEDCalculatorInterface, MEDInterface, OdsxApplElemChildrenSelectorInterface, OdsxApplElemCustomizerInterface, OdsxApplElemMenuInterface, OdsxApplicationElementInterface, OdsxColumnInterface, OdsxFilterInterface, OdsxInstanceElementInterface, OdsxInstElemChildrenSelectorInterface, OdsxInstElemCustomizerInterface, OdsxInstElemMenuInterface, OdsxPathInterface, OdsxPresentableElementConsumerInterface, OdsxPresentableElementInterface, OdsxPresentableElementProducerInterface, OdsxPresentorInterface, OdsxPresentorPanelInterface, OdsxResultSetInterface, OdsxSelectorInterface, OdsxSelectorMultiItemMenuInterface, OdsxSelectorPanelInterface, OdsxSelectorTreeNodeInterface, OdsxSessionCustomizerInterface, OdsxSessionElementInterface, OdsxSessionMenuInterface, OdsxSessionProducerInterface, OdsxTextPresentorMenuInterface, P2DAxisInterface, P2DAxisModelInterface, P2DCanvasInterface, P2DChannelInterface, P2DChannelModelInterface, P2DComponentInterface, P2DComponentModelInterface, P2DContainerInterface, P2DImageInterface, P2DImageModelInterface, P2DLayouterInterface, P2DLayoutInterface, P2DLayoutModelInterface, P2DLegendInterface, P2DLegendModelInterface, P2DMarkerGroupInterface, P2DMarkerInterface, P2DMarkerModelInterface, P2DModelInterface, P2DPlotInterface, P2DPlotModelInterface, P2DRainViewInterface, P2DRainViewModelInterface, P2DShapeInterface, P2DShapeModelInterface, P2DTextInterface, P2DTextModelInterface

All Known Implementing Classes:

AddNewInstanceElementCommand, ApplicationElementCustomizer, AsamCommander, AsamCommanderController, AsamCommanderCustomizeCommand, AsamCommanderCustomizePresentorsCommand, AsamCommanderCustomizeSelectorsCommand, AsamCommanderDisconnectCommand, AsamCommanderInstanceSelectorPane, AsamCommanderInstanceSelectorPane.OdsxItemConsumer, AsamCommanderNameServiceCommand, AsamCommanderOdsSessionConsumer, AsamCommanderPanel, BusMonitor, BusMonitorPanel, Cmd, CmdClose, CmdConnect, CmdDescribe, CmdEcho, CmdExit, CmdHelp, CmdJournal, CmdList, CmdSelect, CmdSource, ColumnDisplay, ColumnDisplay.ColumnConsumer, ColumnDisplay.LayouterConsumer, ColumnDisplayPanel, ColumnDisplayPanel.TextModel, ColumnEditor, CommandContainer, DataManager, DataManagerColumnDisplayCommand, DataManagerCommandContainer, DataManagerPanel, DataManagerReadColumnsCommand, DataManagerRevokeCommand, DataManagerWriteColumnsCommand, Externalrefs, FileConsumer, FwkAboutCommand, FwkAlias, FwkAliasConsumer, FwkAliasProducer, FwkApplication, FwkApplicationConsumer, FwkApplicationProducer, FwkAuthenticationDialogPane, FwkChangePasswordDialogPane, FwkColorCommand, FwkColorDialogPane, FwkColorSelectCommand, FwkColumnAccess, FwkColumnAccess.FwkSubColumnAccess, FwkColumnAccessGroup, FwkColumnAccessProducer, FwkColumnAccessProducer.DropColumnAccess, FwkColumnAccessProducer.TestDataItem, FwkColumnDisplayCommand, FwkCommand, FwkComponentSelectCommand, FwkComponentStartCommand, FwkConfigServiceCommand, FwkCopyToClipboardCommand, FwkDataItemConsumer, FwkDesktopApplication, FwkDialogPane, FwkDumpToXMLCommand, FwkEnvironmentPropertyProducer, FwkExecCommand, FwkExitCommand, FwkFileChooserDialogPane, FwkFileDialogPane, FwkFontCommand, FwkFontDialogPane, FwkGCCommand, FwkHelp, FwkHelpBroker, FwkHelpNextCommand, FwkHelpPrevCommand, FwkInfoBusConsumer, FwkInfoBusConsumerFactory, FwkInfoBusController, FwkInfoBusControllerFactory, FwkInfoBusDataAccess, FwkInfoBusDialogPane, FwkInfoBusImmediateAccess, FwkInfoBusImmediateAccess.ElementConsumer, FwkInfoBusItemList.ItemListConsumer, FwkInfoBusMember, FwkInfoBusPortFactory, FwkInfoBusProducer, FwkInfoBusProducerFactory, FwkInstruction, FwkIO, FwkItem, FwkItemRevokeCommand, FwkListDialogPane, FwkLoadFromXMLCommand, FwkMethodCommand, FwkMimeType, FwkOutputStreamApplication, FwkPageFormatCommand, FwkPanel, FwkPersistence, FwkPort, FwkPrintCommand, FwkPropertyConsumer, FwkPropertyEditorDialogPane, FwkPropertyProducer, FwkServiceControlManager, FwkServiceControlManagerPanel, FwkServiceInterrogateCommand, FwkServicePauseCommand, FwkServiceStartCommand, FwkServiceStopCommand, FwkStringSaveAsCommand, FwkSystemInfoCommand, FwkSystemPropertyProducer, FwkTextDialogPane, FwkTextEditorCommand, FwkTextFieldDialogPane, FwkTextFieldEditorCommand, FwkToggleCommand, FwkToggleDialogPane, GarbageCollector, HQL, InstanceElementCustomizer, InstanceElementCustomizer, ItemList.ItemListConsumer, JasperInstanceElementPlugin, JournalConsumer, LayouterCommand, LMSAscii.LMSAsciiColumn, MED, MED.LayouterConsumer, MEDCalculator, MEDCalculatorBasicPane, MEDCalculatorBasicPane.InfoBusChannelConsumer, MEDCalculatorBasicPane.InfoBusMarkerConsumer, MEDConfigComponentsCommand, MEDCrosshair, MEDCursorPosition, MEDCut, MEDDataGenerators, MEDDataManipulators, MEDInfoBusController, MEDInfoBusSelectionDialogPane, MEDInfoBusSelectionDialogPane.InfoBusConsumer, MEDLayouterCommand, MEDLevelCut, MEDLinearOffset, MEDMarkerCrosshair, MEDMarkerDelete, MEDMarkerDelete.DeletePane, MEDMarkerGenerator, MEDMarkerGenerators, MEDMarkerThreshold, MEDMarkerThreshold.ThresholdPane, MEDMouseBehaviorAdapter, MEDMouseBehaviors, MEDMousePointer, MEDMousePointers, MEDPanel, MEDPickComponents, MEDPlotControlCommand, MEDPlotControls, MEDScale, MEDSelectColumnCommand, MEDSmooth, MEDZoomCrosshair, MoMaXCommand, MoMaXPluginDialogPane, OdsGraph, OdsSecurityAdmin, OdsxAppendToMeasurementCommand, OdsxApplElemDefaultChildrenSelector, OdsxApplicationElement, OdsxApplicationElementProducer, OdsxATFFilterCommand, OdsxAttributeEditorPane, OdsxBaseElementFilter, OdsxBaseElementFilterCommand, OdsxBaseElementFilterPanel, OdsxCheckModelCommand, OdsxCloseSessionCommand, OdsxColumn, OdsxColumnAccess, OdsxColumnAssignmentPane, OdsxColumnProducer, OdsxColumnProducer.VMColumnGroup, OdsxCopyInstanceCommand, OdsxCreateMeasurementCommand, OdsxDebugLevelEditorCommand, OdsxDebugLevelEditorPane, OdsxDeleteInstanceCommand, OdsxDumpMeasurementCommand, OdsxEditorPresentor, OdsxEnablePresentableCommand, OdsxFactoryCommand, OdsxFilter, OdsxFilterEditor, OdsxFilterEditorCommand, OdsxFilterEditorPane, OdsxFilterEditorPanel, OdsxFilteredTreeNode, OdsxInstanceCopyPane, OdsxInstanceCreateCommand, OdsxInstanceCreatePane, OdsxInstanceEditCommand, OdsxInstanceEditorPane, OdsxInstanceElement, OdsxInstanceProducer, OdsxInstElemDefaultChildrenSelector, OdsxInstElemDefaultMenu, OdsxLayouterCommand, OdsxLayouterCommand.TextModel, OdsxMeasurementCreatePane, OdsxPresentableElement, OdsxPresentableElementConsumer, OdsxPresentableElementProducer, OdsxPresentor, OdsxPresentor.OdsxPathProducer, OdsxPresentorPanel, OdsxPublicValueMatrixCommand, OdsxQueryTablePresentor, OdsxRecursiveApplicationElement, OdsxResultSet, OdsxResultSetProducer, OdsxSelector, OdsxSelector.OdsxPathConsumer, OdsxSelectorPanel, OdsxSelectorPanel.DeleteMultiInstanceCommand, OdsxSelectorPanel.UpdateTreeCommand, OdsxSession, OdsxSessionConsumer, OdsxSessionElement, OdsxSessionProducer, OdsxSetContextCommand, OdsxTablePresentorPanel, OdsxTextPresentorPanel, OdsxTranslateDialogPane, OdsxTranslatePresentableCommand, OdsxUnpublicValueMatrixCommand, OdsxVisiblePresentableCommand, P2DAxis, P2DAxisControl, P2DAxisModel, P2DBasicStrokeSelectCommand, P2DCanvas, P2DChannel, P2DChannel.InfoBusDataConsumer, P2DChannelControl, P2DChannelModel, P2DColumnDisplayCommand, P2DComponent, P2DComponentConsumer, P2DComponentControl, P2DComponentModel, P2DComponentProducer, P2DConfigComponentsCommand, P2DContainer, P2DImage, P2DImageControl, P2DImageModel, P2DLayout, P2DLayoutControl, P2DLayouter, P2DLayoutModel, P2DLegend, P2DLegendControl, P2DLegendModel, P2DMarker, P2DMarkerColorCommand, P2DMarkerConsumer, P2DMarkerControl, P2DMarkerDeleteCommand, P2DMarkerGroup, P2DMarkerModel, P2DMarkerNameCommand, P2DMarkerProducer, P2DMarkerRangeCommand, P2DMarkerStatisticsCommand, P2DMarkerZoomCommand, P2DPlot, P2DPlotControl, P2DPlotModel, P2DPrintCanvasCommand, P2DRainView, P2DRangeCommand, P2DRangeDialogPane, P2DShape, P2DShapeControl, P2DShapeModel, P2DShapeStrokeSelectCommand, P2DStrokeWidthSelectCommand, P2DTest, P2DTest.GCCommand, P2DText, P2DTextControl, P2DTextModel, P2DTopLayout, P2DUnselectCommand, ProducerSelector.MimeTypeConsumer, ProducerSelector.ProducerSelectorConsumer, QueryTablePresentor, ResourceMonitor, RightsDialogAEPanel, RightsDialogIEPanel, RightsDialogPanel, RpcIIIColumnAccess, RpcIIIColumnProducer, RpcIIIColumnProducer.ColumnGroup, RpcIIIColumnProducer.TimeColumn, SessionCustomizer, ToolBarPanel, TrafficLight, UserDialogPanel

public interface FwkInstructionInterface
extends FwkPresentationInterface

The FwkInstructionInterface allows to add commands to a component. The commands must implement the FwkCommandInterface. A component that implements the FwkInstructionInterface can be asked for the commands it supports or for a specific command if the command name is known.

Since:

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

Version:

$Revision: 1.11 $

Author:

HighQSoft GmbH

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
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	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 the command array.
boolean	commandsAvailable() This method returns a boolean that indicates whether the command array is initialized.
void	deleteGroup(java.lang.String groupIdent) Delete command group.
FwkCommandInterface	getCommand(java.lang.String commandName) Return the command that matches the given command name.
FwkCommandInterface[]	getCommands() Retrieve the command array of the component.
FwkCommandInterface[]	getGroup(java.lang.String groupIdent) Retrieve the command group.
boolean	groupExists(java.lang.String groupIdent) Check whether a group exists.
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	setCommands(FwkCommandInterface[] commands) Set the sub-commands of the command.

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

getPresentationString, getPresentationString

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

getVersion, release

Method Detail

addCommand

void addCommand(FwkCommandInterface command)

Add the command to the command array.

Parameters:

command - The command to be added.

addCommand

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 appends it to existing array.

Parameters:

index - The position where the command has to be inserted.

command - The command to be added.

getCommand

FwkCommandInterface getCommand(java.lang.String commandName)

Return the command that matches the given command name.

Parameters:

commandName - The name of the requested command.

Returns:

The command or null if no matching command found.

getCommands

FwkCommandInterface[] getCommands()

Retrieve the command array of the component. If there are no commands available the method initializes the array.

Returns:

The array containing the commands.

removeCommand

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.

Parameters:

command - The command to be removed.

clearCommands

void clearCommands()

Clear the command array.

setCommands

void setCommands(FwkCommandInterface[] commands)

Set the sub-commands of the command. All existing sub-commands will be removed.

Parameters:

commands - An array containing all sub-commands.

See Also:

addCommand(FwkCommandInterface command)

commandsAvailable

boolean commandsAvailable()

This method returns a boolean that indicates whether the command array is initialized.

Returns:

true if the command array is already initialized.

addToGroup

void addToGroup(int index,
              java.lang.String groupIdent,
              java.lang.String commandName)

Add a command to a group.

Parameters:

index - Index where the command should be placed.

groupIdent - The string identified of the group.

commandName - The name of the command.

addToGroup

void addToGroup(java.lang.String groupIdent,
              java.lang.String commandName)

Add a command to a group.

Parameters:

groupIdent - The string identified of the group.

commandName - The name of the command.

removeFromGroup

void removeFromGroup(java.lang.String groupIdent,
                   java.lang.String commandName)

Remove a command from a group.

Parameters:

groupIdent - The string identified of the group.

commandName - The name of the command.

deleteGroup

void deleteGroup(java.lang.String groupIdent)

Delete command group.

Parameters:

groupIdent - The string identified of the group.

getGroup

FwkCommandInterface[] getGroup(java.lang.String groupIdent)

Retrieve the command group.

Parameters:

groupIdent - The string identified of the group.

Returns:

An array containing the group commands or null if empty.

groupExists

boolean groupExists(java.lang.String groupIdent)

Check whether a group exists.

Returns:

true if the group exists.