Class DropDownListItem

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

Hierarchy

DropDownListItem

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DropDownListItem(a_label: string, a_id?: number): DropDownListItem
new DropDownListItem(a_label: string, a_subItems: Array<DropDownListItem>, a_id?: number): DropDownListItem

- Defined in lumin/ui/node/UiDropDownList.d.ts:40
Constructor with specified label and optional id (no sub-items)

Parameters
- a_label: string
- Optional a_id: number
Returns DropDownListItem
- Defined in lumin/ui/node/UiDropDownList.d.ts:43
Constructor with specified label, list of sub-items, and optional id

Parameters
- a_label: string
- a_subItems: Array<DropDownListItem>
- Optional a_id: number
Returns DropDownListItem

Properties

id

id: number

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

label

label: string

UTF-8 encoded label for the item.

subItems

subItems: Array<DropDownListItem>

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

Methods

getLevel

getLevel(): number

- Defined in lumin/ui/node/UiDropDownList.d.ts:35
Get the zero-based level of the item in the multi-level list.

Returns number

getParent

getParent(): DropDownListItem | null

- Defined in lumin/ui/node/UiDropDownList.d.ts:40
The parent list item this item belongs to, if any.

Returns DropDownListItem | null

getSelected

getSelected(): boolean

- Defined in lumin/ui/node/UiDropDownList.d.ts:30
Get whether the item is selected.

Returns boolean

setSelected

setSelected(selected: boolean): void

- Defined in lumin/ui/node/UiDropDownList.d.ts:25
Set the selected state of this item

Parameters
- selected: boolean
Returns void

Generated using TypeDoc