com.xmlmind.xmledit.control

Class CommandMenu.Action2

java.lang.Object

com.xmlmind.xmledit.control.CommandMenu.Action2

All Implemented Interfaces:

Command, CommandMenu.Action

Enclosing class:

CommandMenu

public static final class CommandMenu.Action2
extends Object
implements CommandMenu.Action

An implementation of CommandMenu.Action which may be used to execute two different commands depending on the value of ActionEvent.getModifiers().

Field Summary

Fields

Modifier and Type	Field and Description
Command	altCmd Command executed when the ActionEvent do have modifiers.
String	altCmdParam The parameter of altCmd.
Command	defaultCmd Command executed when the ActionEvent does NOT have modifiers.
int	modifiers The ActionEvent modifiers selecting altCmd.

Constructor Summary

Constructors

Constructor and Description
Action2(Command defaultCmd, int modifiers, Command altCmd, String altCmdParam) Constructor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent event, Gadget gadget, String parameter, int x, int y) Prepare and execute wrapped command which corresponds to the value of ActionEvent.getModifiers(), if any, and default wrapped command otherwise.
CommandResult	executeCommand(Gadget gadget, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
boolean	prepareCommand(Gadget gadget, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xmlmind.xmledit.control.Command

copy

Field Detail

defaultCmd

public final Command defaultCmd

Command executed when the ActionEvent does NOT have modifiers. Its parameter is the string passed to prepareCommand, executeCommand and actionPerformed.

modifiers

public final int modifiers

The ActionEvent modifiers selecting altCmd.

altCmd

public final Command altCmd

Command executed when the ActionEvent do have modifiers.

altCmdParam

public final String altCmdParam

The parameter of altCmd.

Constructor Detail

Action2

public Action2(Command defaultCmd,
               int modifiers,
               Command altCmd,
               String altCmdParam)

Constructor.

Parameters:

defaultCmd - command executed when the ActionEvent does NOT have modifiers.

modifiers - the ActionEvent modifiers selecting altCmd.

altCmd - command executed when the ActionEvent do have modifiers.

altCmdParam - the parameter of altCmd.

Method Detail

prepareCommand

public boolean prepareCommand(Gadget gadget,
                              String parameter,
                              int x,
                              int y)

Description copied from interface: Command

Tests whether this command can be executed with specified parameter and in specified context.

If the command can be executed, this method returns true after having configured its internal state for consumption by method Command.executeCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) which should be invoked immediately after this one.

Returns false if this command cannot be executed with specified parameter and in specified context.

Specified by:

prepareCommand in interface Command

Parameters:

gadget - the target of this command

parameter - parameterizes the command (that is, modifies the behavior of the command in a command specific way)

x - X position relative to gadget of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

y - Y position relative to gadget of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

executeCommand

public CommandResult executeCommand(Gadget gadget,
                                    String parameter,
                                    int x,
                                    int y)

Description copied from interface: Command

Actually executes this command with specified parameter and in specified context.

This method assumes that Command.prepareCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) has been successfully invoked immediately before its own invocation.

Specified by:

executeCommand in interface Command

Parameters:

gadget - the target of this command

parameter - parameterizes the command (that is, modifies the behavior of the command in a command specific way)

x - X position relative to gadget of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

y - Y position relative to gadget of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

Returns:

the result of the command; may NOT be null

actionPerformed

public void actionPerformed(ActionEvent event,
                            Gadget gadget,
                            String parameter,
                            int x,
                            int y)

Description copied from interface: CommandMenu.Action

Prepare and execute wrapped command which corresponds to the value of ActionEvent.getModifiers(), if any, and default wrapped command otherwise.

Specified by:

actionPerformed in interface CommandMenu.Action