DropDownListItem

lumin.ui. DropDownListItem

Constructor with specified label and optional id (no sub-items)

Parameters:
Name Type Attributes Default Description
a_label string
a_id number <optional>
0

Members

id :number

An optional, custom defined, identifier to associate with each item.

Type:
  • number

label :string

UTF-8 encoded label for the item.

Type:
  • string

subItems :Array.<lumin.ui.DropDownListItem>

Potential list of sub-items (for multi-level) for this item.

Type:

Methods

getLevel() → {number}

Get the zero-based level of the item in the multi-level list.

Returns:
Type
number

getParent() → {lumin.ui.DropDownListItem}

The parent list item this item belongs to, if any.

Returns:
Type
lumin.ui.DropDownListItem

getSelected() → {boolean}

Get whether the item is selected.

Returns:
Type
boolean

setSelected(selected)

Set the selected state of this item

Parameters:
Name Type Description
selected boolean

lumin.ui. DropDownListItem

Structure containing information about each item in a drop-down list.

Constructor

Constructor with specified label, list of sub-items, and optional id

Parameters:
Name Type Attributes Default Description
a_label string
a_subItems Array.<lumin.ui.DropDownListItem>
a_id number <optional>
0

Members

id :number

An optional, custom defined, identifier to associate with each item.

Type:
  • number

label :string

UTF-8 encoded label for the item.

Type:
  • string

subItems :Array.<lumin.ui.DropDownListItem>

Potential list of sub-items (for multi-level) for this item.

Type:

Methods

getLevel() → {number}

Get the zero-based level of the item in the multi-level list.

Returns:
Type
number

getParent() → {lumin.ui.DropDownListItem}

The parent list item this item belongs to, if any.

Returns:
Type
lumin.ui.DropDownListItem

getSelected() → {boolean}

Get whether the item is selected.

Returns:
Type
boolean

setSelected(selected)

Set the selected state of this item

Parameters:
Name Type Description
selected boolean