This page is maintained for older versions of Rapise only. The latest documentation can be found at: https://rapisedoc.inflectra.com
GWTExtTree

GWTExtTree

Top  Previous 

 

GWT-Ext Tree. Extends HTMLObject. Extends SeSSimulatedObject.

 

Behavior Pattern: GWTExtTreeBehavior

 

Property Summary

 

Property

Description

Getter

Setter

ChildrenCount

Children count of the current node in the tree.

GetChildrenCount


Expanded

Expanded state of the current node.

GetExpanded


NodeIndex

Zero based index of the current node.

GetNodeIndex


NodeText

Text of the current node.

GetNodeText


Selected

Selected state of the current node.

GetSelected


SelectedNodeText

Text of the selected node.

GetSelectedNodeText


 

Action Summary

 

Action

Description

DoClickNode

Clicks specific node in the tree.

DoCollapse

Collapses specific node in the tree.

DoExpand

Expands specific node in the tree.

DoFindChild

Finds child node by its path from the current node and remembers it as the current node.

DoFindNode

Searches for specific node in the tree and remembers it as the current node.

DoGetPath

Returns path to the current node.

 

Property Detail

 

ChildrenCount

Children count of the current node in the tree.

Accessors: GetChildrenCount

 

Expanded

Expanded state of the current node. Use DoFindNode to set current node. 0 - if the node is collapsed, 1 - if the node is expanded, 2 - if the node is a leaf.

Accessors: GetExpanded

 

NodeIndex

Zero based index of the current node. Use DoFindNode to set current node.

Accessors: GetNodeIndex

 

NodeText

Text of the current node. Use DoFindNode to set current node.

Accessors: GetNodeText

 

Selected

Selected state of the current node. Use DoFindNode to set current node. 'true' if the node is selected, 'false' otherwise.

Accessors: GetSelected

 

SelectedNodeText

Text of the selected node.

Accessors: GetSelectedNodeText

 

Action Detail

 

DoClickNode(path, separator, pathType)

Clicks specific node in the tree.

 

Parameters:

 

Name

Type

Description

path

string

Path of the node

separator

string

Separator
Optional, Default: ;.

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Returns:

 

'true' if success, 'false' otherwise.

 

DoCollapse(path, separator, pathType)

Collapses specific node in the tree.

 

Parameters:

 

Name

Type

Description

path

string

Path of the node

separator

string

Separator
Optional, Default: ;.

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Returns:

 

'true' if success, 'false' otherwise.

 

DoExpand(path, separator, pathType)

Expands specific node in the tree.

 

Parameters:

 

Name

Type

Description

path

string

Path of the node

separator

string

Separator
Optional, Default: ;.

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

 

Returns:

 

'true' if success, 'false' otherwise.

 

DoFindChild(path, separator, pathType, expand)

Finds child node by its path from the current node and remembers it as the current node. If current node is not set then Root node is used.

 

Parameters:

 

Name

Type

Description

path

string

Path of the node

separator

string

Separator
Optional, Default: ;.

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

expand

boolean

is set to true, then found node is expanded

 

Returns:

 

HTMLObject of the found node

 

DoFindNode(path, separator, pathType, expand)

Searches for specific node in the tree and remembers it as the current node.

 

Parameters:

 

Name

Type

Description

path

string

Path of the node

separator

string

Separator
Optional, Default: ;.

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

expand

boolean

is set to true, then found node is expanded

 

Returns:

 

HTMLObject of the found node

 

DoGetPath(pathType, separator)

Returns path to the current node.

 

Parameters:

 

Name

Type

Description

pathType

string

Path type. Can be one of 'name', 'id' or 'index'.
Optional, Default: name.

separator

string

Separator
Optional, Default: ;.

 

Returns:

 

Path to the current node