com.xmlmind.xmledit.control

Interface Command

All Known Subinterfaces:

CommandMenu.Action

All Known Implementing Classes:

Add, AddAttribute, AddAttributeButtonVP, AddBlockInFlow, Alert, Alert, AutoSpellCheckerControl, AutoSpellMenu, Beep, CALSTableEdit, CancelSelection, Center, ChangeElementName, ChangeListType, CheckAssembly, CheckDoc, CheckEbook, CheckExternalRefs, CheckMap, CheckValidity, ChooseFieldCommand, ChooseUploadFiles, ClipboardGet, CloseCmd, ColumnGroupView, ColumnView, CommandBase, CommandChoice, CommandMenu.Action2, CommandMenuVP, CommandSequence, CommentOut, CompareCmd, Confirm, ContextualMenu, Convert, ConvertButtonVP, ConvertCase, ConvertCmd, Copy, CopyAsInclusion, CopyChars, CopyImage, CountWords, Cut, DBTableEdit, DeclareNamespace, Delete, DeleteChar, DeleteChar, DeleteEmptyText, DeleteEmptyText, DeleteSelectionOrDeleteChar, DeleteSelectionOrJoinBlockOrDeleteChar, DeleteWord, DeleteWord, Demote, DemoteListItem, DiffSupport, Drag, Drop, EditAttribute, EditAttributes, EditDocumentCmd, EditIframeInfo, EditImageMap, EditImageMap, EditImageMap, EditImageMapBase, EditInclusionCmd, EditIndexTerm, EditIndexTerm, EditIndexTerm, EditIndexTerm, EditIndexTermBase, EditMenuItems, EditObject, EditOrAddRelationship, EditPITarget, EnsureSelectionAt, Execute, ExecuteMenuItem, ExtendSelectionAt, ExtractObject, Fail, FalseCommand, FormatTable, FormatTableBase, FormatTextAs, GenericTableEdit, HTMLTableEdit, Include, IncludeCmd, InclusionMenuItems, Insert, InsertAfterButtonVP, InsertBeforeButtonVP, InsertButtonVP, InsertCharByName, InsertCharSequence, InsertCmd, InsertControlChar, InsertNewlineOrSplitBlock, InsertNode, InsertOrEditBookDivision, InsertOrEditModule, InsertOrEditTopicref, InsertOrOverwriteString, InsertSameBlock, InsertSpecialChars, InsertString, InsertTextOrMoveDot, Join, JoinBlock, JoinBlock, LinkCallouts, ListAnchors, ListBindings, ListRepeatable, MacroCommand, MasterDocumentControl, MenuButtonVP, Modularize, MoveDotTo, MoveDotTo, MoveElement, NewCmd, NormalizeWhiteSpacePre, OlinkedDocuments, OpenCmd, OverwriteMode, OverwriteString, Pass, Paste, PasteAs, PasteFromWord, PasteImageAs, PasteSystemSelection, Pick, PreprocessingOptions, Preview, Preview, PreviewSettings, ProcessCommand, Promote, PromoteListItem, Prompt, PutAttribute, RecordMacro, Redo, Refresh, Reinclude, ReltableEdit, Remark, RemoveAttribute, Repeat, Replace, ReplaceButtonVP, ReplaceCmd, ResizeCALSTableTemplate, ResizeImage, ResizeSimpleTableColumn, ResizeTableColumn, ResizeTableColumn, ResizeTableTemplate, Run, SaveAllCmd, SaveAsCmd, SaveCmd, Search, SearchReplace, SearchReplace, SelectAt, SelectConvertedFile, SelectConvertedFileCmd, SelectFile, SelectLink, SelectNode, SelectNodeAt, SelectOutput, SelectText, SelectTo, SelectTo, SetAssemblyProfiling, SetAttributeButtonVP, SetCellColor, SetCellColor, SetCellColor, SetDITAProfiling, SetFilter, SetObject, SetOlinkTarget, SetProfiling, SetProfilingAttributes, SetProperty, SetReadOnly, ShowColumnRowLabels, ShowContentModel, ShowElementReference, ShowMatchingChar, ShowMenu, ShowObjectView, SimpleTableEdit, SpellCheck, Split, SplitBlock, Start, Status, Status, StyledTreeView, TableEditCommand, ToggleCollapsed, ToggleCollapsed, ToggleCollapsedVP, ToggleInclusionAction, ToggleTextStyle, TranslateSelectionOrSource, TreeView, Undo, Uninclude, UpdateInclusions, UpdateInclusionsCmd, ViewObject, WebSearch, Wrap, WrapButtonVP, WrapCmd, XIncludeText, XPathSearch

public interface Command

Interface implemented by a command acting on a Gadget.

Method Summary

Modifier and Type	Method and Description
default Command	copy() Makes a deep copy of this command.
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.

Method Detail

prepareCommand

boolean prepareCommand(Gadget gadget,
                       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 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.

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

CommandResult executeCommand(Gadget gadget,
                             String parameter,
                             int x,
                             int y)

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

This method assumes that prepareCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) has been successfully invoked immediately before its own invocation.

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

copy

default Command copy()

Makes a deep copy of this command.

Returns:

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