Class SS.control.tree

SS.control.tree
Defined in: SS.control.tree.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	SS.control.tree(name, value, title, css, id)

Field Summary
Field Attributes	Field Name and Description
	cache Boolean flag.
	css Style sheet class applied to the tree.
	css_iconclosed Style sheet class for a closed branch icon.
	css_iconopen Style sheet class for an open branch icon.
	css_selected Style sheet class for a closed branch icon.
	iconmode Sets how and when the icon should be displayed.
	id Identifier of the tree control.
	node Array of trees.
	onclick Function called or evaluated {String} whenever a tree node has been clicked.
	oncontextmenu Function called or evaluated {String} when a right click mouse event occurs.
	open Flag indicating if the node is open.
	parent Parent tree.
	root Root element.
	selected Selected element.
	src URL which when called should return a list of nodes that can be added to the tree.
	srcparam Name of the parameter which is attached to the URL containing the value of the parent node.
	xnode_iconmode XML override icon mode.
	xnode_name XML node name.
	xnode_title XML node title.
	xnode_value XML node vaule.
	xpath_nodes Defines the path to the list of nodes.

Method Summary
Method Attributes	Method Name and Description
	addNode(n) Add tree as a child node
	clear() Clears the tree.
	getNodes(v) Inital requests for tree nodes from the data source.
	getSelected() Returns the current selected node.
	loadNodes(r) Parses the nodes loaded from the data source and stores them in an internal array.
	openPath() Opens up all parent nodes in the path of this node until the root is reach of the rendered tree.
	render(al)

Class Detail

SS.control.tree(name, value, title, css, id)

Parameters:
name
value
title
css
id

Field Detail

cache

Boolean flag. If true then nodes are cached when using data from a URL. Setting this to false will always cause the nodes to be refreshed by the data returned by the action of querying the URL as defined in src. Default = "false".

css

Style sheet class applied to the tree. Default = "".

css_iconclosed

Style sheet class for a closed branch icon. Default = "SS_control_tree_icon_closed".

css_iconopen

Style sheet class for an open branch icon. Default = "SS_control_tree_icon_open".

css_selected

Style sheet class for a closed branch icon. Default = "SS_control_tree_branch_selected".

iconmode

Sets how and when the icon should be displayed. 0: Do not display an icon. 1: Always display an icon. 2: Display an icon if sub-nodes exist. Negative Boolean Value: Do not display icon. Positive Boolean Value: Display icon. Default = 2.

Identifier of the tree control.

node

Array of trees. a single noded item is a valid tree Default = [].

onclick

Function called or evaluated {String} whenever a tree node has been clicked.

oncontextmenu

Function called or evaluated {String} when a right click mouse event occurs.

open

Flag indicating if the node is open. Default = "false".

parent

Parent tree. Null if this is the root tree.

root

Root element.

selected

Selected element.

src

URL which when called should return a list of nodes that can be added to the tree.

srcparam

Name of the parameter which is attached to the URL containing the value of the parent node. Default = "v".

xnode_iconmode

XML override icon mode. Default = "".

xnode_name

XML node name. Default = "".

xnode_title

XML node title. Default = "".

xnode_value

XML node vaule. Default = "".

xpath_nodes

Defines the path to the list of nodes. Default = "".

Method Detail

addNode(n)

Add tree as a child node

Parameters:
{SS.control.tree} n

Returns:: null

clear()

Clears the tree.

Returns:: null

getNodes(v)

Inital requests for tree nodes from the data source.

Parameters:
{String} v: Value of the selected node.

Returns:: null

getSelected()

Returns the current selected node.

Returns:: Current selected node

loadNodes(r)

Parses the nodes loaded from the data source and stores them in an internal array.

Parameters:
{SS.net.requestor} r: Requestor object from a valid request.

Returns:: null

openPath()

Opens up all parent nodes in the path of this node until the root is reach of the rendered tree.

Returns:: null

render(al)

Parameters:
al

Classes

Classes

Class SS.control.tree