KoolTreeView Class [PHP]

	Properties	Description
	DragAndDropEnable	Get or set whether tree allow drag and drop.
	dragDisableIds	Get or set list of drag-disable tree nodes
	dropDisableIds	Get or set list of drop-disable tree nodes
	editDisableIds	Get or set list of edit-disable tree nodes
	EditNodeEnable	Get or set whether tree allow drag and drop.
	height	Get or set the height for treeview
	imageFolder	Get or set folders which contain image resource for treeview
	isSubTree	Set to true if current tree is under subtree request.
	keepState	Get or set how treeview will keep its state in cookie.
	keepStateHours	Get or set the number of hours that treeview state will be kept in cookie.
	multipleSelectEnable	Get or set whether treeview allows multiple nodes selection.
	overflow	Get or set behavior when overflow happens.
	selectDisableIds	Get or set list of select-disable tree nodes
	selectedIds	Get or set set of selected tree nodes.
	selectEnable	Get or set whether tree allow selection
	showLines	Get or set whether treeview show lines connection between nodes.
	singleExpand	Get or set whether treeview keeps single node expand
	styleFolder	Get or set folder which contain css style for treeview.
	width	Get or set the width for treeview

	Methods	Description
	Add	Add a node to tree
	getRootNode	Return the root node object.
	getNode	Return tree node object.
	Render	Render the treeview
	RegisterScript	Return html to register js library for treeview.
	RegisterCSS	Return html to register CSS for treeview
	RenderTree	Return html content of treeview body
	StartupScript	Return js code to inititate treeview

DragAndDropEnableTop

bool DragAndDropEnable

Get or set whether tree allow drag and drop.

Show/Hide Code

<?php
	$myTree->DragAndDropEnable=true;//Enable drag and drop node feature 
?>

Supported from version: 2.0.0.0

dragDisableIdsTop

string dragDisableIds

Get or set list of drag-disable tree nodes

Show/Hide Code

<?php
	$myTree->dragDisableIds="software,hardware";//List of drag-disable nodes 
?>

Supported from version: 2.0.0.0

dropDisableIdsTop

string dropDisableIds

Get or set list of drop-disable tree nodes

Show/Hide Code

<?php
	$myTree->dropDisableIds="software,hardware";//List of drop-disable nodes
?>

Supported from version: 2.0.0.0

editDisableIdsTop

string editDisableIds

Get or set list of edit-disable tree nodes

Show/Hide Code

<?php
	$myTree->editDisableIds="software,hardware";//List of edit-disable nodes 
?>

Supported from version: 2.0.0.0

EditNodeEnableTop

bool EditNodeEnable

Get or set whether tree allow drag and drop.

Show/Hide Code

<?php
	$myTree->EditNodeEnable=true;//Enable edit node feature 
?>

Supported from version: 2.0.0.0

heightTop

string height

Get or set the height for treeview

Show/Hide Code

<?php
	$myTree->height="100px";//Specify height by pixels 
	$myTree->height="100%";//Specify height by percent 
?>

Supported from version: 1.0.0.0

imageFolderTop

string imageFolder

Get or set folders which contain image resource for treeview

Show/Hide Code

<?php
	$myTree->imageFolder="kooltreeview/icons"; 
?>

Supported from version: 1.0.0.0

isSubTreeTop

bool isSubTree

Set to true if current tree is under subtree request.

Show/Hide Code

Supported from version: 1.0.0.0

keepStateTop

string keepState

Get or set how treeview will keep its state in cookie.

Default value : "none"

Allowed values :

"none" : TreeView will not keep its state persisted.
"onpage" : TreeView will keep its state persisted only on the current page.
"crosspage" : TreeView will keep its state persisted cross multiple pages.

Show/Hide Code

<?php	
	$myTree->keepState="onpage";//Keep state of the tree on the page.
?>

Supported from version: 2.0.3.1

keepStateHoursTop

int keepStateHours

Get or set the number of hours that treeview state will be kept in cookie.

Show/Hide Code

<?php
	$myTree->keepStateHours = 24;//Keep state persisted in 24 hours. 
?>

Supported from version: 2.0.3.1

multipleSelectEnableTop

bool multipleSelectEnable

Get or set whether treeview allows multiple nodes selection. User use Ctrl + leftmouse in order to select multinodes.

Show/Hide Code

<?php
	$myTree->multipleSelectEnable=true; 
?>

Supported from version: 1.0.0.0

overflowTop

string overflow

Get or set behavior when overflow happens.

Allowed values :

"auto" : Auto adding scroll when tree is longer or bigger than width and height.
"scroll" : Add scroll
"hidden" : Treeview will not display the scroll, overflow tree is hidden.

Show/Hide Code

<?php
	$myTree->overflow="auto";
?>

Supported from version: 1.0.0.0

selectDisableIdsTop

string selectDisableIds

Get or set list of select-disable tree nodes

Show/Hide Code

<?php
	$myTree->selectDisableIds="node1,node2";//List of disable selection node
?>

Supported from version: 1.0.0.0

selectedIdsTop

string selectedIds

Get or set set of selected tree nodes.

Show/Hide Code

<?php
	$myTree->selectedIds="node1,node2";//List of selected node id
?>

Supported from version: 1.0.0.0

selectEnableTop

bool selectEnable

Get or set whether tree allow selection

Show/Hide Code

<?php
	$myTree->selectEnable=false;//Disable select node feature 
?>

Supported from version: 1.0.0.0

showLinesTop

bool showLines

Get or set whether treeview show lines connection between nodes.

Show/Hide Code

<?php
	$myTree->showLines=true;//Show lines connection
?>

Supported from version: 2.0.1.0

singleExpandTop

bool singleExpand

Get or set whether treeview keeps single node expand

Show/Hide Code

<?php
	$myTree->singleExpand=true;//Keep only one node expand 
?>

Supported from version: 1.0.0.0

styleFolderTop

string styleFolder

Get or set folder which contain css style for treeview.

Show/Hide Code

<?php
	$myTree->styleFolder="kooltreeview/styles/default";//Use the "default" style 
?>

Supported from version: 1.0.0.0

widthTop

string width

Get or set the width for treeview

Show/Hide Code

<?php
	$myTree->width="100px";//Specify width by pixels 
	$myTree->width="100%";//Specify width by percent 
?>

Supported from version: 1.0.0.0

AddTop

TreeNode Add(string $parentid, string $id, string $html, [bool $expand], [string $imageSrc], [string $subTreeUrl])

Add a node to tree

Show/Hide Code

<?php
	$kTree->Add("root","subnode","Sub Node",true,"Page.gif","theSubtree.php"); 
	//Add the child with text="Sub Node" and id="subnode" to the root node
	//The nodes expands at his initial state 
	//The node has page.gif in front of text 
	//When the node is open, the "theSubTree.php" will be loaded and put under "subnode" node 
?>

Supported from version: 1.0.0.0

getRootNodeTop

TreeNode getRootNode()

Return the root node object.

Show/Hide Code

<?php
...
$root = $treeview->getRootNode();
$root->showPlusMinus = true;
...	
?>

Supported from version: 1.0.0.0

getNodeTop

TreeNode getNode(string $nodeid)

Return tree node object.

Show/Hide Code

<?php
...
$treeview->Add("root","intro","Introduction");
...
$intro_node = $treeview->getNode("intro"); //Get intro node object.
$intro_node->expand = true; 
...	
?>

Supported from version: 2.0.0.0

RenderTop

void Render()

Render the treeview

Show/Hide Code

<body>
	<?php echo $myTree->Render();?>
</body>

Supported from version: 1.0.0.0

RegisterScriptTop

string RegisterScript()

Return html to register js library for treeview.

Show/Hide Code

<head>
    <?php echo $myTree->RegisterScript();?>
</head>

Supported from version: 1.0.0.0

RegisterCSSTop

string RegisterCSS()

Return html to register CSS for treeview

Show/Hide Code

<head>
    <?php echo $myTree->RegisterCSS();?>
</head>

Supported from version: 1.0.0.0

RenderTreeTop

string RenderTree()

Return html content of treeview body

Show/Hide Code

<body>
    <?php echo $myTree->RenderTree();?>
</body>

Supported from version: 1.0.0.0

StartupScriptTop

string StartupScript()

Return js code to inititate treeview

Show/Hide Code

<script type="text/javascript">
    <?php echo $myTree->StartupScript();?>
</script>

Supported from version: 1.0.0.0

KoolTreeView Class [PHP]

Summary

Properties Detail

Methods Detail