com.highqsoft.fwk

Class FwkInstruction

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkPresentation

com.highqsoft.fwk.FwkInstruction

All Implemented Interfaces:

FwkInstructionInterface, FwkInterface, FwkPresentationInterface, java.io.Serializable

Direct Known Subclasses:

P2DComponentControl

public class FwkInstruction
extends FwkPresentation
implements FwkInstructionInterface

The default FwkInstructionInterface implementation.

Since:

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

Version:

$Revision: 1.13 $

Author:

HighQSoft GmbH

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected FwkArrayInterface	commands
protected static FwkCommandInterface[]	fwkCommandTemplate
protected java.util.HashMap	groups
static java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
FwkInstruction()

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.
java.lang.String	getVersion() Return the version string of the FWK component.
boolean	groupExists(java.lang.String groupIdent) Check whether a group exists.
void	release() Release the object.
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[] commandArray) Set the sub-commands of the command.

Methods inherited from class com.highqsoft.fwk.FwkPresentation

getPresentationString, getPresentationString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion

Methods inherited from class java.lang.Object

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

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

getPresentationString, getPresentationString

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

commands

protected FwkArrayInterface commands

groups

protected java.util.HashMap groups

fwkCommandTemplate

protected static FwkCommandInterface[] fwkCommandTemplate

Constructor Detail

FwkInstruction

public FwkInstruction()

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 FwkPresentation

release

public void release()

Release the object.

Specified by:

release in interface FwkInterface

Overrides:

release in class Fwk

addCommand

public void addCommand(FwkCommandInterface command)

Add the command to the command array.

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 appends 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 commandName)

Return the command that matches the given command name.

Specified by:

getCommand in interface FwkInstructionInterface

Parameters:

commandName - The name of the requested command.

Returns:

The command or null if no matching command found.

getCommands

public FwkCommandInterface[] getCommands()

Retrieve the command array of the component.

Specified by:

getCommands in interface FwkInstructionInterface

Returns:

The array containing the 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[] commandArray)

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

Specified by:

setCommands in interface FwkInstructionInterface

Parameters:

commandArray - The array containing the sub-commands.

See Also:

FwkInstructionInterface.addCommand(FwkCommandInterface command)

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 the command array.

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.

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.

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.