Class HTML_TreeNode

Description

HTML_TreeNode class

This class is supplementary to the above and provides a way to add nodes to the tree. A node can have other nodes added to it.

Located in /include/TreeMenu.php (line 300)


	
			
Direct descendents
Class Description
HTML_IgepNodo HTML_IgepTreeNode class
Variable Summary
string $cssClass
array $events
bool $expanded
string $expandedIcon
string $icon
bool $isDynamic
array $items
string $link
string $linkTarget
object $parent
string $text
Method Summary
HTML_TreeNode HTML_TreeNode ([array $options = array()], [array $events = array()])
void &addItem ( &$node, object $node)
void setOption (string $option, string $value)
Variables
string $cssClass (line 330)

The css class for this node

bool $ensureVisible (line 360)

Should this node be made visible?

array $events (line 372)

Javascript event handlers;

bool $expanded (line 348)

Whether this node is expanded or not

string $expandedIcon (line 324)

The icon to show when expanded for this node.

string $icon (line 318)

The icon for this node.

bool $isDynamic (line 354)

Whether this node is dynamic or not

array $items (line 342)

Indexed array of subnodes

string $link (line 312)

The link for this node.

string $linkTarget (line 336)

The link target for this node

object $parent (line 366)

The parent node. Null if top level

string $text (line 306)

The text for this node.

Methods
Constructor HTML_TreeNode (line 399)

Constructor

  • access: public
HTML_TreeNode HTML_TreeNode ([array $options = array()], [array $events = array()])
  • array $options: An array of options which you can pass to change the way this node looks/acts. This can consist of:
    • text The title of the node, defaults to blank
    • link The link for the node, defaults to blank
    • icon The icon for the node, defaults to blank
    • expandedIcon The icon to show when the node is expanded
    • cssClass The CSS class for this node, defaults to blank
    • expanded The default expanded status of this node, defaults to false This doesn't affect non dynamic presentation types
    • linkTarget Target for the links. Defaults to linkTarget of the HTML_TreeMenu_Presentation.
    • isDynamic If this node is dynamic or not. Only affects certain presentation types.
    • ensureVisible If true this node will be made visible despite the expanded settings, and client side persistence. Will not affect some presentation styles, such as Listbox. Default is false
  • array $events: An array of javascript events and the corresponding event handlers. Additionally to the standard javascript events you can specify handlers for the 'onexpand', 'oncollapse' and 'ontoggle' events which will be fired whenever a node is collapsed and/or expanded.
addItem (line 446)

Adds a new subnode to this node.

  • access: public
void &addItem ( &$node, object $node)
  • object $node: The new node
  • &$node
setOption (line 435)

Allows setting of various parameters after the initial

constructor call. Possible options you can set are:

  • text
  • link
  • icon
  • cssClass
  • expanded
  • isDynamic
  • ensureVisible
ie The same options as in the constructor

  • access: public
void setOption (string $option, string $value)
  • string $option: Option to set
  • string $value: Value to set the option to

Documentation generated on Wed, 05 Oct 2011 10:36:47 +0200 by phpDocumentor 1.4.1