webgui/www/extras/yui/docs/YAHOO.widget.Node.html
2008-03-25 16:13:25 +00:00

2410 lines
117 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: treeview YAHOO.widget.Node (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>TreeView Widget&nbsp; <span class="subtitle">2.5.1</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_treeview.html">treeview</a>
&gt; YAHOO.widget.Node
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> Show Private</span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
</form>
<h2>
Class <b>YAHOO.widget.Node</b>
<span class="extends">
</span>
<span class="extends">
- uses
<a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>
</span>
</code>
</h2>
<!-- class tree goes here -->
<dl class="subclasses">
<dt>Known Subclasses:</dd>
<dd>
<a href="YAHOO.widget.TextNode.html">YAHOO.widget.TextNode</a>
<a href="YAHOO.widget.HTMLNode.html">YAHOO.widget.HTMLNode</a>
<a href="YAHOO.widget.RootNode.html">YAHOO.widget.RootNode</a>
</dd>
</dl>
<div class="summary description">
The base class for all tree nodes. The node's presentation and behavior in
response to mouse events is handled in Node subclasses.
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.Node</strong>
<code>
(
oData
,
oParent
,
expanded
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oData
&lt;object&gt;
</code>
a string or object containing the data that will
be used to render this node, and any custom attributes that should be
stored with the node (which is available in noderef.data).
</dd>
<dd>
<code>oParent
&lt;Node&gt;
</code>
this node's parent node
</dd>
<dd>
<code>expanded
&lt;boolean&gt;
</code>
the initial expanded/collapsed state
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private">
<h4><a name="property__dynLoad">_dynLoad</a>
<code>- private boolean</code>
</h4>
<div class="detail">
<div class="description">
We can set the node up to call an external method to get the child
data dynamically.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__type">_type</a>
<code>- private object</code>
</h4>
<div class="detail">
<div class="description">
The node type
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_children">children</a>
<code>- Node[]</code>
</h4>
<div class="detail">
<div class="description">
This node's child node collection.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_childrenRendered">childrenRendered</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
This flag is set to true when the html is generated for this node's
children, and set to false when new children are added.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_data">data</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
The data linked to this node. This can be any object or primitive
value, and the data can be used in getNodeHtml().
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_dataLoader">dataLoader</a>
<code>- function</code>
</h4>
<div class="detail">
<div class="description">
Function to execute when we need to get this node's child data.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_depth">depth</a>
<code>- int</code>
</h4>
<div class="detail">
<div class="description">
The depth of this node. We start at -1 for the root node.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_dynamicLoadComplete">dynamicLoadComplete</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
Dynamically loaded nodes only fetch the data the first time they are
expanded. This flag is set to true once the data has been fetched.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_expanded">expanded</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
The node's expanded/collapsed state
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_hasIcon">hasIcon</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
The toggle/branch icon will not show if this is set to false. This
could be useful if the implementer wants to have the child contain
extra info about the parent, rather than an actual node.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_href">href</a>
<code>- string</code>
</h4>
<div class="detail">
<div class="description">
The href for the node's label. If one is not specified, the href will
be set so that it toggles the node.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_iconMode">iconMode</a>
<code>- int</code>
</h4>
<div class="detail">
<div class="description">
Used to configure what happens when a dynamic load node is expanded
and we discover that it does not have children. By default, it is
treated as if it still could have children (plus/minus icon). Set
iconMode to have it display like a leaf node instead.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_index">index</a>
<code>- int</code>
</h4>
<div class="detail">
<div class="description">
The index for this instance obtained from global counter in YAHOO.widget.TreeView.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_isLeaf">isLeaf</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
If true, the node will alway be rendered as a leaf node. This can be
used to override the presentation when dynamically loading the entire
tree. Setting this to true also disables the dynamic load call for the
node.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="property_isLoading">isLoading</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
This is true for dynamically loading nodes while waiting for the
callback to return.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_multiExpand">multiExpand</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
Can multiple children be expanded at once?
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_nextSibling">nextSibling</a>
<code>- Node</code>
</h4>
<div class="detail">
<div class="description">
This node's next sibling
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_nowrap">nowrap</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
Specifies whether or not the content area of the node should be allowed
to wrap.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="property_parent">parent</a>
<code>- Node</code>
</h4>
<div class="detail">
<div class="description">
Parent node
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_previousSibling">previousSibling</a>
<code>- Node</code>
</h4>
<div class="detail">
<div class="description">
This node's previous sibling
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_renderHidden">renderHidden</a>
<code>- boolean</code>
</h4>
<div class="detail">
<div class="description">
Should we render children for a collapsed node? It is possible that the
implementer will want to render the hidden data... @todo verify that we
need this, and implement it if we do.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_target">target</a>
<code>- string</code>
</h4>
<div class="detail">
<div class="description">
The label href target, defaults to current window
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_tree">tree</a>
<code>- TreeView</code>
</h4>
<div class="detail">
<div class="description">
Tree instance this node is part of
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_events">__yui_events</a><span class="private">,</span>
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_subscribers">__yui_subscribers</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private">
<h4>
<a name="method_appendChild">appendChild</a></h4>
<div class="detail">
<code>
private
Node
<strong>appendChild</strong>
(
childNode
)
</code>
<div class="description">
Appends a node to the child collection.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>childNode &lt;Node&gt;</code>
the new node
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Node
</code></dt>
<dd>the child node</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_appendTo">appendTo</a></h4>
<div class="detail">
<code>
Node
<strong>appendTo</strong>
(
parentNode
)
</code>
<div class="description">
Appends this node to the supplied node's child collection
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>parentNode &lt;Node&gt;</code>
the node to append to.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Node
</code></dt>
<dd>The appended node</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_applyParent">applyParent</a></h4>
<div class="detail">
<code>
boolean
<strong>applyParent</strong>
(
parentNode
)
</code>
<div class="description">
Certain properties for the node cannot be set until the parent
is known. This is called after the node is inserted into a tree.
the parent is also applied to this node's children in order to
make it possible to move a branch from one tree to another.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>parentNode &lt;Node&gt;</code>
this node's parent node
</dd>
</dl>
<dl>
<dt>Returns:
<code>
boolean
</code></dt>
<dd>true if the application was successful</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_collapse
toggle style.">collapse
toggle style.</a></h4>
<div class="detail">
<code>
void
<strong>collapse
toggle style.</strong>
(
)
</code>
<div class="description">
Hides this nodes children (creating them if necessary), changes the
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_collapseAll">collapseAll</a></h4>
<div class="detail">
<code>
void
<strong>collapseAll</strong>
(
)
</code>
<div class="description">
Recursively collapses all of this node's children.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_completeRender">completeRender</a></h4>
<div class="detail">
<code>
string
<strong>completeRender</strong>
(
)
</code>
<div class="description">
Called when we know we have all the child data.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>children html</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_expand">expand</a></h4>
<div class="detail">
<code>
void
<strong>expand</strong>
(
)
</code>
<div class="description">
Shows this nodes children (creating them if necessary), changes the
toggle style, and collapses its siblings if multiExpand is not set.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_expandAll">expandAll</a></h4>
<div class="detail">
<code>
void
<strong>expandAll</strong>
(
)
</code>
<div class="description">
Recursively expands all of this node's children.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getAncestor">getAncestor</a></h4>
<div class="detail">
<code>
Node
<strong>getAncestor</strong>
(
depth
)
</code>
<div class="description">
Returns this node's ancestor at the specified depth.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>depth &lt;int&gt;</code>
the depth of the ancestor.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Node
</code></dt>
<dd>the ancestor</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getChildrenEl">getChildrenEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getChildrenEl</strong>
(
)
</code>
<div class="description">
Returns the div that was generated for this node's children
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>this node's children div</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getChildrenElId">getChildrenElId</a></h4>
<div class="detail">
<code>
string
<strong>getChildrenElId</strong>
(
)
</code>
<div class="description">
Returns the id for this node's children div
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>the element id for this node's children div</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_getChildrenHtml">getChildrenHtml</a></h4>
<div class="detail">
<code>
private
string
<strong>getChildrenHtml</strong>
(
)
</code>
<div class="description">
Called when first rendering the tree. We always build the div that will
contain this nodes children, but we don't render the children themselves
unless this node is expanded.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>the children container div html and any expanded children</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getDepthStyle">getDepthStyle</a></h4>
<div class="detail">
<code>
string
<strong>getDepthStyle</strong>
(
depth
)
</code>
<div class="description">
Returns the css class for the spacer at the specified depth for
this node. If this node's ancestor at the specified depth
has a next sibling the presentation is different than if it
does not have a next sibling
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>depth &lt;int&gt;</code>
the depth of the ancestor.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>the css class for the spacer</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getEl">getEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getEl</strong>
(
)
</code>
<div class="description">
Returns this node's container html element
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>the container html element</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getElId">getElId</a></h4>
<div class="detail">
<code>
string
<strong>getElId</strong>
(
)
</code>
<div class="description">
Returns the id for this node's container div
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>the element id</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getHoverStyle">getHoverStyle</a></h4>
<div class="detail">
<code>
string
<strong>getHoverStyle</strong>
(
)
</code>
<div class="description">
Returns the hover style for the icon
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>the css class hover state</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getHtml">getHtml</a></h4>
<div class="detail">
<code>
string
<strong>getHtml</strong>
(
)
</code>
<div class="description">
Returns the markup for this node and its children.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>the markup for this node and its expanded children.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getIconMode">getIconMode</a></h4>
<div class="detail">
<code>
int
<strong>getIconMode</strong>
(
)
</code>
<div class="description">
Returns the current icon mode. This refers to the way childless dynamic
load nodes appear (this comes into play only after the initial dynamic
load request produced no children).
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
int
</code></dt>
<dd>0 for collapse style, 1 for leaf node style</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getNodeHtml">getNodeHtml</a></h4>
<div class="detail">
<code>
string
<strong>getNodeHtml</strong>
(
)
</code>
<div class="description">
Get the markup for the node. This is designed to be overrided so that we can
support different types of nodes.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>The HTML that will render this node.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getSiblings">getSiblings</a></h4>
<div class="detail">
<code>
void
<strong>getSiblings</strong>
(
)
</code>
<div class="description">
Returns a node array of this node's siblings, null if none.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd>Node[]</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getStyle">getStyle</a></h4>
<div class="detail">
<code>
string
<strong>getStyle</strong>
(
)
</code>
<div class="description">
Returns the css style name for the toggle
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>the css class for this node's toggle</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getToggleEl">getToggleEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getToggleEl</strong>
(
)
</code>
<div class="description">
Returns the element that is being used for this node's toggle.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>this node's toggle html element</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getToggleElId">getToggleElId</a></h4>
<div class="detail">
<code>
string
<strong>getToggleElId</strong>
(
)
</code>
<div class="description">
Returns the id for this node's toggle element
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>the toggel element id</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getToggleLink">getToggleLink</a></h4>
<div class="detail">
<code>
string
<strong>getToggleLink</strong>
(
)
</code>
<div class="description">
Generates the link that will invoke this node's toggle method
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>the javascript url for toggling this node</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_hasChildren">hasChildren</a></h4>
<div class="detail">
<code>
boolean
<strong>hasChildren</strong>
(
checkForLazyLoad
)
</code>
<div class="description">
Checks if this node has children. If this node is lazy-loading and the
children have not been rendered, we do not know whether or not there
are actual children. In most cases, we need to assume that there are
children (for instance, the toggle needs to show the expandable
presentation state). In other times we want to know if there are rendered
children. For the latter, "checkForLazyLoad" should be false.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>checkForLazyLoad &lt;boolean&gt;</code>
should we check for unloaded children?
</dd>
</dl>
<dl>
<dt>Returns:
<code>
boolean
</code></dt>
<dd>true if this has children or if it might and we are
checking for this condition.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_hideChildren">hideChildren</a></h4>
<div class="detail">
<code>
void
<strong>hideChildren</strong>
(
)
</code>
<div class="description">
Hides this node's children
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_init">init</a></h4>
<div class="detail">
<code>
void
<strong>init</strong>
(
oData
,
oParent
,
expanded
)
</code>
<div class="description">
Initializes this node, gets some of the properties from the parent
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oData &lt;object&gt;</code>
a string or object containing the data that will
be used to render this node
</dd>
<dd>
<code>oParent &lt;Node&gt;</code>
this node's parent node
</dd>
<dd>
<code>expanded &lt;boolean&gt;</code>
the initial expanded/collapsed state
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_insertAfter">insertAfter</a></h4>
<div class="detail">
<code>
Node
<strong>insertAfter</strong>
(
node
)
</code>
<div class="description">
Inserts this node after the supplied node
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>node &lt;Node&gt;</code>
the node to insert after
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Node
</code></dt>
<dd>the inserted node</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_insertBefore">insertBefore</a></h4>
<div class="detail">
<code>
Node
<strong>insertBefore</strong>
(
node
)
</code>
<div class="description">
Inserts this node before this supplied node
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>node &lt;Node&gt;</code>
the node to insert this node before
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Node
</code></dt>
<dd>the inserted node</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_isChildOf">isChildOf</a></h4>
<div class="detail">
<code>
private
boolean
<strong>isChildOf</strong>
(
parentNode
)
</code>
<div class="description">
Returns true if the Node is a child of supplied Node
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>parentNode &lt;Node&gt;</code>
the Node to check
</dd>
</dl>
<dl>
<dt>Returns:
<code>
boolean
</code></dt>
<dd>The node index if this Node is a child of
supplied Node, else -1.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_isDynamic">isDynamic</a></h4>
<div class="detail">
<code>
boolean
<strong>isDynamic</strong>
(
)
</code>
<div class="description">
Evaluates if this node's children should be loaded dynamically. Looks for
the property both in this instance and the root node. If the tree is
defined to load all children dynamically, the data callback function is
defined in the root node
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
boolean
</code></dt>
<dd>true if this node's children are to be loaded dynamically</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_isRoot">isRoot</a></h4>
<div class="detail">
<code>
boolean
<strong>isRoot</strong>
(
)
</code>
<div class="description">
Evaluates if this node is the root node of the tree
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
boolean
</code></dt>
<dd>true if this is the root node</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_loadComplete">loadComplete</a></h4>
<div class="detail">
<code>
void
<strong>loadComplete</strong>
(
)
</code>
<div class="description">
Load complete is the callback function we pass to the data provider
in dynamic load situations.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_refresh">refresh</a></h4>
<div class="detail">
<code>
void
<strong>refresh</strong>
(
)
</code>
<div class="description">
Regenerates the html for this node and its children. To be used when the
node is expanded and new children have been added.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_renderChildren">renderChildren</a></h4>
<div class="detail">
<code>
private
string
<strong>renderChildren</strong>
(
)
</code>
<div class="description">
Generates the markup for the child nodes. This is not done until the node
is expanded.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>the html for this node's children</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setDynamicLoad">setDynamicLoad</a></h4>
<div class="detail">
<code>
void
<strong>setDynamicLoad</strong>
(
fmDataLoader
,
iconMode
)
</code>
<div class="description">
Configures this node for dynamically obtaining the child data
when the node is first expanded. Calling it without the callback
will turn off dynamic load for the node.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>fmDataLoader &lt;function&gt;</code>
the function that will be used to get the data.
</dd>
<dd>
<code>iconMode &lt;int&gt;</code>
configures the icon that is displayed when a dynamic
load node is expanded the first time without children. By default, the
"collapse" icon will be used. If set to 1, the leaf node icon will be
displayed.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_showChildren">showChildren</a></h4>
<div class="detail">
<code>
void
<strong>showChildren</strong>
(
)
</code>
<div class="description">
Shows this node's children
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toggle">toggle</a></h4>
<div class="detail">
<code>
void
<strong>toggle</strong>
(
)
</code>
<div class="description">
Expands if node is collapsed, collapses otherwise.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail">
<code>
string
<strong>toString</strong>
(
)
</code>
<div class="description">
Node toString
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
string
</code></dt>
<dd>string representation of the node</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.EventProvider.html#method_createEvent">createEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_fireEvent">fireEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_hasEvent">hasEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_subscribe">subscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribe">unsubscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribeAll">unsubscribeAll</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="">
<h4>
<a name="event_parentChange">parentChange</a></h4>
<div class="detail">
<code>
<strong>parentChange</strong>
(
)
</code>
<div class="description">
The parentChange event is fired when a parent element is applied
to the node. This is useful if you need to apply tree-level
properties to a tree that need to happen if a node is moved from
one tree to another.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</a></li>
<li class=""><a href="module_cookie.html">cookie</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class=""><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class=""><a href="module_layout.html">layout</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class="selected"><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="YAHOO.widget.HTMLNode.html">YAHOO.widget.HTMLNode</a></li>
<li class=""><a href="YAHOO.widget.MenuNode.html">YAHOO.widget.MenuNode</a></li>
<li class="selected"><a href="YAHOO.widget.Node.html">YAHOO.widget.Node</a></li>
<li class=""><a href="YAHOO.widget.RootNode.html">YAHOO.widget.RootNode</a></li>
<li class=""><a href="YAHOO.widget.TextNode.html">YAHOO.widget.TextNode</a></li>
<li class=""><a href="YAHOO.widget.TreeView.html">YAHOO.widget.TreeView</a></li>
<li class=""><a href="YAHOO.widget.TVAnim.html">YAHOO.widget.TVAnim</a></li>
<li class=""><a href="YAHOO.widget.TVFadeIn.html">YAHOO.widget.TVFadeIn</a></li>
<li class=""><a href="YAHOO.widget.TVFadeOut.html">YAHOO.widget.TVFadeOut</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="HTMLNode.js.html">HTMLNode.js</a></li>
<li class=""><a href="MenuNode.js.html">MenuNode.js</a></li>
<li class=""><a href="Node.js.html">Node.js</a></li>
<li class=""><a href="RootNode.js.html">RootNode.js</a></li>
<li class=""><a href="TextNode.js.html">TextNode.js</a></li>
<li class=""><a href="TreeView.js.html">TreeView.js</a></li>
<li class=""><a href="TVAnim.js.html">TVAnim.js</a></li>
<li class=""><a href="TVFadeIn.js.html">TVFadeIn.js</a></li>
<li class=""><a href="TVFadeOut.js.html">TVFadeOut.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property__dynLoad">_dynLoad</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class="private"><a href="#property__type">_type</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_children">children</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_childrenRendered">childrenRendered</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_data">data</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_dataLoader">dataLoader</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_depth">depth</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_dynamicLoadComplete">dynamicLoadComplete</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_expanded">expanded</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_hasIcon">hasIcon</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_href">href</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_iconMode">iconMode</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_index">index</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_isLeaf">isLeaf</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_isLoading">isLoading</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_multiExpand">multiExpand</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_nextSibling">nextSibling</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_nowrap">nowrap</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_parent">parent</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_previousSibling">previousSibling</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_renderHidden">renderHidden</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_target">target</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
<li class=""><a href="#property_tree">tree</a>
<!--<code>&lt;TreeView&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><!--<code>Node</code>-->
<a href="#method_appendChild">appendChild</a>
</li>
<li class=""><!--<code>Node</code>-->
<a href="#method_appendTo">appendTo</a>
</li>
<li class=""><!--<code>boolean</code>-->
<a href="#method_applyParent">applyParent</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_collapse
toggle style.">collapse
toggle style.</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_collapseAll">collapseAll</a>
</li>
<li class=""><!--<code>string</code>-->
<a href="#method_completeRender">completeRender</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_expand">expand</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_expandAll">expandAll</a>
</li>
<li class=""><!--<code>Node</code>-->
<a href="#method_getAncestor">getAncestor</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getChildrenEl">getChildrenEl</a>
</li>
<li class=""><!--<code>string</code>-->
<a href="#method_getChildrenElId">getChildrenElId</a>
</li>
<li class="private"><!--<code>string</code>-->
<a href="#method_getChildrenHtml">getChildrenHtml</a>
</li>
<li class=""><!--<code>string</code>-->
<a href="#method_getDepthStyle">getDepthStyle</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getEl">getEl</a>
</li>
<li class=""><!--<code>string</code>-->
<a href="#method_getElId">getElId</a>
</li>
<li class=""><!--<code>string</code>-->
<a href="#method_getHoverStyle">getHoverStyle</a>
</li>
<li class=""><!--<code>string</code>-->
<a href="#method_getHtml">getHtml</a>
</li>
<li class=""><!--<code>int</code>-->
<a href="#method_getIconMode">getIconMode</a>
</li>
<li class=""><!--<code>string</code>-->
<a href="#method_getNodeHtml">getNodeHtml</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_getSiblings">getSiblings</a>
</li>
<li class=""><!--<code>string</code>-->
<a href="#method_getStyle">getStyle</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getToggleEl">getToggleEl</a>
</li>
<li class=""><!--<code>string</code>-->
<a href="#method_getToggleElId">getToggleElId</a>
</li>
<li class=""><!--<code>string</code>-->
<a href="#method_getToggleLink">getToggleLink</a>
</li>
<li class=""><!--<code>boolean</code>-->
<a href="#method_hasChildren">hasChildren</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_hideChildren">hideChildren</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_init">init</a>
</li>
<li class=""><!--<code>Node</code>-->
<a href="#method_insertAfter">insertAfter</a>
</li>
<li class=""><!--<code>Node</code>-->
<a href="#method_insertBefore">insertBefore</a>
</li>
<li class="private"><!--<code>boolean</code>-->
<a href="#method_isChildOf">isChildOf</a>
</li>
<li class=""><!--<code>boolean</code>-->
<a href="#method_isDynamic">isDynamic</a>
</li>
<li class=""><!--<code>boolean</code>-->
<a href="#method_isRoot">isRoot</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_loadComplete">loadComplete</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_refresh">refresh</a>
</li>
<li class="private"><!--<code>string</code>-->
<a href="#method_renderChildren">renderChildren</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setDynamicLoad">setDynamicLoad</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_showChildren">showChildren</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_toggle">toggle</a>
</li>
<li class=""><!--<code>string</code>-->
<a href="#method_toString">toString</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_parentChange">parentChange</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>