xBase and Clipper language compatible compiler
PrevNext

Class UITREE

Name

UITREE  --  Class of hierarchical multi-column lists (tree view).

Synopsis

 UITree([<nTreeColumn>],<acNameColumns>)	--> UITree object

Description

Class UITree

Attributes

<className> - Class name. Value should be "UITree".
<nodes> - Accociated array of UITreeItem objects.
<onSelect> - Code block. Action that will be call on row selection by double click or 'Enter' key pressed.

Methods

ADDNODE Add node to tree view.
CLEAR Clear tree: remove all nodes.
GETSELECTION Get identifier of selected node.
GETSELECTIONID Get user identifier of selected node.
RESTOREPOSITION Restore saved row position.
SAVEPOSITION Get current selected row position.
SETACTION Set action that will be executed if tree node selected by double click or 'Enter' key pressed.
UITREE Constructor. Create tree view.

Method UITREE:ADDNODE()

 addNode(<columns>,[<id>],[<parent>],[<sibling>],[<expanded>])	--> <oNode>

<columns>

- Array of strings. Array of values by columns.

<id>

- String. Node identifier.

<parent>

- Object UITreeItem. Parent node.

<sibling>

- Object UITreeItem. Put node before specified node on such level.

<expanded>

- Boolean. Expand child nodes.

Returns :

Object of tree node, that may be used as parent node (UITreeItem).

Method UITREE:CLEAR()

 clear()

Returns :NIL

Method UITREE:GETSELECTION()

 getSelection()	--> <sNode>

Returns :

The selected node identifier.

Method UITREE:GETSELECTIONID()

 getSelectionId()	--> <id>

Returns :

The user identifier of selected node.

Method UITREE:RESTOREPOSITION()

 restorePosition(<aPos>)

<aPos>

- Array with selected row position returned by savePosition() function.

Returns :NIL

Method UITREE:SAVEPOSITION()

 savePosition()	--> <aPos>

Returns :

Array with selected row position: row address, column address, horizontal and vertical adjustments.

Method UITREE:SETACTION()

 setAction([<signal>],<action>)

<signal>

- String. Signal name.

<action>

- Code block. Action.

Returns :NIL

Method UITREE:UITREE()

 UITree([<nTreeColumn>],<acNameColumns>)	--> UITree object

<nTreeColumn>

- Number. Column for show hierarchy. Column numbering is begun from 1.

<acNameColumns>

- Array of strings. Column titles.

Returns :NIL

Example:

 tree := UITree(1, {"N1","N2"})
 
 node1  := tree:addNode({"Node1", "node1111"})
 node11 := tree:addNode({"Node2"})
 node2  := tree:addNode({"Leaf1"},, node1)

See also

UITREEITEM

Platforms

No dependies of platform.

PrevHomeNext
Class UITOOLBUTTONUpClass UITREEITEM