Jx.TreeFolder

A Jx.TreeFolder is an item in a tree that can contain other items. It is expandable and collapsible.

Example

Extends

License

This file is licensed under an MIT style license

Summary

Jx.TreeFolder	Extends: Jx.TreeItem
Properties
subDomObj	{HTMLElement} an HTML container for the things inside the folder
nodes	{Array} an array of references to the javascript objects that are children of this folder
Options
open	is the folder open?
Constructor
Jx.TreeFolder	Create a new instance of Jx.TreeFolder
Functions
finalize	Clean up a TreeFolder.
finalizeFolder	Internal method to clean up folder-related stuff.
clone	Create a clone of the TreeFolder
isLastNode	Indicates if a node is the last thing in the folder.
update	Update the CSS of the TreeFolder’s DOM element in case it has changed position.
append	append a node at the end of the sub-tree
insert	insert a node after refNode.
remove	remove the specified node from the tree
replace	Replace a node with another node
clicked	handle the user clicking on this folder by expanding or collapsing it.
expand	Expands the folder
collapse	Collapses the folder
findChild	Get a reference to a child node by recursively searching the tree

Properties

subDomObj

{HTMLElement} an HTML container for the things inside the folder

nodes

{Array} an array of references to the javascript objects that are children of this folder

Options

open

is the folder open? false by default.

Constructor

Jx.TreeFolder

Create a new instance of Jx.TreeFolder

Parameters

options

Jx.TreeFolder.Options and Jx.TreeItem.Options

Functions

finalize

finalize: function()

Clean up a TreeFolder.

finalizeFolder

finalizeFolder: function()

Internal method to clean up folder-related stuff.

clone

clone : function()

Create a clone of the TreeFolder

Returns

{Jx.TreeFolder} a copy of the TreeFolder

isLastNode

isLastNode : function( node )

Indicates if a node is the last thing in the folder.

Parameters

node	{Jx.TreeItem} the node to check

Returns

{Boolean}

update

update : function( shouldDescend )

Update the CSS of the TreeFolder’s DOM element in case it has changed position.

Parameters

shouldDescend

{Boolean} propagate changes to child nodes?

append

append : function( node )

append a node at the end of the sub-tree

Parameters

node	{Object} the node to append.

insert

insert : function( node,
refNode )

insert a node after refNode. If refNode is null, insert at beginning

Parameters

node	{Object} the node to insert
refNode	{Object} the node to insert before

remove

remove : function( node )

remove the specified node from the tree

Parameters

node	{Object} the node to remove

replace

replace: function( newNode,
refNode )

Replace a node with another node

Parameters

newNode	{Object} the node to put into the tree
refNode	{Object} the node to replace

Returns

{Boolean} true if the replacement was successful.

clicked

clicked : function( e )

handle the user clicking on this folder by expanding or collapsing it.

Parameters

e	{Event} the event object

expand

expand : function()

Expands the folder

collapse

collapse : function()

Collapses the folder

findChild

findChild : function( path )

Get a reference to a child node by recursively searching the tree

Parameters

path	{Array} an array of labels of nodes to search for

Returns

{Object} the node or null if the path was not found