+++ /dev/null
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-
- <head>
- <meta http-equiv="content-type" content="text/html; charset=undefined" />
- <meta name="generator" content="JsDoc Toolkit" />
-
-
- <title>JsDoc Reference - Roo.data.Tree</title>
-
-
- <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
- <link rel="stylesheet" type="text/css" href="../default.css" />
-
-
- <script type="text/javascript" src="../page.js">
-
- </script>
-
-
- </head>
-
- <body onload="RooDocsPage.onload();">
-
-
-<div class="body-wrap">
-
- <!-- ============================== links to methods. ================================= -->
-
- <div class="top-tools">
- <!--
- <a class="inner-link" href="#Roo.data.Tree-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Roo.data.Tree-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Roo.data.Tree-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Roo.data.Tree-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
- -->
- </div>
-
-
-<!-- ============================== inheritance Block. ================================= -->
-
- <div class="inheritance res-block">
- <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-<img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.data.Tree
-
- </pre>
- </div>
-
-<!-- ============================== class title / details ============================ -->
-
-
- <h1 class="classTitle">
-
- Class Roo.data.Tree
- </h1>
-
- <table cellspacing="0" class="class-summary-table">
-
- <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
-
- <tr><td class="label">Defined In:</td><td class="hd-info">
-
- <a href="./src/Roo_data_Tree.js.html">Roo/data/Tree.js</a>.
-
- </td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">Tree</td></tr>
-
-
- <tr><td class="label">Subclasses:</td><td class="hd-info">
- <a href="./Roo.tree.TreePanel.html#constructor" roo:cls="Roo.tree.TreePanel.html#constructor">Roo.tree.TreePanel</a>
-
-
-
- </td></tr>
-
-
-
- <tr><td class="label">Extends:</td><td class="hd-info">
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td></tr>
-
-
- </table>
-
-
-<!-- ============================== class summary ========================== -->
- <div class="description">
- Represents a tree data structure and bubbles all the events for its nodes. The nodes<br/>in the tree have most standard DOM functionality.
- </div>
-
-
-<!-- ============================== Class comment block... ========================== -->
-
-<div class="comments">
- <b>Class Comments / Notes</B> =>
- <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.Tree';">[Add Your comment/notes about this class]</u>
- <br/>
- <iframe frameborder="0" id="comments-Roo.data" style="border: none;width:100%;"
- src="/blog.php/GtkDjsComments/Roo.data.Tree.html"></iframe>
-</div>
-
-
-
-<!-- ============================== config options ========================== -->
-
-
-
-
- <div class="hr"></div>
- <a id="Roo.data.Tree-configs"></a>
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption>Config Options (Usually are also Properties)</caption>
-
-
- <tr>
- <th class="sig-header" colspan="2">Options</th>
-
- <th class="msource-header">Defined By</th>
- </tr>
-
-
-
-
-
- <tr class="config-row expandable config-row-alt0">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
- <div class="fixedFont">
- <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre>
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- </table>
-
-
-
-
-
-
-
-
-
- <!-- ============================== public properties ==================== -->
-
-
-
- <a id="Roo.data.Tree-props"></a>
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption class="Empty">Public Properties - Has None</caption>
- </table>
-
-
-
-
- <!-- ============================== methods summary / details ======================== -->
-
-
- <a id="Roo.data.Tree-methods"></a>
- <!-- constructor?? -->
-
- <!-- static's first
-
-
- -->
-
- <!-- then dynamics first -->
-
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption>Public Methods</caption>
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
-
- </tr>
-
-
-
-
-
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.data-method-Tree" name=".Tree"></a>
- <div class="fixedFont">
- <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">Tree</b>
-
- (Node <B><i>root</i></B>)
-
-
-
- </div>
- <div class="mdesc">
-
-
- <div class="short">Create a new Roo.data.Tree</div>
-
-
- <div class="long">
-
-
-
- Create a new Roo.data.Tree
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Node</span> <b>root</b>
-
- </dt>
- <dd>(optional) The root node</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">addEvents</b>
-
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Used to define events on this Observable</div>
-
-
-
- <div class="long">
-
- Used to define events on this Observable
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
-
- </dt>
- <dd>The object with the events defined</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">addListener</b>
-
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Appends an event handler to this component</div>
-
-
-
- <div class="long">
-
- Appends an event handler to this component
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
-
- </dt>
- <dd>The type of event to listen for</dd>
-
- <dt>
- <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
-
- </dt>
- <dd>The method the event invokes</dd>
-
- <dt>
- <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
-
- </dt>
- <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
-
- <dt>
- <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
-
- </dt>
- <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">fireEvent</b>
-
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
-
-
- :
-
-
- <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
-
-
-
- <div class="long">
-
- Fires the specified event with the passed parameters (minus the event name).
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
-
- </dt>
- <dd>Variable number of parameters are passed to handlers</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.data.Tree-method-getNodeById" name=".getNodeById"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getNodeById</b>
-
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
-
-
- :
-
-
- Node
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Gets a node in this tree by its id.</div>
-
-
-
- <div class="long">
-
- Gets a node in this tree by its id.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">Node</span> </dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.data.Tree
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.data.Tree-method-getRootNode" name=".getRootNode"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getRootNode</b>
-
- ()
-
-
- :
-
-
- Node
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Returns the root node for this tree.</div>
-
-
-
- <div class="long">
-
- Returns the root node for this tree.
-
-
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">Node</span> </dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.data.Tree
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">hasListener</b>
-
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
-
-
- :
-
-
- <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Checks to see if this object has any listeners for a specified event</div>
-
-
-
- <div class="long">
-
- Checks to see if this object has any listeners for a specified event
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
-
- </dt>
- <dd>The name of the event to check for</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-on" name=".on"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">on</b>
-
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
-
-
-
- <div class="long">
-
- Appends an event handler to this element (shorthand for addListener)
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
-
- </dt>
- <dd>The type of event to listen for</dd>
-
- <dt>
- <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
-
- </dt>
- <dd>The method the event invokes</dd>
-
- <dt>
- <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
-
- </dt>
- <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
-
- <dt>
- <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
-
- </dt>
- <dd>(optional)</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">purgeListeners</b>
-
- ()
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Removes all listeners for this object</div>
-
-
-
- <div class="long">
-
- Removes all listeners for this object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">removeListener</b>
-
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Removes a listener</div>
-
-
-
- <div class="long">
-
- Removes a listener
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
-
- </dt>
- <dd>The type of event to listen for</dd>
-
- <dt>
- <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
-
- </dt>
- <dd>The handler to remove</dd>
-
- <dt>
- <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
-
- </dt>
- <dd>(optional) The scope (this object) for the handler</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.data.Tree-method-setRootNode" name=".setRootNode"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">setRootNode</b>
-
- (Node <B><i>node</i></B>)
-
-
- :
-
-
- Node
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Sets the root node for this tree.</div>
-
-
-
- <div class="long">
-
- Sets the root node for this tree.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Node</span> <b>node</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">Node</span> </dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.data.Tree
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-un" name=".un"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">un</b>
-
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Removes a listener (shorthand for removeListener)</div>
-
-
-
- <div class="long">
-
- Removes a listener (shorthand for removeListener)
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
-
- </dt>
- <dd>The type of event to listen for</dd>
-
- <dt>
- <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
-
- </dt>
- <dd>The handler to remove</dd>
-
- <dt>
- <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
-
- </dt>
- <dd>(optional) The scope (this object) for the handler</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- </table>
-
-
- <!-- ============================== events summary / details ======================== -->
-
-
- <a id="Roo.data.Tree-events"></a>
-
-
-
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption>Events</caption>
- <thead>
- <tr>
- <th class="sig-header" colspan="2">Event</th>
- <th class="msource-header">Defined By</th>
-
- </tr>
- </thead>
-
-
-
-
-
- <tr class="method-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.data.Tree-event-*append"></a>
-
- <div class="fixedFont">
- <b class="itemname">append</b> (Tree <B><i>tree</i></B>, Node <B><i>parent</i></B>, Node <B><i>node</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">Fires when a new child node is appended to a node in this tree.
-
- </div>
-
- <div class="long">
-
- Fires when a new child node is appended to a node in this tree.
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Tree</span> <b>tree</b>
-
- </dt>
- <dd>The owner tree</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>parent</b>
-
- </dt>
- <dd>The parent node</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>node</b>
-
- </dt>
- <dd>The newly appended node</dd>
-
- <dt>
- <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
-
- </dt>
- <dd>The index of the newly appended node</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- Roo.data.Tree
- </td>
- </tr>
-
- <tr class="method-row expandable config-row-alt1 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.data.Tree-event-*beforeappend"></a>
-
- <div class="fixedFont">
- <b class="itemname">beforeappend</b> (Tree <B><i>tree</i></B>, Node <B><i>parent</i></B>, Node <B><i>node</i></B>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">Fires before a new child is appended to a node in this tree, return false to cancel the append.
-
- </div>
-
- <div class="long">
-
- Fires before a new child is appended to a node in this tree, return false to cancel the append.
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Tree</span> <b>tree</b>
-
- </dt>
- <dd>The owner tree</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>parent</b>
-
- </dt>
- <dd>The parent node</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>node</b>
-
- </dt>
- <dd>The child node to be appended</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- Roo.data.Tree
- </td>
- </tr>
-
- <tr class="method-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.data.Tree-event-*beforeinsert"></a>
-
- <div class="fixedFont">
- <b class="itemname">beforeinsert</b> (Tree <B><i>tree</i></B>, Node <B><i>parent</i></B>, Node <B><i>node</i></B>, Node <B><i>refNode</i></B>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">Fires before a new child is inserted in a node in this tree, return false to cancel the insert.
-
- </div>
-
- <div class="long">
-
- Fires before a new child is inserted in a node in this tree, return false to cancel the insert.
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Tree</span> <b>tree</b>
-
- </dt>
- <dd>The owner tree</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>parent</b>
-
- </dt>
- <dd>The parent node</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>node</b>
-
- </dt>
- <dd>The child node to be inserted</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>refNode</b>
-
- </dt>
- <dd>The child node the node is being inserted before</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- Roo.data.Tree
- </td>
- </tr>
-
- <tr class="method-row expandable config-row-alt1 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.data.Tree-event-*beforemove"></a>
-
- <div class="fixedFont">
- <b class="itemname">beforemove</b> (Tree <B><i>tree</i></B>, Node <B><i>node</i></B>, Node <B><i>oldParent</i></B>, Node <B><i>newParent</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">Fires before a node is moved to a new location in the tree.
-
- </div>
-
- <div class="long">
-
- Fires before a node is moved to a new location in the tree. Return false to cancel the move.
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Tree</span> <b>tree</b>
-
- </dt>
- <dd>The owner tree</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>node</b>
-
- </dt>
- <dd>The node being moved</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>oldParent</b>
-
- </dt>
- <dd>The parent of the node</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>newParent</b>
-
- </dt>
- <dd>The new parent the node is moving to</dd>
-
- <dt>
- <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
-
- </dt>
- <dd>The index it is being moved to</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- Roo.data.Tree
- </td>
- </tr>
-
- <tr class="method-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.data.Tree-event-*beforeremove"></a>
-
- <div class="fixedFont">
- <b class="itemname">beforeremove</b> (Tree <B><i>tree</i></B>, Node <B><i>parent</i></B>, Node <B><i>node</i></B>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">Fires before a child is removed from a node in this tree, return false to cancel the remove.
-
- </div>
-
- <div class="long">
-
- Fires before a child is removed from a node in this tree, return false to cancel the remove.
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Tree</span> <b>tree</b>
-
- </dt>
- <dd>The owner tree</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>parent</b>
-
- </dt>
- <dd>The parent node</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>node</b>
-
- </dt>
- <dd>The child node to be removed</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- Roo.data.Tree
- </td>
- </tr>
-
- <tr class="method-row expandable config-row-alt1 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.data.Tree-event-*insert"></a>
-
- <div class="fixedFont">
- <b class="itemname">insert</b> (Tree <B><i>tree</i></B>, Node <B><i>parent</i></B>, Node <B><i>node</i></B>, Node <B><i>refNode</i></B>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">Fires when a new child node is inserted in a node in this tree.
-
- </div>
-
- <div class="long">
-
- Fires when a new child node is inserted in a node in this tree.
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Tree</span> <b>tree</b>
-
- </dt>
- <dd>The owner tree</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>parent</b>
-
- </dt>
- <dd>The parent node</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>node</b>
-
- </dt>
- <dd>The child node inserted</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>refNode</b>
-
- </dt>
- <dd>The child node the node was inserted before</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- Roo.data.Tree
- </td>
- </tr>
-
- <tr class="method-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.data.Tree-event-*move"></a>
-
- <div class="fixedFont">
- <b class="itemname">move</b> (Tree <B><i>tree</i></B>, Node <B><i>node</i></B>, Node <B><i>oldParent</i></B>, Node <B><i>newParent</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">Fires when a node is moved to a new location in the tree
-
- </div>
-
- <div class="long">
-
- Fires when a node is moved to a new location in the tree
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Tree</span> <b>tree</b>
-
- </dt>
- <dd>The owner tree</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>node</b>
-
- </dt>
- <dd>The node moved</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>oldParent</b>
-
- </dt>
- <dd>The old parent of this node</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>newParent</b>
-
- </dt>
- <dd>The new parent of this node</dd>
-
- <dt>
- <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
-
- </dt>
- <dd>The index it was moved to</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- Roo.data.Tree
- </td>
- </tr>
-
- <tr class="method-row expandable config-row-alt1 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.data.Tree-event-*remove"></a>
-
- <div class="fixedFont">
- <b class="itemname">remove</b> (Tree <B><i>tree</i></B>, Node <B><i>parent</i></B>, Node <B><i>node</i></B>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">Fires when a child node is removed from a node in this tree.
-
- </div>
-
- <div class="long">
-
- Fires when a child node is removed from a node in this tree.
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Tree</span> <b>tree</b>
-
- </dt>
- <dd>The owner tree</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>parent</b>
-
- </dt>
- <dd>The parent node</dd>
-
- <dt>
- <span class="fixedFont">Node</span> <b>node</b>
-
- </dt>
- <dd>The child node removed</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- Roo.data.Tree
- </td>
- </tr>
-
-
- </table>
-
-
-
-
-
-<!-- ============================== footer ================================= -->
- <div class="fineprint" style="clear:both">
-
- Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT)
- Based on
- <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
- </div>
- </body>
-</html>
projects / roojs1 / blobdiff