Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.menu.model

Item

Implements caplin.menu.Model.
The class caplin.menu.model.Item represents a default item that can be inserted into a menu.

The table below explains each possible option.

namedefaulttypedescription
labelString The item label.
classifierString Allows you to set a classifier to your item to differentiate it from other items.
typeitemString The item type.

Constructor Summary

Attributes Name and Description
caplin.menu.model.Item(Map options)

Field Summary

Attributes Name and Description
<static> caplin.menu.model.Item.ACTION_EVENT

The name of the event that is emitted when an action is activated.

Method Summary

Attributes Name and Description
void disable()

Disables the item.
void enable()

Enables the item.
String getClassifier()

Returns the item's classifier.
String getLabel()

Returns the item's label.
Methods implemented from class caplin.menu.Model:
actionActivator, getEventName, getParent, getType, isEnabled, setEnabled, setParent

Constructor Detail

► caplin.menu.model.Item(Map options)

Parameters
Map options A map of options.

Field Detail

► <static> caplin.menu.model.Item.ACTION_EVENT

The name of the event that is emitted when an action is activated.

Method Detail

► void disable()

Disables the item.

► void enable()

Enables the item.

► String getClassifier()

Returns the item's classifier.

Returns
{String}

► String getLabel()

Returns the item's label.

Returns
{String}