com.xmlmind.xmledit.cmd.edit

Class Convert

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmledit.cmd.edit.ChooseFieldCommand

com.xmlmind.xmledit.cmd.edit.Convert

All Implemented Interfaces:

Command

Direct Known Subclasses:

ConvertCmd, Wrap

public class Convert
extends ChooseFieldCommand

Implementation of command convert.

Field Summary

Fields inherited from class com.xmlmind.xmledit.cmd.edit.ChooseFieldCommand

fieldChooser, NO_FIELDS

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

recordable, repeatable

Constructor Summary

Constructors

Modifier	Constructor and Description
	Convert()
protected	Convert(boolean wrap)

Method Summary

Modifier and Type	Method and Description
protected CommandResult	doExecute(DocumentView docView, String parameter, FieldChoice choice)
protected 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.
FieldChoices	listFieldChoices(DocumentView docView, String parameter) List all possible field choices for this command given specified selection (obtained through argument docView) and specified parameter.
boolean	prepare(DocumentView docView, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.
protected void	resetCommand()

Methods inherited from class com.xmlmind.xmledit.cmd.edit.ChooseFieldCommand

chooseField, doExecute

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

Methods inherited from interface com.xmlmind.xmledit.control.Command

copy

Constructor Detail

Convert

public Convert()

Convert

protected Convert(boolean wrap)

Method Detail

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

getPreparedFieldChoice

protected FieldChoice getPreparedFieldChoice()

Description copied from class: ChooseFieldCommand

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 ChooseFieldCommand.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);
    ...

Specified by:

getPreparedFieldChoice in class ChooseFieldCommand

See Also:

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

listFieldChoices

public FieldChoices listFieldChoices(DocumentView docView,
                                     String parameter)

Description copied from class: ChooseFieldCommand

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

Method ChooseFieldCommand.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);
    ...

Specified by:

listFieldChoices in class ChooseFieldCommand

See Also:

ChooseFieldCommand.getPreparedFieldChoice()

doExecute

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

Specified by:

doExecute in class ChooseFieldCommand

resetCommand

protected void resetCommand()

Specified by:

resetCommand in class ChooseFieldCommand