1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.data.Tree</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.data.Tree-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.data.Tree-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.data.Tree-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.data.Tree-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.data.Tree
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_data_Tree.js.html">Roo/data/Tree.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">Tree</td></tr>
72 <tr><td class="label">Subclasses:</td><td class="hd-info">
73 <a href="./Roo.tree.TreePanel.html#constructor" roo:cls="Roo.tree.TreePanel.html#constructor">Roo.tree.TreePanel</a>
81 <tr><td class="label">Extends:</td><td class="hd-info">
82 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
90 <!-- ============================== class summary ========================== -->
91 <div class="description">
92 Represents a tree data structure and bubbles all the events for its nodes. The nodes<br/>in the tree have most standard DOM functionality.
96 <!-- ============================== Class comment block... ========================== -->
98 <div class="comments">
99 <b>Class Comments / Notes</B> =>
100 <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.Tree';">[Add Your comment/notes about this class]</u>
102 <iframe frameborder="0" id="comments-Roo.data" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.data.Tree.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.data.Tree-configs"></a>
120 <table cellspacing="0" class="member-table">
121 <caption>Config Options (Usually are also Properties)</caption>
125 <th class="sig-header" colspan="2">Options</th>
127 <th class="msource-header">Defined By</th>
134 <tr class="config-row expandable config-row-alt0">
135 <td class="micon"><a class="exi" href="#expand"> </a></td>
138 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
139 <div class="fixedFont">
140 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
146 <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>
150 <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>
158 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
174 <!-- ============================== public properties ==================== -->
178 <a id="Roo.data.Tree-props"></a>
184 <table cellspacing="0" class="member-table">
185 <caption class="Empty">Public Properties - Has None</caption>
191 <!-- ============================== methods summary / details ======================== -->
194 <a id="Roo.data.Tree-methods"></a>
195 <!-- constructor?? -->
202 <!-- then dynamics first -->
209 <table cellspacing="0" class="member-table">
210 <caption>Public Methods</caption>
212 <th class="sig-header" colspan="2">Method</th>
213 <th class="msource-header">Defined By</th>
223 <tr class="method-row config-row-alt0 expandable notInherited">
224 <td class="micon"><a class="exi" href="#expand"> </a></td>
228 <a id="Roo.data-method-Tree" name=".Tree"></a>
229 <div class="fixedFont">
230 <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">Tree</b>
232 (Node <B><i>root</i></B>)
240 <div class="short">Create a new Roo.data.Tree</div>
247 Create a new Roo.data.Tree
250 <dl class="detailList">
251 <dt class="heading">Parameters:</dt>
254 <span class="fixedFont">Node</span> <b>root</b>
257 <dd>(optional) The root node</dd>
281 <tr class="method-row config-row-alt1 expandable">
282 <td class="micon"><a class="exi" href="#expand"> </a></td>
286 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
287 <div class="fixedFont">
288 <span class="attributes"></span><b class="itemname">addEvents</b>
290 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
297 <div class="short">Used to define events on this Observable</div>
303 Used to define events on this Observable
310 <dl class="detailList">
311 <dt class="heading">Parameters:</dt>
314 <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>
317 <dd>The object with the events defined</dd>
337 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
343 <tr class="method-row config-row-alt0 expandable">
344 <td class="micon"><a class="exi" href="#expand"> </a></td>
348 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
349 <div class="fixedFont">
350 <span class="attributes"></span><b class="itemname">addListener</b>
352 (<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>)
359 <div class="short">Appends an event handler to this component</div>
365 Appends an event handler to this component
372 <dl class="detailList">
373 <dt class="heading">Parameters:</dt>
376 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
379 <dd>The type of event to listen for</dd>
382 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
385 <dd>The method the event invokes</dd>
388 <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>
391 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
394 <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>
397 <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>
417 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
423 <tr class="method-row config-row-alt1 expandable">
424 <td class="micon"><a class="exi" href="#expand"> </a></td>
428 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
429 <div class="fixedFont">
430 <span class="attributes"></span><b class="itemname">fireEvent</b>
432 (<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>)
438 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
447 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
453 Fires the specified event with the passed parameters (minus the event name).
460 <dl class="detailList">
461 <dt class="heading">Parameters:</dt>
464 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
470 <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>
473 <dd>Variable number of parameters are passed to handlers</dd>
481 <dl class="detailList">
482 <dt class="heading">Returns:</dt>
484 <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>
500 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
506 <tr class="method-row config-row-alt0 expandable notInherited">
507 <td class="micon"><a class="exi" href="#expand"> </a></td>
511 <a id="Roo.data.Tree-method-getNodeById" name=".getNodeById"></a>
512 <div class="fixedFont">
513 <span class="attributes"></span><b class="itemname">getNodeById</b>
515 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
530 <div class="short">Gets a node in this tree by its id.</div>
536 Gets a node in this tree by its id.
543 <dl class="detailList">
544 <dt class="heading">Parameters:</dt>
547 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
558 <dl class="detailList">
559 <dt class="heading">Returns:</dt>
561 <dd><span class="fixedFont">Node</span> </dd>
583 <tr class="method-row config-row-alt1 expandable notInherited">
584 <td class="micon"><a class="exi" href="#expand"> </a></td>
588 <a id="Roo.data.Tree-method-getRootNode" name=".getRootNode"></a>
589 <div class="fixedFont">
590 <span class="attributes"></span><b class="itemname">getRootNode</b>
607 <div class="short">Returns the root node for this tree.</div>
613 Returns the root node for this tree.
624 <dl class="detailList">
625 <dt class="heading">Returns:</dt>
627 <dd><span class="fixedFont">Node</span> </dd>
649 <tr class="method-row config-row-alt0 expandable">
650 <td class="micon"><a class="exi" href="#expand"> </a></td>
654 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
655 <div class="fixedFont">
656 <span class="attributes"></span><b class="itemname">hasListener</b>
658 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
664 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
673 <div class="short">Checks to see if this object has any listeners for a specified event</div>
679 Checks to see if this object has any listeners for a specified event
686 <dl class="detailList">
687 <dt class="heading">Parameters:</dt>
690 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
693 <dd>The name of the event to check for</dd>
701 <dl class="detailList">
702 <dt class="heading">Returns:</dt>
704 <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>
720 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
726 <tr class="method-row config-row-alt1 expandable">
727 <td class="micon"><a class="exi" href="#expand"> </a></td>
731 <a id="Roo.util.Observable-method-on" name=".on"></a>
732 <div class="fixedFont">
733 <span class="attributes"></span><b class="itemname">on</b>
735 (<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>)
742 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
748 Appends an event handler to this element (shorthand for addListener)
755 <dl class="detailList">
756 <dt class="heading">Parameters:</dt>
759 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
762 <dd>The type of event to listen for</dd>
765 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
768 <dd>The method the event invokes</dd>
771 <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>
774 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
777 <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>
800 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
806 <tr class="method-row config-row-alt0 expandable">
807 <td class="micon"><a class="exi" href="#expand"> </a></td>
811 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
812 <div class="fixedFont">
813 <span class="attributes"></span><b class="itemname">purgeListeners</b>
822 <div class="short">Removes all listeners for this object</div>
828 Removes all listeners for this object
851 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
857 <tr class="method-row config-row-alt1 expandable">
858 <td class="micon"><a class="exi" href="#expand"> </a></td>
862 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
863 <div class="fixedFont">
864 <span class="attributes"></span><b class="itemname">removeListener</b>
866 (<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>)
873 <div class="short">Removes a listener</div>
886 <dl class="detailList">
887 <dt class="heading">Parameters:</dt>
890 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
893 <dd>The type of event to listen for</dd>
896 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
899 <dd>The handler to remove</dd>
902 <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>
905 <dd>(optional) The scope (this object) for the handler</dd>
925 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
931 <tr class="method-row config-row-alt0 expandable notInherited">
932 <td class="micon"><a class="exi" href="#expand"> </a></td>
936 <a id="Roo.data.Tree-method-setRootNode" name=".setRootNode"></a>
937 <div class="fixedFont">
938 <span class="attributes"></span><b class="itemname">setRootNode</b>
940 (Node <B><i>node</i></B>)
955 <div class="short">Sets the root node for this tree.</div>
961 Sets the root node for this tree.
968 <dl class="detailList">
969 <dt class="heading">Parameters:</dt>
972 <span class="fixedFont">Node</span> <b>node</b>
983 <dl class="detailList">
984 <dt class="heading">Returns:</dt>
986 <dd><span class="fixedFont">Node</span> </dd>
1000 <td class="msource">
1008 <tr class="method-row config-row-alt1 expandable">
1009 <td class="micon"><a class="exi" href="#expand"> </a></td>
1013 <a id="Roo.util.Observable-method-un" name=".un"></a>
1014 <div class="fixedFont">
1015 <span class="attributes"></span><b class="itemname">un</b>
1017 (<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>)
1024 <div class="short">Removes a listener (shorthand for removeListener)</div>
1030 Removes a listener (shorthand for removeListener)
1037 <dl class="detailList">
1038 <dt class="heading">Parameters:</dt>
1041 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1044 <dd>The type of event to listen for</dd>
1047 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1050 <dd>The handler to remove</dd>
1053 <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>
1056 <dd>(optional) The scope (this object) for the handler</dd>
1074 <td class="msource">
1076 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1085 <!-- ============================== events summary / details ======================== -->
1088 <a id="Roo.data.Tree-events"></a>
1097 <table cellspacing="0" class="member-table">
1098 <caption>Events</caption>
1101 <th class="sig-header" colspan="2">Event</th>
1102 <th class="msource-header">Defined By</th>
1111 <tr class="method-row expandable config-row-alt0 notInherited">
1112 <td class="micon"><a class="exi" href="#expand"> </a></td>
1115 <a id="Roo.data.Tree-event-*append"></a>
1117 <div class="fixedFont">
1118 <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>)
1124 <div class="short">Fires when a new child node is appended to a node in this tree.
1130 Fires when a new child node is appended to a node in this tree.
1136 <dl class="detailList">
1137 <dt class="heading">Parameters:</dt>
1140 <span class="fixedFont">Tree</span> <b>tree</b>
1143 <dd>The owner tree</dd>
1146 <span class="fixedFont">Node</span> <b>parent</b>
1149 <dd>The parent node</dd>
1152 <span class="fixedFont">Node</span> <b>node</b>
1155 <dd>The newly appended node</dd>
1158 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1161 <dd>The index of the newly appended node</dd>
1179 <td class="msource">
1184 <tr class="method-row expandable config-row-alt1 notInherited">
1185 <td class="micon"><a class="exi" href="#expand"> </a></td>
1188 <a id="Roo.data.Tree-event-*beforeappend"></a>
1190 <div class="fixedFont">
1191 <b class="itemname">beforeappend</b> (Tree <B><i>tree</i></B>, Node <B><i>parent</i></B>, Node <B><i>node</i></B>)
1197 <div class="short">Fires before a new child is appended to a node in this tree, return false to cancel the append.
1203 Fires before a new child is appended to a node in this tree, return false to cancel the append.
1209 <dl class="detailList">
1210 <dt class="heading">Parameters:</dt>
1213 <span class="fixedFont">Tree</span> <b>tree</b>
1216 <dd>The owner tree</dd>
1219 <span class="fixedFont">Node</span> <b>parent</b>
1222 <dd>The parent node</dd>
1225 <span class="fixedFont">Node</span> <b>node</b>
1228 <dd>The child node to be appended</dd>
1246 <td class="msource">
1251 <tr class="method-row expandable config-row-alt0 notInherited">
1252 <td class="micon"><a class="exi" href="#expand"> </a></td>
1255 <a id="Roo.data.Tree-event-*beforeinsert"></a>
1257 <div class="fixedFont">
1258 <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>)
1264 <div class="short">Fires before a new child is inserted in a node in this tree, return false to cancel the insert.
1270 Fires before a new child is inserted in a node in this tree, return false to cancel the insert.
1276 <dl class="detailList">
1277 <dt class="heading">Parameters:</dt>
1280 <span class="fixedFont">Tree</span> <b>tree</b>
1283 <dd>The owner tree</dd>
1286 <span class="fixedFont">Node</span> <b>parent</b>
1289 <dd>The parent node</dd>
1292 <span class="fixedFont">Node</span> <b>node</b>
1295 <dd>The child node to be inserted</dd>
1298 <span class="fixedFont">Node</span> <b>refNode</b>
1301 <dd>The child node the node is being inserted before</dd>
1319 <td class="msource">
1324 <tr class="method-row expandable config-row-alt1 notInherited">
1325 <td class="micon"><a class="exi" href="#expand"> </a></td>
1328 <a id="Roo.data.Tree-event-*beforemove"></a>
1330 <div class="fixedFont">
1331 <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>)
1337 <div class="short">Fires before a node is moved to a new location in the tree.
1343 Fires before a node is moved to a new location in the tree. Return false to cancel the move.
1349 <dl class="detailList">
1350 <dt class="heading">Parameters:</dt>
1353 <span class="fixedFont">Tree</span> <b>tree</b>
1356 <dd>The owner tree</dd>
1359 <span class="fixedFont">Node</span> <b>node</b>
1362 <dd>The node being moved</dd>
1365 <span class="fixedFont">Node</span> <b>oldParent</b>
1368 <dd>The parent of the node</dd>
1371 <span class="fixedFont">Node</span> <b>newParent</b>
1374 <dd>The new parent the node is moving to</dd>
1377 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1380 <dd>The index it is being moved to</dd>
1398 <td class="msource">
1403 <tr class="method-row expandable config-row-alt0 notInherited">
1404 <td class="micon"><a class="exi" href="#expand"> </a></td>
1407 <a id="Roo.data.Tree-event-*beforeremove"></a>
1409 <div class="fixedFont">
1410 <b class="itemname">beforeremove</b> (Tree <B><i>tree</i></B>, Node <B><i>parent</i></B>, Node <B><i>node</i></B>)
1416 <div class="short">Fires before a child is removed from a node in this tree, return false to cancel the remove.
1422 Fires before a child is removed from a node in this tree, return false to cancel the remove.
1428 <dl class="detailList">
1429 <dt class="heading">Parameters:</dt>
1432 <span class="fixedFont">Tree</span> <b>tree</b>
1435 <dd>The owner tree</dd>
1438 <span class="fixedFont">Node</span> <b>parent</b>
1441 <dd>The parent node</dd>
1444 <span class="fixedFont">Node</span> <b>node</b>
1447 <dd>The child node to be removed</dd>
1465 <td class="msource">
1470 <tr class="method-row expandable config-row-alt1 notInherited">
1471 <td class="micon"><a class="exi" href="#expand"> </a></td>
1474 <a id="Roo.data.Tree-event-*insert"></a>
1476 <div class="fixedFont">
1477 <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>)
1483 <div class="short">Fires when a new child node is inserted in a node in this tree.
1489 Fires when a new child node is inserted in a node in this tree.
1495 <dl class="detailList">
1496 <dt class="heading">Parameters:</dt>
1499 <span class="fixedFont">Tree</span> <b>tree</b>
1502 <dd>The owner tree</dd>
1505 <span class="fixedFont">Node</span> <b>parent</b>
1508 <dd>The parent node</dd>
1511 <span class="fixedFont">Node</span> <b>node</b>
1514 <dd>The child node inserted</dd>
1517 <span class="fixedFont">Node</span> <b>refNode</b>
1520 <dd>The child node the node was inserted before</dd>
1538 <td class="msource">
1543 <tr class="method-row expandable config-row-alt0 notInherited">
1544 <td class="micon"><a class="exi" href="#expand"> </a></td>
1547 <a id="Roo.data.Tree-event-*move"></a>
1549 <div class="fixedFont">
1550 <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>)
1556 <div class="short">Fires when a node is moved to a new location in the tree
1562 Fires when a node is moved to a new location in the tree
1568 <dl class="detailList">
1569 <dt class="heading">Parameters:</dt>
1572 <span class="fixedFont">Tree</span> <b>tree</b>
1575 <dd>The owner tree</dd>
1578 <span class="fixedFont">Node</span> <b>node</b>
1581 <dd>The node moved</dd>
1584 <span class="fixedFont">Node</span> <b>oldParent</b>
1587 <dd>The old parent of this node</dd>
1590 <span class="fixedFont">Node</span> <b>newParent</b>
1593 <dd>The new parent of this node</dd>
1596 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1599 <dd>The index it was moved to</dd>
1617 <td class="msource">
1622 <tr class="method-row expandable config-row-alt1 notInherited">
1623 <td class="micon"><a class="exi" href="#expand"> </a></td>
1626 <a id="Roo.data.Tree-event-*remove"></a>
1628 <div class="fixedFont">
1629 <b class="itemname">remove</b> (Tree <B><i>tree</i></B>, Node <B><i>parent</i></B>, Node <B><i>node</i></B>)
1635 <div class="short">Fires when a child node is removed from a node in this tree.
1641 Fires when a child node is removed from a node in this tree.
1647 <dl class="detailList">
1648 <dt class="heading">Parameters:</dt>
1651 <span class="fixedFont">Tree</span> <b>tree</b>
1654 <dd>The owner tree</dd>
1657 <span class="fixedFont">Node</span> <b>parent</b>
1660 <dd>The parent node</dd>
1663 <span class="fixedFont">Node</span> <b>node</b>
1666 <dd>The child node removed</dd>
1684 <td class="msource">
1696 <!-- ============================== footer ================================= -->
1697 <div class="fineprint" style="clear:both">
1699 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Jul 26 2010 14:59:32 GMT+0800 (HKT)
1701 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>