com.xmlmind.xmledit.cmd

Class CommandChoice

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmledit.cmd.CommandChoice

All Implemented Interfaces:

Command

Direct Known Subclasses:

DeleteSelectionOrDeleteChar, DeleteSelectionOrJoinBlockOrDeleteChar, InsertNewlineOrSplitBlock

public class CommandChoice
extends CommandBase

A command which is a choice of commands.

All commands contained in the choice list are executed in turn. Execution succeeds, and hence stops, at first command which can be executed. A CommandChoice returns the result of this sucessfully executed command.

See Also:

CommandSequence

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandEntry[]	choices
protected CommandBase	preparedCommand
protected String	preparedCommandParameter
protected static char[]	VAR_NAMES
protected static Object[]	VAR_VALUES

Fields inherited from class com.xmlmind.xmledit.cmd.CommandBase

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
CommandChoice(CommandEntry[] choices, boolean repeatable, boolean recordable) Constructs a command consisting in specified choice of commands.

Method Summary

Modifier and Type	Method and Description
CommandChoice	copy() Makes a deep copy of this command.
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
CommandEntry[]	getChoices() Returns the commands composing this CommandChoice.
boolean	prepare(DocumentView docView, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.

Methods inherited from class com.xmlmind.xmledit.cmd.CommandBase

doExecuteByName, execute, executeCommand, isRecordable, isRepeatable, prepareCommand

Methods inherited from class java.lang.Object

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

Field Detail

choices

protected CommandEntry[] choices

preparedCommand

protected CommandBase preparedCommand

preparedCommandParameter

protected String preparedCommandParameter

VAR_NAMES

protected static final char[] VAR_NAMES

VAR_VALUES

protected static final Object[] VAR_VALUES

Constructor Detail

CommandChoice

public CommandChoice(CommandEntry[] choices,
                     boolean repeatable,
                     boolean recordable)

Constructs a command consisting in specified choice of commands.

Parameters:

choices - the commands composing this CommandChoice

repeatable - true if this command is repeatable; false otherwise

recordable - true if this command is recordable; false otherwise

Method Detail

copy

public CommandChoice copy()

Description copied from interface: Command

Makes a deep copy of this command.

Returns:

the copy or null if how to copy this command cannot be determined

getChoices

public CommandEntry[] getChoices()

Returns the commands composing this CommandChoice.

prepare

public boolean prepare(DocumentView docView,
                       String parameter,
                       int x,
                       int y)

Description copied from class: CommandBase

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 CommandBase.execute(com.xmlmind.xmledit.view.DocumentView, 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:

prepare in class CommandBase

Parameters:

docView - 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 docView of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

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

doExecute

public CommandResult doExecute(DocumentView docView,
                               String parameter,
                               int x,
                               int y)

Description copied from class: CommandBase

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

This method assumes that CommandBase.prepare(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) has been successfully invoked immediately before its own invocation.

IMPORTANT: application code which executes a command must always use CommandBase.execute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) or CommandBase.executeCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) to do so, NOT CommandBase.doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int). CommandBase.doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) is intended to be used only by commands which invoke helper "sub-commands".

Specified by:

doExecute in class CommandBase

Parameters:

docView - 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 docView of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

y - Y position relative to docView 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.

If the command execution is successful and the command is repeatable and/or recordable then CommandResult.details field of the result is expected to be one of:

null

The repeat/record parameter is simply the parameter used as an argument of this method.

An Object

The repeat/record parameter is the string value of this object.

An array of 2 Strings

First string is the repeat/record parameter. Second string is the description of the command to be displayed by repeat commands.