com.xmlmind.xmledit.cmd

Class CommandBase

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

All Implemented Interfaces:

Command

Direct Known Subclasses:

Add, AddBlockInFlow, Alert, Alert, AutoSpellCheckerControl, AutoSpellMenu, Beep, CancelSelection, Center, ChangeElementName, ChangeListType, CheckDoc, CheckValidity, ChooseFieldCommand, ChooseUploadFiles, ClipboardGet, CloseCmd, CommandChoice, CommandSequence, CommentOut, CompareCmd, Confirm, ConvertCase, Copy, CopyAsInclusion, CopyImage, CountWords, DeclareNamespace, Delete, DeleteChar, DeleteEmptyText, DeleteWord, Demote, DemoteListItem, DiffSupport, Drop, EditAttribute, EditAttributes, EditDocumentCmd, EditIframeInfo, EditImageMapBase, EditInclusionCmd, EditIndexTermBase, EditOrAddRelationship, EditPITarget, EnsureSelectionAt, Execute, ExecuteMenuItem, ExtendSelectionAt, ExtractObject, Fail, FormatTableBase, FormatTextAs, Include, InsertCharByName, InsertCharSequence, InsertControlChar, InsertNode, InsertOrEditBookDivision, InsertOrEditModule, InsertOrEditTopicref, InsertSameBlock, InsertSpecialChars, InsertString, InsertTextOrMoveDot, Join, JoinBlock, LinkCallouts, ListAnchors, ListBindings, ListRepeatable, MacroCommand, MasterDocumentControl, Modularize, MoveDotTo, MoveElement, NewCmd, NormalizeWhiteSpacePre, OlinkedDocuments, OpenCmd, OverwriteMode, Pass, Paste, PasteFromWord, PasteImageAs, PasteSystemSelection, Pick, Preview, Preview, PreviewSettings, ProcessCommand, Promote, PromoteListItem, Prompt, RecordMacro, Redo, Refresh, Reinclude, Remark, Repeat, ResizeImage, ResizeSimpleTableColumn, ResizeTableColumn, ResizeTableColumn, ResizeTableTemplate, Run, SaveAllCmd, SaveAsCmd, SaveCmd, Search, SearchReplace, SearchReplace, SelectAt, SelectFile, SelectLink, SelectNode, SelectNodeAt, SelectOutput, SelectText, SetFilter, SetObject, SetOlinkTarget, SetProfiling, SetProfilingAttributes, SetProperty, SetReadOnly, ShowColumnRowLabels, ShowContentModel, ShowElementReference, ShowMenu, ShowObjectView, SpellCheck, Split, SplitBlock, Status, Status, TableEditCommand, ToggleCollapsed, ToggleTextStyle, TranslateSelectionOrSource, Undo, Uninclude, UpdateInclusions, ViewObject, WebSearch, XIncludeText, XPathSearch

public abstract class CommandBase
extends Object
implements Command

The base class of commands acting on a DocumentView.

The prepare(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) and execute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) methods are passed a DocumentView rather than a mere Gadget.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	recordable
protected boolean	repeatable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandBase(boolean repeatable, boolean recordable) Constructs a command.

Method Summary

Modifier and Type	Method and Description
abstract CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
static CommandResult	doExecuteByName(DocumentView docView, String commandName, String commandParameter, int x, int y) Convenience method: executes specified command by the means of doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) (NOT execute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) or executeCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int)) in the context of specified DocumentView.
CommandResult	execute(DocumentView docView, String parameter, int x, int y) This method invokes doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) to actually execute the command.
CommandResult	executeCommand(Gadget gadget, String parameter, int x, int y) Invokes execute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int).
boolean	isRecordable() Returns true if this command is recordable; false otherwise.
boolean	isRepeatable() Returns true if this command is repeatable; false otherwise.
abstract boolean	prepare(DocumentView docView, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.
boolean	prepareCommand(Gadget gadget, String parameter, int x, int y) Invokes prepare(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int).

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

repeatable

protected boolean repeatable

recordable

protected boolean recordable

Constructor Detail

CommandBase

protected CommandBase(boolean repeatable,
                      boolean recordable)

Constructs a command.

Parameters:

repeatable - true if this command is repeatable; false otherwise

recordable - true if this command is recordable; false otherwise

Method Detail

isRepeatable

public boolean isRepeatable()

Returns true if this command is repeatable; false otherwise.

isRecordable

public boolean isRecordable()

Returns true if this command is recordable; false otherwise.

prepareCommand

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

Invokes prepare(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int).

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)

Invokes execute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int).

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

prepare

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

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 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.

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

execute

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

This method invokes doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) to actually execute the command. It's basically a convenience method which automatically deals with the command history and the macro-recorder (if any).

IMPORTANT: a command which executes another command must always use doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) to do so, NOT execute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) or executeCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int).

doExecute

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

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

This method assumes that 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 execute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) or executeCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) to do so, NOT doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int). doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) is intended to be used only by commands which invoke helper "sub-commands".

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.

doExecuteByName

public static CommandResult doExecuteByName(DocumentView docView,
                                            String commandName,
                                            String commandParameter,
                                            int x,
                                            int y)

Convenience method: executes specified command by the means of doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) (NOT execute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) or executeCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int)) in the context of specified DocumentView.

Returns:

a meaningful CommandResult if specified command has been executed (whether successfully or not); null (NOT a CommandResult!) if specified command is unknown or is not a CommandBase or cannot be executed

See Also:

DocumentView.executeCommandByName(java.lang.String, java.lang.String, int, int)