com.xmlmind.xmledit.cmd.edit

Class ChooseFieldCommand

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmledit.cmd.edit.ChooseFieldCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

Convert, Insert, Replace

public abstract class ChooseFieldCommand
extends CommandBase

The base class of commands Replace, Insert, Convert, etc.

Field Summary

Fields

Modifier and Type	Field and Description
protected FieldChooser	fieldChooser
protected static Field[]	NO_FIELDS

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

recordable, repeatable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChooseFieldCommand()

Method Summary

Modifier and Type	Method and Description
protected FieldChoice	chooseField(Component dialogParent, FieldChoices choices)
protected abstract CommandResult	doExecute(DocumentView docView, String parameter, FieldChoice choice)
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
protected abstract FieldChoice	getPreparedFieldChoice() Returns the field choice created by CommandBase.prepare(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) corresponding to the "complete parameter" passed to this method.
abstract FieldChoices	listFieldChoices(DocumentView docView, String parameter) List all possible field choices for this command given specified selection (obtained through argument docView) and specified parameter.
protected abstract void	resetCommand()

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

doExecuteByName, execute, executeCommand, isRecordable, isRepeatable, prepare, prepareCommand

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

fieldChooser

protected FieldChooser fieldChooser

NO_FIELDS

protected static final Field[] NO_FIELDS

Constructor Detail

ChooseFieldCommand

protected ChooseFieldCommand()

Method Detail

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.

getPreparedFieldChoice

protected abstract FieldChoice getPreparedFieldChoice()

Returns the field choice created by CommandBase.prepare(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) corresponding to the "complete parameter" passed to this method. Returns null if there is no such field choice because this command is to be run interactively.

Method doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) is implemented as follows:

FieldChoice choice = getPreparedFieldChoice();
if (choice == null) {
    FieldChoices choices = listFieldChoices(docView, parameter);
    ...

See Also:

listFieldChoices(com.xmlmind.xmledit.view.DocumentView, java.lang.String)

listFieldChoices

public abstract FieldChoices listFieldChoices(DocumentView docView,
                                              String parameter)

List all possible field choices for this command given specified selection (obtained through argument docView) and specified parameter.

Method doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) is implemented as follows:

FieldChoice choice = getPreparedFieldChoice();
if (choice == null) {
    FieldChoices choices = listFieldChoices(docView, parameter);
    ...

See Also:

getPreparedFieldChoice()

chooseField

protected FieldChoice chooseField(Component dialogParent,
                                  FieldChoices choices)

doExecute

protected abstract CommandResult doExecute(DocumentView docView,
                                           String parameter,
                                           FieldChoice choice)

resetCommand

protected abstract void resetCommand()