com.xmlmind.xmledit.control

Class CommandMenu

java.lang.Object

com.xmlmind.xmledit.control.CommandItem

com.xmlmind.xmledit.control.CommandMenu

All Implemented Interfaces:

Cloneable

public final class CommandMenu
extends CommandItem

A menu of Commands.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CommandMenu.Action A multiple command wrapper which may be used to execute different commands depending on the value of ActionEvent.getModifiers().
static class	CommandMenu.Action2 An implementation of CommandMenu.Action which may be used to execute two different commands depending on the value of ActionEvent.getModifiers().

Field Summary

Fields

Modifier and Type	Field and Description
CommandItem[]	items Specifications of the menu items.

Fields inherited from class com.xmlmind.xmledit.control.CommandItem

command, icon, iconURL, label, parameter, shortcut, toolTip

Constructor Summary

Constructors

Constructor and Description
CommandMenu(String label, CommandItem[] items) Constructs a menu specification.

Method Summary

Modifier and Type	Method and Description
CommandMenu	copy() Returns a deep copy of this menu.
protected CommandItem	doCopy()
boolean	equals(Object other)
int	hashCode()
static void	showMenu(CommandMenu menu, Gadget gadget, int x, int y) Equivalent to showMenu(menu, gadget, x, y, false)
static void	showMenu(CommandMenu menu, Gadget gadget, int x, int y, boolean showAtLeft) Display specified menu.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

items

public CommandItem[] items

Specifications of the menu items.

Constructor Detail

CommandMenu

public CommandMenu(String label,
                   CommandItem[] items)

Constructs a menu specification.

Parameters:

label - label of this menu; may be null unless this menu is a sub menu of another menu

items - specifications of the menu items

Method Detail

copy

public CommandMenu copy()

Returns a deep copy of this menu.

doCopy

protected CommandItem doCopy()

Overrides:

doCopy in class CommandItem

hashCode

public int hashCode()

Overrides:

hashCode in class CommandItem

equals

public boolean equals(Object other)

Overrides:

equals in class CommandItem

showMenu

public static void showMenu(CommandMenu menu,
                            Gadget gadget,
                            int x,
                            int y)

Equivalent to showMenu(menu, gadget, x, y, false)

showMenu

public static void showMenu(CommandMenu menu,
                            Gadget gadget,
                            int x,
                            int y,
                            boolean showAtLeft)

Display specified menu.

Parameters:

menu - the menu to be displayed

gadget - specified coordinates are relative to this gadget

x - X position of the top/left corner of the menu relative to specified gadget

y - Y position of the top/left corner of the menu relative to specified gadget

showAtLeft - display the menu at the left of point (x, y)