Caplin Trader 4.8.0

Interface: module:caplin/component/menu/Menu

module:caplin/component/menu/Menu

Methods

addChangeListener(oListener)

Register to receive menu change events.
Parameters:
Name Type Description
oListener module:caplin/component/menu/MenuChangeListener The listener to be registered.
Implementations:
  • module:caplin/component/menu/AbstractMenu#addChangeListener

addMenuItem(oMenuItem)

Add a new menu item to the list of child menu items.
Parameters:
Name Type Description
oMenuItem module:caplin/component/menu/Menu The menu item to be added.
Implementations:
  • module:caplin/component/menu/AbstractMenu#addMenuItem
See:

getChildren()

A list of either the menu items within a sub-menu, or a grouped set of menu items.
Implementations:
  • module:caplin/component/menu/AbstractMenu#getChildren

getDescription()

The description of either a single menu item or a sub-menu item.
Implementations:
  • module:caplin/component/menu/AbstractMenu#getDescription

getHandler()

The handler function that will be invoked when the menu item is clicked.
Implementations:
  • module:caplin/component/menu/AbstractMenu#getHandler

isEnabled()

Returns true if this menu is currently enabled, and false otherwise.
Implementations:
  • module:caplin/component/menu/AbstractMenu#isEnabled

removeChangeListener(oListener)

Remove a previously registered listener.
Parameters:
Name Type Description
oListener module:caplin/component/menu/MenuChangeListener A previously registered listener.
Implementations:
  • module:caplin/component/menu/AbstractMenu#removeChangeListener

removeMenuItem(oMenuItem)

Remove an existing menu item from the list of child menu items.
Parameters:
Name Type Description
oMenuItem module:caplin/component/menu/Menu The menu item to be removed.
Implementations:
  • module:caplin/component/menu/AbstractMenu#removeMenuItem
See:

setIsEnabled(bIsEnabled)

Set whether the menu is enabled or not.
Parameters:
Name Type Description
bIsEnabled boolean Whether to enable or disable the menu item
Implementations:
  • module:caplin/component/menu/AbstractMenu#setIsEnabled