com.xmlmind.xmleditapp.cmd.macro

Class MacroCommand

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmleditapp.cmd.macro.MacroCommand

All Implemented Interfaces:

Command

public final class MacroCommand
extends CommandBase

Implementation of macro commands.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MacroCommand.Choice
static class	MacroCommand.Fail
static class	MacroCommand.Get
static class	MacroCommand.GroupItem
static class	MacroCommand.Invocation
static class	MacroCommand.Item
static class	MacroCommand.ItemType
static class	MacroCommand.Match
static class	MacroCommand.Pass
static class	MacroCommand.RunScript
static class	MacroCommand.Sequence
static class	MacroCommand.Set
static class	MacroCommand.Test
static class	MacroCommand.TestItem
static class	MacroCommand.XPathItem

Field Summary

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

recordable

Constructor Summary

Constructors

Constructor and Description
MacroCommand(MacroCommand.GroupItem group, URL configURL, boolean repeatable, boolean undoable, String label)

Method Summary

Modifier and Type	Method and Description
MacroCommand	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.
URL	getConfigurationURL()
MacroCommand.GroupItem	getGroup()
String	getLabel()
boolean	getTrace()
boolean	isRepeatable() Returns true if this command is repeatable; false otherwise.
boolean	isUndoable()
boolean	prepare(DocumentView docView, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.
void	setLabel(String label)
void	setTrace(boolean trace)

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

doExecuteByName, execute, executeCommand, isRecordable, prepareCommand

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroCommand

public MacroCommand(MacroCommand.GroupItem group,
                    URL configURL,
                    boolean repeatable,
                    boolean undoable,
                    String label)

Method Detail

copy

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

getGroup

public MacroCommand.GroupItem getGroup()

getConfigurationURL

public URL getConfigurationURL()

isRepeatable

public boolean isRepeatable()

Description copied from class: CommandBase

Returns true if this command is repeatable; false otherwise.

Overrides:

isRepeatable in class CommandBase

isUndoable

public boolean isUndoable()

setLabel

public void setLabel(String label)

getLabel

public String getLabel()

setTrace

public void setTrace(boolean trace)

getTrace

public boolean getTrace()

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.