Class: PhpExt_Tree_TreeNode

Source Location: /PhpExt/Tree/TreeNode.php

Class PhpExt_Tree_TreeNode

Class Overview

Located in /PhpExt/Tree/TreeNode.php [line 24]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Data_Node
         |
         --PhpExt_Tree_TreeNode

Methods

[ Top ]

Descendants

Child Class	Description
PhpExt_Tree_AsyncTreeNode

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Observable

PhpExt_Observable::$_listeners

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName

PhpExt_Object::$_extConfigProperties

PhpExt_Object::$_validExtConfigProperties

PhpExt_Object::$_varName

Inherited From PhpExt_Data_Node

PhpExt_Data_Node::__construct()

PhpExt_Data_Node::getId()

The id for this node. If one is not specified, one is generated.

PhpExt_Data_Node::getLeaf()

true if this node is a leaf and does not have children

PhpExt_Data_Node::setId()

The id for this node. If one is not specified, one is generated.

PhpExt_Data_Node::setLeaf()

true if this node is a leaf and does not have children

Inherited From PhpExt_Observable

PhpExt_Observable::__construct()

PhpExt_Observable::attachListener()

Adds a PhpExt_Listener to the specified $eventName. This lintener will execute when the Javascript object fires that event.

PhpExt_Observable::getConfigParams()

PhpExt_Observable::getListeners()

Inherited From PhpExt_Object

PhpExt_Object::__construct()

PhpExt_Object::addValidConfigProperties()

PhpExt_Object::createMethodSignature()

PhpExt_Object::getConfigParams()

PhpExt_Object::getExtConfigProperty()

PhpExt_Object::getJavascript()

PhpExt_Object::getMethodInvokeStm()

PhpExt_Object::isExtObject()

PhpExt_Object::paramToString()

PhpExt_Object::setExtClassInfo()

PhpExt_Object::setExtConfigProperty()

PhpExt_Object::__get()

PhpExt_Object::__set()

[ Top ]

Method Summary

PhpExt_Tree_TreeNode	__construct()
void	collapse()	Collapse this node.
void	collapseChildNodes()	Collapse all child nodes
void	disable()	Disables this node
void	enable()	Enables this node
void	ensureVisible()	Ensures all parent nodes are expanded, and if necessary, scrolls the node into view.
void	expand()	Expand this node.
void	expandChildNodes()	Expand all child nodes
boolean	getAllowChildren()	False to not allow this node to have child nodes (defaults to true)
boolean	getAllowDrag()	False to make this node undraggable if draggable = true (defaults to true)
boolean	getAllowDrop()	False if this node cannot have child nodes dropped on it (defaults to true)
boolean	getChecked()	True to render a checked checkbox for this node, false to render an unchecked checkbox (defaults to undefined with no checkbox rendered)
string	getCssClass()	A css class to be added to the node
boolean	getDisabled()	true to start the node disabled
boolean	getDraggable()	True to make this node draggable (defaults to false)
boolean	getExpandable()	If set to true, the node will always show a plus/minus icon, even when empty
boolean	getExpanded()	true to start the node expanded
string	getHref()	URL of the link used for the node (defaults to #)
string	getHrefTarget()	target frame for the link
string	getIcon()	The path to an icon for the node. The preferred way to do this is to use the cls or iconCls attributes and add the icon via a CSS background image.
string	getIconCssClass()	A css class to be added to the nodes icon element for applying css background images
boolean	getIsTarget()	False to not allow this node to act as a drop target (defaults to true)
string	getQTip()	An Ext QuickTip for the node
PhpExt_QuickTip	getQuickTipConfig()	An Ext QuickTip config for the node (used instead of qtip)
boolean	getSingleClickExpand()	True for single click expand on this node
string	getText()	The text for this node
PhpExt_Tree_TreeNodeUI	getUiProvider()	A UI class to use for this node (defaults to Ext.tree.TreeNodeUI)
void	select()	Triggers selection of this node
PhpExt_Tree_TreeNode	setAllowChildren()	False to not allow this node to have child nodes (defaults to true)
PhpExt_Tree_TreeNode	setAllowDrag()	False to make this node undraggable if draggable = true (defaults to true)
PhpExt_Tree_TreeNode	setAllowDrop()	False if this node cannot have child nodes dropped on it (defaults to true)
PhpExt_Tree_TreeNode	setChecked()	True to render a checked checkbox for this node, false to render an unchecked checkbox (defaults to undefined with no checkbox rendered)
PhpExt_Tree_TreeNode	setCssClass()	A css class to be added to the node
PhpExt_Tree_TreeNode	setDisabled()	true to start the node disabled
PhpExt_Tree_TreeNode	setDraggable()	True to make this node draggable (defaults to false)
PhpExt_Tree_TreeNode	setExpandable()	If set to true, the node will always show a plus/minus icon, even when empty
PhpExt_Tree_TreeNode	setExpanded()	true to start the node expanded
PhpExt_Tree_TreeNode	setHref()	URL of the link used for the node (defaults to #)
PhpExt_Tree_TreeNode	setHrefTarget()	target frame for the link
PhpExt_Tree_TreeNode	setIcon()	The path to an icon for the node. The preferred way to do this is to use the cls or iconCls attributes and add the icon via a CSS background image.
PhpExt_Tree_TreeNode	setIconCssClass()	A css class to be added to the nodes icon element for applying css background images
PhpExt_Tree_TreeNode	setIsTarget()	False to not allow this node to act as a drop target (defaults to true)
PhpExt_Tree_TreeNode	setQTip()	An Ext QuickTip for the node
PhpExt_Tree_TreeNode	setQuickTipConfig()	An Ext QuickTip config for the node (used instead of qtip)
PhpExt_Tree_TreeNode	setSingleClickExpand()	True for single click expand on this node
PhpExt_Tree_TreeNode	setText()	The text for this node
PhpExt_Tree_TreeNode	setUiProvider()	A UI class to use for this node (defaults to Ext.tree.TreeNodeUI)
void	toggle()	Toggles expanded/collapsed state of the node
void	unselect()	Triggers deselection of this node

[ Top ]

Properties

Methods

Constructor __construct [line 370]

PhpExt_Tree_TreeNode __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Data_Node::__construct()

Redefined in descendants as:

PhpExt_Tree_AsyncTreeNode::__construct()

[ Top ]

collapse [line 406]

void collapse(
[boolean
$deep = false], [boolean
$anim = true] 
)

Collapse this node.

Parameters:

boolean	$deep:	(optional) True to collapse all children as well
boolean	$anim:	(optional) false to cancel the default animation

API Tags:

Access:

public

[ Top ]

collapseChildNodes [line 416]

void collapseChildNodes(
[boolean
$deep = false] 
)

Collapse all child nodes

Parameters:

boolean

$deep:

(optional) true if the child nodes should also collapse their child nodes

API Tags:

Access:

public

[ Top ]

disable [line 425]

void disable(
)

Disables this node

API Tags:

Access:

public

[ Top ]

enable [line 433]

void enable(
)

Enables this node

API Tags:

Access:

public

[ Top ]

ensureVisible [line 441]

void ensureVisible(
)

Ensures all parent nodes are expanded, and if necessary, scrolls the node into view.

API Tags:

Access:

public

[ Top ]

expand [line 452]

void expand(
[boolean
$deep = false], [boolean
$anim = true], [PhpExt_Javascript
$callback = null] 
)

Expand this node.

Parameters:

boolean	$deep:	(optional) True to expand all children as well
boolean	$anim:	(optional) false to cancel the default animation
PhpExt_Javascript	$callback:	(optional) A callback to be called when expanding this node completes (does not wait for deep expand to complete). Called with 1 parameter, this node.

API Tags:

Access:

public

[ Top ]

expandChildNodes [line 462]

void expandChildNodes(
[boolean
$deep = false] 
)

Expand all child nodes

Parameters:

boolean

$deep:

(optional) true if the child nodes should also expand their child nodes

API Tags:

Access:

public

[ Top ]

getAllowChildren [line 40]

boolean getAllowChildren(
)

False to not allow this node to have child nodes (defaults to true)

API Tags:

Access:

public

[ Top ]

getAllowDrag [line 58]

boolean getAllowDrag(
)

False to make this node undraggable if draggable = true (defaults to true)

API Tags:

Access:

public

[ Top ]

getAllowDrop [line 76]

boolean getAllowDrop(
)

False if this node cannot have child nodes dropped on it (defaults to true)

API Tags:

Access:

public

[ Top ]

getChecked [line 94]

boolean getChecked(
)

True to render a checked checkbox for this node, false to render an unchecked checkbox (defaults to undefined with no checkbox rendered)

API Tags:

Access:

public

[ Top ]

getCssClass [line 112]

string getCssClass(
)

A css class to be added to the node

API Tags:

Access:

public

[ Top ]

getDisabled [line 130]

boolean getDisabled(
)

true to start the node disabled

API Tags:

Access:

public

[ Top ]

getDraggable [line 148]

boolean getDraggable(
)

True to make this node draggable (defaults to false)

API Tags:

Access:

public

[ Top ]

getExpandable [line 166]

boolean getExpandable(
)

If set to true, the node will always show a plus/minus icon, even when empty

API Tags:

Access:

public

[ Top ]

getExpanded [line 184]

boolean getExpanded(
)

true to start the node expanded

API Tags:

Access:

public

[ Top ]

getHref [line 202]

string getHref(
)

URL of the link used for the node (defaults to #)

API Tags:

Access:

public

[ Top ]

getHrefTarget [line 220]

string getHrefTarget(
)

target frame for the link

API Tags:

Access:

public

[ Top ]

getIcon [line 238]

string getIcon(
)

The path to an icon for the node. The preferred way to do this is to use the cls or iconCls attributes and add the icon via a CSS background image.

API Tags:

Access:

public

[ Top ]

getIconCssClass [line 256]

string getIconCssClass(
)

A css class to be added to the nodes icon element for applying css background images

API Tags:

Access:

public

[ Top ]

getIsTarget [line 274]

boolean getIsTarget(
)

False to not allow this node to act as a drop target (defaults to true)

API Tags:

Access:

public

[ Top ]

getQTip [line 292]

string getQTip(
)

An Ext QuickTip for the node

API Tags:

Access:

public

[ Top ]

getQuickTipConfig [line 310]

PhpExt_QuickTip getQuickTipConfig(
)

An Ext QuickTip config for the node (used instead of qtip)

API Tags:

Access:

public

[ Top ]

getSingleClickExpand [line 328]

boolean getSingleClickExpand(
)

True for single click expand on this node

API Tags:

Access:

public

[ Top ]

getText [line 346]

string getText(
)

The text for this node

API Tags:

Access:

public

[ Top ]

getUiProvider [line 364]

PhpExt_Tree_TreeNodeUI getUiProvider(
)

A UI class to use for this node (defaults to Ext.tree.TreeNodeUI)

API Tags:

Access:

public

[ Top ]

select [line 471]

void select(
)

Triggers selection of this node

API Tags:

Access:

public

[ Top ]

setAllowChildren [line 32]

PhpExt_Tree_TreeNode setAllowChildren(
boolean
$value 
)

False to not allow this node to have child nodes (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setAllowDrag [line 50]

PhpExt_Tree_TreeNode setAllowDrag(
boolean
$value 
)

False to make this node undraggable if draggable = true (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setAllowDrop [line 68]

PhpExt_Tree_TreeNode setAllowDrop(
boolean
$value 
)

False if this node cannot have child nodes dropped on it (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setChecked [line 86]

PhpExt_Tree_TreeNode setChecked(
boolean
$value 
)

True to render a checked checkbox for this node, false to render an unchecked checkbox (defaults to undefined with no checkbox rendered)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setCssClass [line 104]

PhpExt_Tree_TreeNode setCssClass(
string
$value 
)

A css class to be added to the node

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setDisabled [line 122]

PhpExt_Tree_TreeNode setDisabled(
boolean
$value 
)

true to start the node disabled

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setDraggable [line 140]

PhpExt_Tree_TreeNode setDraggable(
boolean
$value 
)

True to make this node draggable (defaults to false)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setExpandable [line 158]

PhpExt_Tree_TreeNode setExpandable(
boolean
$value 
)

If set to true, the node will always show a plus/minus icon, even when empty

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setExpanded [line 176]

PhpExt_Tree_TreeNode setExpanded(
boolean
$value 
)

true to start the node expanded

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setHref [line 194]

PhpExt_Tree_TreeNode setHref(
string
$value 
)

URL of the link used for the node (defaults to #)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setHrefTarget [line 212]

PhpExt_Tree_TreeNode setHrefTarget(
string
$value 
)

target frame for the link

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setIcon [line 230]

PhpExt_Tree_TreeNode setIcon(
string
$value 
)

The path to an icon for the node. The preferred way to do this is to use the cls or iconCls attributes and add the icon via a CSS background image.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setIconCssClass [line 248]

PhpExt_Tree_TreeNode setIconCssClass(
string
$value 
)

A css class to be added to the nodes icon element for applying css background images

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setIsTarget [line 266]

PhpExt_Tree_TreeNode setIsTarget(
boolean
$value 
)

False to not allow this node to act as a drop target (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setQTip [line 284]

PhpExt_Tree_TreeNode setQTip(
string
$value 
)

An Ext QuickTip for the node

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setQuickTipConfig [line 302]

PhpExt_Tree_TreeNode setQuickTipConfig(
PhpExt_QuickTip
$value 
)

An Ext QuickTip config for the node (used instead of qtip)

Parameters:

PhpExt_QuickTip

$value:

API Tags:

Access:

public

[ Top ]

setSingleClickExpand [line 320]

PhpExt_Tree_TreeNode setSingleClickExpand(
boolean
$value 
)

True for single click expand on this node

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setText [line 338]

PhpExt_Tree_TreeNode setText(
string
$value 
)

The text for this node

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setUiProvider [line 356]

PhpExt_Tree_TreeNode setUiProvider(
PhpExt_Tree_TreeNodeUI
$value 
)

A UI class to use for this node (defaults to Ext.tree.TreeNodeUI)

Parameters:

PhpExt_Tree_TreeNodeUI

$value:

API Tags:

Access:

public

[ Top ]

toggle [line 479]

void toggle(
)

Toggles expanded/collapsed state of the node

API Tags:

Access:

public

[ Top ]

unselect [line 487]

void unselect(
)

Triggers deselection of this node

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 16:02:02 -0500 by phpDocumentor 1.4.0