ui.TreeView

aeq. ui.TreeView

new ui.TreeView(obj)

Source:

TreeView UI class

Parameters:
Name Type Description
obj type

[description]

Methods

(static) ui.TreeView#addNode(text, imageopt, indexopt, expandedopt) → {aeq.ui.TreeView}

Source:

Adds a node to a UITreeView

Parameters:
Name Type Attributes Default Description
text String

Text to add to the node

image Image <optional>

Image to set as icon for the node

index Number <optional>

Index to add the node at

expanded Boolean <optional>
true

Whether the node is expanded

Returns:

Node as TreeView item

Type
aeq.ui.TreeView

(static) ui.TreeView#collapseNodes(node)

Source:

Collapses a node and all children

Parameters:
Name Type Description
node _Node

Root node to collapse children of

(static) ui.TreeView#copyBranch(node, nodeCopy)

Source:

Creates a new node or branch based on an existing one

Parameters:
Name Type Description
node _Node

Node to copy

nodeCopy _Node

New node or branch

(static) ui.TreeView#expandNodes(node)

Source:

Expands a node and all children

Parameters:
Name Type Description
node _Node

Root node to expand children of

(static) ui.TreeView#findItemByName(node, list, name) → {Array.<_Node>}

Source:

Finds items by name in a node

Parameters:
Name Type Description
node _Node

Container node

list Array.<_Node>

Array of found items

name String

Name to search in

Returns:
  • Array of found items
Type
Array.<_Node>

(static) ui.TreeView#getAncestor(item) → {_Node}

Source:

Gets ancestor of item

Parameters:
Name Type Description
item _Node

Node to get ancestor of

Returns:
  • Ancestor item
Type
_Node

(static) ui.TreeView#isItem(branch) → {Boolean}

Source:

Checks whether a branch is an item

Parameters:
Name Type Description
branch _Node

Branch to check

Returns:

Whether branch is item

Type
Boolean

(static) ui.TreeView#isNode(branch) → {Boolean}

Source:

Checks whether an branch is a node

Parameters:
Name Type Description
branch _Node

Branch to check

Returns:

Whether branch is node

Type
Boolean

(static) ui.TreeView#moveDown()

Source:

Moves selected item(s) down in a treeview

(static) ui.TreeView#moveUp()

Source:

Moves selected item(s) up in a treeview

(static) ui.TreeView#removeAncestor(item)

Source:

Removes ancestor of node

Parameters:
Name Type Description
item ListItem

Node to remove ancestor of

(static) ui.TreeView#revealItem(name)

Source:

Reveals (expands) an item in a treeview by name

Parameters:
Name Type Description
name String

Name of the node to reveal