Class flWidgetTreeView

flWidgetTreeView Class

Class to build and manage tree views.

Package: fusionLib
Copyright: Copyright (c) 2012 - 2016 fusionLib. All rights reserved.
Located at system/libs/Widget/flWidgetTreeView.php

Methods summary

`public`	# `__construct( string $name = null )` Construct the tree. Construct the tree. Parameters `$name` The unique name of the tree view or null if not remembering the state.
`public string`	# `_getContainerID( )` Internal function to generate an ID for each container. Internal function to generate an ID for each container. Returns string The generated ID. Throws `flWidgetException`
`public flBufferCode`	# `_getCodeBuffer( )` Get the code buffer for the tree view. Get the code buffer for the tree view. Returns `flBufferCode` The tree views code buffer. Throws `flWidgetException`
`public flWidgetTreeView`	# `setClass( string $css )` Set the CSS class to use. Set the CSS class to use. Parameters `$css` The CSS class, default is 'treeviewwidget'. Returns `flWidgetTreeView` This object.
`public flWidgetTreeView`	# `addNode( flWidgetTreeNode $node )` Add a node to the tree view. Add a node to the tree view. Parameters `$node` The node to add to the tree. Multiple nodes can be specified. Returns `flWidgetTreeView` This object;
`public`	# `setLastNodeActive( boolean $active = true )` Set the state of the last node added to active. Set the state of the last node added to active. Parameters `$active` true if the last node should be active; else false.
`public`	# `setAJAXMoveHandler( string $handler )` Set the address of the optional AJAX node move handler. Set the address of the optional AJAX node move handler. Parameters `$handler` The URI of the AJAX handler.
`public`	# `disableDragInto( boolean $disable = true )` Disable drag into. Disable drag into. Parameters `$disable` true to disable; else false.
`public string`	# `_render( flWidgetTreeView $tree )` Internal function to render the tree. Internal function to render the tree. Parameters `$tree` The root tree object. Returns string The HTML generated.
`public string`	# `render( flBufferCode $codeBuffer = null, boolean $innerOnly = false )` Render the tree view. Render the tree view. Parameters `$codeBuffer` buffer object if any. `$innerOnly` true to render inner tree portion only; else false. Returns string The HTML to render the tree.

Properties summary

`protected static integer`	`$treeCounter` Count of unnamed trees. Count of unnamed trees.	# `1`
`protected string`	`$css` The CSS class to apply. The CSS class to apply.	# `''`
`protected array`	`$nodes` Array of nodes. Array of nodes.	# `array()`
`protected string`	`$treeName` The name of the tree. The name of the tree.	# `null`
`protected flBufferCode`	`$codeBuffer` The code buffer object if any. The code buffer object if any.	# `null`
`protected array`	`$pathStack` Node path tracking during rendering. Node path tracking during rendering.	# `array()`
`protected array`	`$containerHashes` Tracking of container hashes to avoid clashes. Tracking of container hashes to avoid clashes.	# `array()`
`protected string`	`$ajaxMoveHandler` The AJAX move handler. The AJAX move handler.	# `null`
`protected boolean`	`$disableInto` Disable move into. Disable move into.	# `false`