com.xmlmind.xmleditapp.cmd.process

Class ProcessCommand

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmleditapp.cmd.process.ProcessCommand

All Implemented Interfaces:

Command, ActionListener, EventListener

public final class ProcessCommand
extends CommandBase
implements ActionListener

Implementation of process commands.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessCommand.Info

Field Summary

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

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
ProcessCommand(ProcessCommandItem[] items, boolean showProgress, URL configURL, boolean debug, ProcessCommand.Info info)

Method Summary

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)

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

Constructor Detail

ProcessCommand

public ProcessCommand(ProcessCommandItem[] items,
                      boolean showProgress,
                      URL configURL,
                      boolean debug,
                      ProcessCommand.Info info)

Method Detail

copy

public ProcessCommand copy()

Description copied from interface: Command

Makes a deep copy of this command.

Specified by:

copy in interface Command

Returns:

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

getItems

public ProcessCommandItem[] getItems()

isShowingProgress

public boolean isShowingProgress()

getConfigurationURL

public URL getConfigurationURL()

setDebug

public void setDebug(boolean debug)

getDebug

public boolean getDebug()

getInfo

public ProcessCommand.Info getInfo()

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.

doExecute

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

For use by command-line utilities like xxeconvert.

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener