aom.scripting.ui

Class SubMenu

Object

SubMenu

public class SubMenu
extends Object

Defines a SubMenu, a part of a MenuGadget. A SubMenu can have multiple other SubMenus as its children.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
String	accelerator Defines the hotkey that can be used to jump to this entry.
List<SubMenu>	children
String	configIndex This field provides a shortcut to make this menu's command act as the configToggle(string config) command.
String	consoleCommand Defines the command to be executed when the user clicks on this menu item.
boolean	disabled Defines whether this menuitem is disabled or not.
boolean	separator Defines whether this menuitem acts as a separator or not.
String	title Defines the text that will be displayed on this menu item.

Constructor Summary

Constructors

Constructor and Description
SubMenu(String title) Creates a new SubMenu with given title and default properties.
SubMenu(String accelerator, String configIndex, String consoleCommand, boolean disabled, boolean separator, String title) Creates a new SubMenu with the given properties.

Method Summary

Modifier and Type	Method and Description
void	addSubMenu(SubMenu subMenu)
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

children

public List<SubMenu> children

consoleCommand

public String consoleCommand

Defines the command to be executed when the user clicks on this menu item. If no command is needed, set the field to null;

accelerator

public String accelerator

Defines the hotkey that can be used to jump to this entry. If no hotkey is needed, set the field to null;

configIndex

public String configIndex

This field provides a shortcut to make this menu's command act as the configToggle(string config) command. If no configIndex is needed, set the field to null;

See Also:

Config.configToggle(aom.scripting.datatypes.string)

disabled

public boolean disabled

Defines whether this menuitem is disabled or not.

separator

public boolean separator

Defines whether this menuitem acts as a separator or not. If this is true, no title will be shown, and no children should be added.

title

public String title

Defines the text that will be displayed on this menu item.

Constructor Detail

SubMenu

public SubMenu(String accelerator,
               String configIndex,
               String consoleCommand,
               boolean disabled,
               boolean separator,
               String title)

Creates a new SubMenu with the given properties.

SubMenu

public SubMenu(String title)

Creates a new SubMenu with given title and default properties.

Method Detail

addSubMenu

public void addSubMenu(SubMenu subMenu)

toString

public String toString()

Overrides:

toString in class Object