new ui.ListBox(obj)
- Source:
ListBox UI class
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
type | [description] |
Methods
(static) addItem(text, image, index) → {ListItem}
- Source:
Adds a ListItem to this ListBox
Parameters:
| Name | Type | Description |
|---|---|---|
text |
String | ListItem Text |
image |
Image | ListItem Image |
index |
Number | Index to insert ListItem in ListBox |
Returns:
- Created ListITem
- Type
- ListItem
(static) addRow(itemArray) → {ListItem}
- Source:
Adds a multi-dimensional row to a list
Parameters:
| Name | Type | Description |
|---|---|---|
itemArray |
Array.<String> | String array for row columns |
Returns:
- Created row
- Type
- ListItem
(static) contiguous(sel) → {Boolean}
- Source:
Checks whether a selection in a list is contiguous
Parameters:
| Name | Type | Description |
|---|---|---|
sel |
Array.<ListItem> | Selection in a list |
Returns:
- Whether the selection is contiguous
- Type
- Boolean
(static) getAncestor(item) → {ListItem}
- Source:
Gets ancestor of item
Parameters:
| Name | Type | Description |
|---|---|---|
item |
ListItem | Item to get ancestor of |
Returns:
- Ancestor node
- Type
- ListItem
(static) getSelection() → {Array.<ListItem>}
- Source:
Gets the selection in a list
Returns:
Array of selected items
- Type
- Array.<ListItem>
(static) moveDown()
- Source:
Moves selected item(s) down in a list
(static) moveToBottom()
- Source:
Moves selected item(s) to the bottom of a list
(static) moveToTop()
- Source:
Moves selected item(s) to the top of a list
(static) moveUp()
- Source:
Moves selected item(s) up in a list
(static) removeAll()
- Source:
Removes all ListItems from this ListBox
(static) removeItem(itemopt)
- Source:
Removes a ListItem from this list
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
item |
ListItem |
<optional> |
ListItem to remove; defaults to selection |
(static) swap(a, b)
- Source:
Swaps two listItems
Parameters:
| Name | Type | Description |
|---|---|---|
a |
ListItem | Item to swap from |
b |
ListItem | Item to swap to |