TKTree Class Reference
[Containers]

Represents a collapseable tree structure. More...

Inheritance diagram for TKTree:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 __construct ()
 Creates a new tree.
 addItemsTo ($parent)
 Sets the current parent node.
 getParentNode ()
 Retrieves the current parent node.
 setItemState ($item, $collapsed, $rec=false)
 Sets the collapsed/expanded state of a node and optionally its children.

Detailed Description

Represents a collapseable tree structure.

A tree consists of a set of nodes, which may have children, which may themselves have children. Each node can be expanded or collapsed by clicking on the +/- icon next to it. If a node is collapsed, then all its children are hidden. If it is expanded, then the immediate children become visible again. To create a tree, simply use the standard add() syntax. In order to create a hierarchy, however, you must tell the tree to which node you are adding child nodes. There are several ways to do this. One way is to call addItemsTo()() and specify a node to add child nodes to. Another way is to explicitly specify the parent node when adding, like so: $tree->addLabel("Foo", array('parent' => $someNode)). You can also request that a newly added node become the new default parent by using the asParent parameter, like so: $tree->addLabel("Bar", array('asParent' => true)).

There are a number of CSS classes used by trees. Each item has a class, which refers specifically to the list item and not its children or its expand/collapse button. There are also several classes for the bullets (the expand/collapse buttons). The property 'bullet_class' is combined with one of 'bullet_none_class' (for nodes with no children), or 'bullet_collapse_class' (for nodes with expanded children) or 'bullet_expand_class' (for nodes with collapsed children). And finally, 'inner_class' specifies the appearance of an entire subtree, which is represented by HTML <UL>

The TKHTML for a tree is simple. Each component contained with the tree XML will be added to the tree. To specify subtrees, put the nodes to be in the subtree inside a <subtree>...</subtree> block. The subtree's parent is the component that is present right before the subtree tag. You can nest subtrees as many times as you like. You can specify whether nodes are collapsed or not using the collapsed attribute, and setting it to one of the following four values:

Properties:
  • item_class array: CSS class for a node (HTML <LI>)
  • item_style array: CSS style for a node
  • inner_class array: CSS class for a subtree (HTML <UL>)
  • inner_style array: CSS style for a subtree
  • bullet_none_class array: CSS class combined with bullet_class for a node with no children
  • bullet_collapse_class array: CSS class combined with bullet_class for a node with visible children
  • bullet_expand_class array: CSS class combined with bullet_class for a node with hidden children

Member Function Documentation

TKTree::addItemsTo ( $  parent  ) 

Sets the current parent node.

Subsequent add operations will add children to this node. If the node is null, then new nodes will be added to the root of the tree.

Parameters:
$parent [TKComponent]: new parent node or null for the root

TKTree::getParentNode (  ) 

Retrieves the current parent node.

Returns:
[TKComponent] current parent node to which new nodes are added

TKTree::setItemState ( $  item,
$  collapsed,
$  rec = false 
)

Sets the collapsed/expanded state of a node and optionally its children.

A node is expanded if all its children are visible, and it is collapsed if they are not.

Parameters:
$item [TKComponent]: which node to change state
$collapsed [boolean]: true if node should be collapsed, false for expanded
$rec [boolean]: whether to apply this new state to subchildren
Returns:
[boolean] success

The documentation for this class was generated from the following file:
Generated on Wed Nov 24 02:04:50 2010 for Common by  doxygen 1.5.6