BiSingleTreeNode
This class is used as the data for rows in the BiTree2 component
This class extends BiObject and therefore all methods and fields available for BiObject are also available for BiSingleTreeNode .
Constructor
new BiSingleTreeNode ( oData )
Parameters
| Name | Type | Optional | Default | Descripton |
oData | Object | Optional object containing the data for the cell |
Properties
| Name | Type | get | set | Descripton |
data | Object |  | | Data to display for the node |
depth | Number | | Returns the depth of the node | |
expanded | Boolean | | Whether the node is expanded | |
expandedIcon | String | | | Icon to show for an expanded node |
firstNode | | | Returns the first child node | |
icon | String | | | Uri of image icon. Used for collapsed/leaf nodes and expanded nodes without expandedIcon set. |
labelHtml | String | | Returns the HTML string that should be displayed for the node | |
lastNode | | | Returns the last child node | |
lead | Boolean | | | Whether the node is the lead item |
level | Number | | Returns the indent level of this node | |
nextSiblingNode | | | Returns the next sibiling (if any) | |
nodes | | | The nodes that are children to the current node | |
parentNode | | | The parent tree node | |
previousSiblingNode | | | Returns the previous sibling (if any) | |
selected | Boolean | | | Whether the node is selected |
tree | | | The BSingleTree the node is part of |
Methods
| Name | Description |
addNode | Adds a node to the tree |
containsNode | Returns whether this node contains a supplied node. |
hasNodes | Returns whether the node has any child nodes |
isLastSiblingNode | Returns whether the node is the last sibling |
isLeaf | Returns whether the node is a leaf node. |
removeAll | This removes and disposes all the nodes |
removeNode | Removes a node item from the tree |
reveal | Expands parent nodes so that this node becomes visible |
Events
None.
Static Methods
None.
Static Fields
None.
Remarks
None.
Method Details
addNode
Adds a node to the tree
Syntax
object.addNode ( oChild [ ,oBefore ] ) Parameters
| Name | Type | Optional | Default | Descripton |
oChild | | The node to add to the tree | ||
oBefore | | | Optional argument telling what node to insert before |
Return Type
void
containsNode
Returns whether this node contains a supplied node.
Syntax
object.containsNode ( oNode ) Parameters
| Name | Type | Optional | Default | Descripton |
oNode | | Node to check |
Return Type
Boolean
hasNodes
Returns whether the node has any child nodes
Syntax
object.hasNodes ( ) Parameters
No arguments.
Return Type
Boolean
isLastSiblingNode
Returns whether the node is the last sibling
Syntax
object.isLastSiblingNode ( ) Parameters
No arguments.
Return Type
Boolean
isLeaf
Returns whether the node is a leaf node.
Syntax
object.isLeaf ( ) Parameters
No arguments.
Return Type
Boolean
removeAll
This removes and disposes all the nodes
Syntax
object.removeAll ( ) Parameters
No arguments.
Return Type
void
removeNode
Removes a node item from the tree
Syntax
object.removeNode ( oChild ) Parameters
| Name | Type | Optional | Default | Descripton |
oChild | | The node to remove |
Return Type
void
reveal
Expands parent nodes so that this node becomes visible
Syntax
object.reveal ( [ bNoUpdate ] ) Parameters
| Name | Type | Optional | Default | Descripton |
bNoUpdate | Boolean | | Whether to not update the tree. |
Return Type
void