Constructor
new TreeViewNode()
A TreeViewNode object
Methods
collapse() → {Promise.<void>}
Hides this node's sub-nodes in the expanded TreeView object.
Returns:
a promise that is fulfilled when the operation ends.
-
Type
- Promise.<void>
dragAndDropOn(target, dragOptionsopt) → {Promise.<void>}
Drags and drops a test object onto the specified target object according to the specified DragOptions behavior.
Parameters:
Name | Type | Attributes | Description |
---|
target | TestObject
|
Object | | The target object on which this object is dropped. |
dragOptions | Object |
<optional>
| The drag and drop behavior to apply.
PropertiesName | Type | Attributes | Default | Description |
---|
button | MouseButton |
<optional>
|
MouseButton.left
| The mouse button used to drag the object. | dragLocation | Location |
<optional>
| | The point on the source object where the drag operation begins. | dropLocation | Location |
<optional>
| | The point on the target object where the drag and drop operation ends. |
|
Returns:
a promise that is fulfilled when the drop operation ends.
-
Type
- Promise.<void>
expand() → {Promise.<void>}
Displays this node's hidden sub-nodes in the TreeView object.
Returns:
a promise that is fulfilled when the operation ends.
-
Type
- Promise.<void>
expandAll() → {Promise.<void>}
Expands this node and all of the nodes below it in the TreeView object.
Returns:
a promise that is fulfilled when the operation ends.
-
Type
- Promise.<void>
firstChildPath() → {Promise.<string>}
The full path of the node's first child node as a semi-colon delimited string.
Returns:
a promise that is fulfilled with the full path of the node's first child node.
-
Type
- Promise.<string>
hasChildren() → {Promise.<boolean>}
Indicates whether this node has children.
Returns:
a promise that is fulfilled with an indication of whether the node has children or not.
-
Type
- Promise.<boolean>
isExpanded() → {Promise.<boolean>}
Indicates whether this node is currently expanded.
Returns:
a promise that is fulfilled with an indication of whether the node is expanded or not.
-
Type
- Promise.<boolean>
isSelected() → {Promise.<boolean>}
Indicates whether this node is selected.
Returns:
a promise that is fulfilled with an indication of whether the node is selected or not.
-
Type
- Promise.<boolean>
nextSiblingPath() → {Promise.<string>}
The full path of this node's next sibling node as a semi-colon delimited string.
Returns:
a promise that is fulfilled with the full path of the node's next sibling node.
-
Type
- Promise.<string>
parentPath() → {Promise.<string>}
The full path of the node's parent node as a semi-colon delimited string.
Returns:
a promise that is fulfilled with the full path of the node's parent node.
-
Type
- Promise.<string>
path() → {Promise.<string>}
The full path of the node as a semi-colon delimited string.
Returns:
a promise that is fulfilled with the full path of the node.
-
Type
- Promise.<string>
state() → {Promise.<number>}
The current state of the node's check box
Remarks: Applies only to nodes with check boxes.
Returns:
a promise that is fulfilled with the current state of the check box of the node.
-
Type
- Promise.<number>
text() → {Promise.<string>}
The text of this node, or an empty string ("") if the node does not contain any text.
Returns:
a promise that is fulfilled with the text of the node.
-
Type
- Promise.<string>