Caplin Trader 5.1.0

Interface: module:ct-component/menu/Menu

module:ct-component/menu/Menu

Methods

addChangeListener(oListener)

Register to receive menu change events.

Parameters:
Name Type Description
oListener module:ct-component/menu/MenuChangeListener

The listener to be registered.

addMenuItem(oMenuItem)

Add a new menu item to the list of child menu items.

Parameters:
Name Type Description
oMenuItem module:ct-component/menu/Menu

The menu item to be added.
See:

getChildren()

A list of either the menu items within a sub-menu, or a grouped set of menu items.

getDescription()

The description of either a single menu item or a sub-menu item.

getHandler()

The handler function that will be invoked when the menu item is clicked.

isEnabled()

Returns true if this menu is currently enabled, and false otherwise.

removeChangeListener(oListener)

Remove a previously registered listener.

Parameters:
Name Type Description
oListener module:ct-component/menu/MenuChangeListener

A previously registered listener.

removeMenuItem(oMenuItem)

Remove an existing menu item from the list of child menu items.

Parameters:
Name Type Description
oMenuItem module:ct-component/menu/Menu

The menu item to be removed.
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