Caplin Trader 4.7.1

Class: module:caplin/menu/model/Item

module:caplin/menu/model/Item

Constructor

new module:caplin/menu/model/Item(options)

The class caplin.menu.model.Item represents a default item that can be inserted into a menu.
Parameters:
Name Type Description
options Object A map of options.
Properties
Name Type Description
label String The item label.
classifier String Allows you to set a classifier to your item to differentiate it from other items.
type String The item type.
Implements:

Members

(static) ACTION_EVENT :String

The name of the event that is emitted when an action is activated.
Type:
  • String
Implements:
Deprecated:
  • Please use module:caplin/menu/Model.ACTION_EVENT instead.

    Methods

    disable()

    Disables the item.

    enable()

    Enables the item.

    getClassifier() → {String}

    Returns the item's classifier.
    Returns:
    Type
    String

    getLabel() → {String}

    Returns the item's label.
    Returns:
    Type
    String