com.xmlmind.xmledit.cmd.edit

Class ShowMenu

java.lang.Object

com.xmlmind.xmledit.cmd.CommandBase

com.xmlmind.xmledit.cmd.edit.ShowMenu

All Implemented Interfaces:

Command

Direct Known Subclasses:

ContextualMenu, EditMenuItems, InclusionMenuItems

public class ShowMenu
extends CommandBase

A command which displays a menu invoking other commands.

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandMenu	menu The content of the menu, referencing instances of Command.
CommandMenuSpec	spec The specification of the content of the menu, where commands are referenced by their names.

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

recordable, repeatable

Constructor Summary

Constructors

Constructor and Description
ShowMenu(CommandMenuSpec spec) Constructs a command which popups specified menu.

Method Summary

Modifier and Type	Method and Description
protected CommandMenu	compileMenu(CommandMenuSpec spec, DocumentView docView) Invokes toMenu(com.xmlmind.xmledit.control.CommandMenuSpec, com.xmlmind.xmledit.view.DocumentView) to convert the specification of the content of the menu to the actual content of the menu.
ShowMenu	copy() Makes a deep copy of this command.
CommandResult	doExecute(DocumentView docView, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
protected static CommandMenu	parameterizeMenu(CommandMenu menu, String parameter) Returns a copy of specified menu specification where %*, %0, %1, etc, have been substituted with their values taken from specified parameter string.
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 CommandMenu	prepareMenu(DocumentView docView, String parameter, int x, int y) Returns a menu which is ready to be displayed.
static void	setCapturedContextualMenus(DocumentView docView, List<CommandMenu> list)
protected CommandResult	showMenu(CommandMenu popupMenu, DocumentView docView, int x, int y) Display specified ready-to-use menu at specified document view coordinates.
protected static CommandMenu	toMenu(CommandMenuSpec spec, DocumentView docView) Converts the specification of the content of the menu to the actual content of the menu.

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

Field Detail

spec

public final CommandMenuSpec spec

The specification of the content of the menu, where commands are referenced by their names.

May be null when the content of the menu is dynamically built like in ContextualMenu.

menu

protected CommandMenu menu

The content of the menu, referencing instances of Command.

This field, initially null is lazily initialized from menu or dynamically built like in ContextualMenu. Therefore it may be null.

Constructor Detail

ShowMenu

public ShowMenu(CommandMenuSpec spec)

Constructs a command which popups specified menu.

Parameters:

spec - the specification of the content of the menu, where commands are referenced by their names.

May be null when the content of the menu is dynamically built like in ContextualMenu.

Method Detail

copy

public ShowMenu copy()

Description copied from interface: Command

Makes a deep copy of this command.

Returns:

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

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)

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".

Invokes prepareMenu(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int) and then showMenu(com.xmlmind.xmledit.control.CommandMenu, com.xmlmind.xmledit.view.DocumentView, int, int).

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.

prepareMenu

protected CommandMenu prepareMenu(DocumentView docView,
                                  String parameter,
                                  int x,
                                  int y)

Returns a menu which is ready to be displayed. May return null in which case no menu will be displayed.

See Also:

doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int), showMenu(com.xmlmind.xmledit.control.CommandMenu, com.xmlmind.xmledit.view.DocumentView, int, int)

compileMenu

protected CommandMenu compileMenu(CommandMenuSpec spec,
                                  DocumentView docView)

Invokes toMenu(com.xmlmind.xmledit.control.CommandMenuSpec, com.xmlmind.xmledit.view.DocumentView) to convert the specification of the content of the menu to the actual content of the menu.

toMenu

protected static final CommandMenu toMenu(CommandMenuSpec spec,
                                          DocumentView docView)

Converts the specification of the content of the menu to the actual content of the menu.

Parameters:

spec - the specification of the content of the menu, where commands are referenced by their names.

Returns:

the content of the menu, referencing instances of Command; or null if some of the commands have not been registered.

parameterizeMenu

protected static final CommandMenu parameterizeMenu(CommandMenu menu,
                                                    String parameter)

Returns a copy of specified menu specification where %*, %0, %1, etc, have been substituted with their values taken from specified parameter string.

showMenu

protected CommandResult showMenu(CommandMenu popupMenu,
                                 DocumentView docView,
                                 int x,
                                 int y)

Display specified ready-to-use menu at specified document view coordinates.

See Also:

doExecute(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int), prepareMenu(com.xmlmind.xmledit.view.DocumentView, java.lang.String, int, int)

setCapturedContextualMenus

public static void setCapturedContextualMenus(DocumentView docView,
                                              List<CommandMenu> list)