com.xmlmind.xmledit.cmd

Class CommandSequence

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmledit.cmd.CommandSequence

All Implemented Interfaces:

Command

public class CommandSequence
extends CommandBase

A command which is a sequence of commands.

All commands contained in this sequence are executed in turn. Execution fails at first command which cannot be executed (CommandBase.prepare(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) returns false) or at first command which returns a non-successful CommandResult. Otherwise a CommandSequence returns the result of its last command.

See Also:

CommandChoice

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandEntry[]	sequence
protected boolean	undoable
protected String	undoLabel

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

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
CommandSequence(CommandEntry[] sequence, boolean repeatable, boolean recordable, boolean undoable, String undoLabel) Constructs a command consisting in specified sequence of commands.

Method Summary

Modifier and Type	Method and Description
CommandSequence	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.
protected CommandResult	executeSequence(DocumentView docView, String parameter, int x, int y)
CommandEntry[]	getSequence() Returns the commands composing this CommandSequence.
String	getUndoLabel() Returns the text describing what does the undo command, to be displayed by the GUI of the XML editor.
boolean	isUndoable() Returns true if this sequence can be undone as a whole.
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

sequence

protected CommandEntry[] sequence

undoable

protected boolean undoable

undoLabel

protected String undoLabel

Constructor Detail

CommandSequence

public CommandSequence(CommandEntry[] sequence,
                       boolean repeatable,
                       boolean recordable,
                       boolean undoable,
                       String undoLabel)

Constructs a command consisting in specified sequence of commands.

Parameters:

sequence - the sequence of commands

repeatable - true if this command is repeatable; false otherwise

recordable - true if this command is recordable; false otherwise

undoable - true if this command can be undone as a whole

undoLabel - the text describing what does the undo command, to be displayed by the GUI of the XML editor; may be null

Method Detail

copy

public CommandSequence 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

getSequence

public CommandEntry[] getSequence()

Returns the commands composing this CommandSequence.

isUndoable

public boolean isUndoable()

Returns true if this sequence can be undone as a whole.

getUndoLabel

public String getUndoLabel()

Returns the text describing what does the undo command, to be displayed by the GUI of the XML editor. May return null.

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.

executeSequence

protected CommandResult executeSequence(DocumentView docView,
                                        String parameter,
                                        int x,
                                        int y)