• Home
  • Horde_Core_Tree_Renderer_Javascript

PHP Class Horde_Core_Tree_Renderer_Javascript, horde

Copyright 2003-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Author: Marko Djukic ([email protected])
Author: Michael Slusarz ([email protected])
Author: Jan Schneider ([email protected])
Inheritance: extends Horde_Core_Tree_Renderer_Html
Datei anzeigen Open project: horde/horde

Public Methods

Method Description
__construct ( Horde_Tree $tree, array $params = [] ) Constructor.
fallback ( ) : string Provide a simpler renderer to fallback to.
getTree ( boolean $static = false ) : string Returns the tree.
isSupported ( ) : boolean Check the current environment to see if we can render the HTML tree.
renderNodeDefinitions ( ) : object Returns just the JS node definitions as a string.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Tree $tree, array $params = [] )
$tree Horde_Tree A tree object.
$params array Additional parameters. - jsvar: The JS variable name to store the tree object in. DEFAULT: Instance name.

fallback() public method

Provide a simpler renderer to fallback to.
public fallback ( ) : string
return string The next best renderer.

getTree() public method

Returns the tree.
public getTree ( boolean $static = false ) : string
$static boolean If true the tree nodes can't be expanded and collapsed and the tree gets rendered expanded.
return string The HTML code of the rendered tree.

isSupported() public method

We check for DOM support in the browser.
public isSupported ( ) : boolean
return boolean Whether or not this backend will function.

renderNodeDefinitions() public method

Returns just the JS node definitions as a string.
public renderNodeDefinitions ( ) : object
return object Object with the following properties: 'is_static', 'nodes', 'root_nodes'.