com.xmlmind.xmleditapp.cmd.edit

Class ExecuteMenuItem

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmleditapp.cmd.edit.ExecuteMenuItem

All Implemented Interfaces:

Command

public final class ExecuteMenuItem
extends CommandBase

Implementation of command executeMenuItem.

This command executes another command referenced in a menu item. The parameter of executeMenuItem specifies a command returning a menu and the index of this menu item.

For example, this command may be used to implement a "click to follow link" facility which works whatever the kind of link, by leveraging the contextual menu.

Field Summary

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

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
ExecuteMenuItem()

Method Summary

Modifier and Type	Method and Description
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
CommandResult	execute(DocumentView docView, String parameter, int x, int y) This method invokes CommandBase.doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) to actually execute the command.
boolean	prepare(DocumentView docView, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.

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

doExecuteByName, 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

ExecuteMenuItem

public ExecuteMenuItem()

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

execute

public CommandResult execute(DocumentView docView,
                             String parameter,
                             int x,
                             int y)

Description copied from class: CommandBase

This method invokes CommandBase.doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) to actually execute the command. It's basically a convenience method which automatically deals with the command history and the macro-recorder (if any).

IMPORTANT: a command which executes another command must always use CommandBase.doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) to do so, NOT 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).

Overrides:

execute in class CommandBase

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.