com.xmlmind.xmledit.control

Class FalseCommand

java.lang.Object

com.xmlmind.xmledit.control.FalseCommand

All Implemented Interfaces:

Command

public final class FalseCommand
extends Object
implements Command

A command for which prepareCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) always returns false.

Field Summary

Fields

Modifier and Type	Field and Description
static FalseCommand	INSTANCE A ready-to-use instance of FalseCommand.

Constructor Summary

Constructors

Constructor and Description
FalseCommand()

Method Summary

Modifier and Type	Method and Description
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

INSTANCE

public static final FalseCommand INSTANCE

A ready-to-use instance of FalseCommand.

Constructor Detail

FalseCommand

public FalseCommand()

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