Class Horde_Tree_javascript

Description

The Horde_Tree_javascript:: class extends the Horde_Tree class to provide javascript specific rendering functions.

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

$Horde: framework/Tree/Tree/javascript.php,v 1.34.2.13 2009/01/06 15:23:44 jan Exp $

Located in /Tree/Tree/javascript.php (line 26)

Horde_Tree
   |
   --Horde_Tree_javascript
Variable Summary
Method Summary
 static boolean isSupported ()
 Horde_Tree_javascript Horde_Tree_javascript ( $tree_name, [ $params = array()])
 string getTree ([boolean $static = false])
Variables
string $_options_name = null (line 40)

The name of the target element to output the javascript tree.

string $_source_name = null (line 33)

The name of the source for the tree data.

string $_target_name = null (line 47)

The name of the target element to output the javascript tree.

Inherited Variables

Inherited from Horde_Tree

Horde_Tree::$_extra_cols_left
Horde_Tree::$_extra_cols_right
Horde_Tree::$_header
Horde_Tree::$_instance
Horde_Tree::$_nodes
Horde_Tree::$_options
Horde_Tree::$_root_nodes
Horde_Tree::$_sortCriteria
Horde_Tree::$_static
Horde_Tree::$_usesession
Methods
static isSupported (line 109)

Check the current environment to see if we can render the HTML tree. We check for DOM support in the browser.

  • return: Whether or not this Tree:: backend will function.
static boolean isSupported ()
Constructor Horde_Tree_javascript (line 52)

Constructor

Horde_Tree_javascript Horde_Tree_javascript ( $tree_name, [ $params = array()])
  • $tree_name
  • $params
getTree (line 89)

Returns the tree.

  • return: The HTML code of the rendered tree.
string getTree ([boolean $static = false])
  • boolean $static: If true the tree nodes can't be expanded and collapsed and the tree gets rendered expanded.
renderNodeDefinitions (line 121)

Returns just the JS node definitions as a string.

  • return: The Javascript node array definitions.
string renderNodeDefinitions ()

Inherited Methods

Inherited From Horde_Tree

 Horde_Tree::Horde_Tree()
 Horde_Tree::addNode()
 Horde_Tree::addNodeExtra()
 Horde_Tree::addNodeParams()
 Horde_Tree::factory()
 Horde_Tree::fallback()
 Horde_Tree::getOption()
 Horde_Tree::isExpanded()
 Horde_Tree::renderTree()
 Horde_Tree::setHeader()
 Horde_Tree::setOption()
 Horde_Tree::singleton()
 Horde_Tree::sort()
 Horde_Tree::_buildIndents()

Documentation generated on Sun, 30 Jan 2011 05:18:39 +0000 by phpDocumentor 1.4.3