public final class ProcessCommand extends CommandBase implements ActionListener
Modifier and Type | Class and Description |
---|---|
static class |
ProcessCommand.Info |
recordable, repeatable
Constructor and Description |
---|
ProcessCommand(ProcessCommandItem[] items,
boolean showProgress,
URL configURL,
boolean debug,
ProcessCommand.Info info) |
Modifier and Type | Method and Description |
---|---|
void |
actionPerformed(ActionEvent e) |
ProcessCommand |
copy()
Makes a deep copy of this command.
|
CommandResult |
doExecute(Document doc,
String[] args,
String allArgs,
Component dialogParent,
Console console)
Implementation of
doExecute(DocumentView,String,int,int)
but does not require the document to be opened in a DocumentView
(nor to first invoke prepare(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) ). |
CommandResult |
doExecute(DocumentView docView,
String parameter,
int x,
int y)
Actually executes this command with specified parameter and in
specified context.
|
URL |
getConfigurationURL() |
boolean |
getDebug() |
ProcessCommand.Info |
getInfo() |
ProcessCommandItem[] |
getItems() |
boolean |
isShowingProgress() |
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 |
setDebug(boolean debug) |
doExecuteByName, execute, executeCommand, isRecordable, isRepeatable, prepareCommand
public ProcessCommand(ProcessCommandItem[] items, boolean showProgress, URL configURL, boolean debug, ProcessCommand.Info info)
public ProcessCommand copy()
Command
public ProcessCommandItem[] getItems()
public boolean isShowingProgress()
public URL getConfigurationURL()
public void setDebug(boolean debug)
public boolean getDebug()
public ProcessCommand.Info getInfo()
public boolean prepare(DocumentView docView, String parameter, int x, int y)
CommandBase
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.
prepare
in class CommandBase
docView
- the target of this commandparameter
- 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 inputy
- Y position relative to docView of the mouse event
having triggered this command; -1 if this command was triggered by a
keyboard inputpublic CommandResult doExecute(DocumentView docView, String parameter, int x, int y)
CommandBase
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".
doExecute
in class CommandBase
docView
- the target of this commandparameter
- 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 inputy
- Y position relative to docView of the mouse event
having triggered this command; -1 if this command was triggered by a
keyboard inputnull
.
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
Object
String
s
public CommandResult doExecute(Document doc, String[] args, String allArgs, Component dialogParent, Console console)
doExecute(DocumentView,String,int,int)
but does not require the document to be opened in a DocumentView
(nor to first invoke prepare(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int)
).
For use by command-line utilities like xxeconvert
.
public void actionPerformed(ActionEvent e)
actionPerformed
in interface ActionListener