<!-- ============================== inheritance Block. ================================= -->
<div class="inheritance res-block">
- <pre class="res-block-inner"><a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>
-<img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.tree.TreePanel
+ <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 src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>
+<img src="../../images/default/s.gif" height="1" width="40"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.tree.TreePanel
</pre>
</div>
<tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.tree.TreePanel-cfg-editor" name=".editor"></a>
+ <div class="fixedFont">
+ <b class="itemname">editor</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>|<a href="./Roo.tree.TreeEditor.html#constructor" roo:cls="Roo.tree.TreeEditor.html#constructor">Roo.tree.TreeEditor</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The TreeEditor or xtype data to display when clicked.</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The TreeEditor or xtype data to display when clicked.</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.tree.TreePanel
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</tr>
- <tr class="config-row expandable config-row-alt0 notInherited">
+ <tr class="config-row expandable config-row-alt1 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</tr>
- <tr class="config-row expandable config-row-alt1 notInherited">
+ <tr class="config-row expandable config-row-alt0 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</tr>
- <tr class="config-row expandable config-row-alt0 notInherited">
+ <tr class="config-row expandable config-row-alt1 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</tr>
- <tr class="config-row expandable config-row-alt1 notInherited">
+ <tr class="config-row expandable config-row-alt0 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</tr>
- <tr class="config-row expandable config-row-alt0 notInherited">
+ <tr class="config-row expandable config-row-alt1 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</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>
+
+
<tr class="config-row expandable config-row-alt1 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</div>
<div class="mdesc">
- <div class="short">Sets the rendering (formatting) function for the nodes.</div>
+ <div class="short">DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes.</div>
</div>
<div class="mdesc">
- <div class="long">Sets the rendering (formatting) function for the nodes. to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul></div>
+ <div class="long">DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes. to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul></div>
</div>
</div>
<div class="mdesc">
- <div class="short">Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view.</div>
+ <div class="short">DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view.</div>
</div>
<div class="mdesc">
- <div class="long">Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul></div>
+ <div class="long">DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul></div>
</div>
</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 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
</tr>
- <tr class="method-row config-row-alt0 expandable notInherited">
+ <tr class="method-row config-row-alt0 expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
- <a id="Roo.tree.TreePanel-method-getChecked" name=".getChecked"></a>
+ <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getChecked</b>
+ <span class="attributes"></span><b class="itemname">fireEvent</b>
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>attribute</i></B>, TreeNode <B><i>startNode</i></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="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
+ <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">Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g.</div>
+ <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
<div class="long">
- Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. "id")
+ Fires the specified event with the passed parameters (minus the event name).
<dt class="heading">Parameters:</dt>
<dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>attribute</b>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
</dt>
- <dd>(optional) Defaults to null (return the actual nodes)</dd>
+ <dd></dd>
<dt>
- <span class="fixedFont">TreeNode</span> <b>startNode</b>
+ <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>(optional) The node to start from, defaults to the root</dd>
+ <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="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> </dd>
+ <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>
</td>
<td class="msource">
- Roo.tree.TreePanel
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
</td>
</tr>
<td class="sig">
- <a id="Roo.tree.TreePanel-method-getEl" name=".getEl"></a>
+ <a id="Roo.tree.TreePanel-method-getChecked" name=".getChecked"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getEl</b>
+ <span class="attributes"></span><b class="itemname">getChecked</b>
- ()
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>attribute</i></B>, TreeNode <B><i>startNode</i></B>)
+ :
+
+
+ <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
+
+
+
+
</div>
<div class="mdesc">
- <div class="short">Returns the container element for this TreePanel</div>
+ <div class="short">Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g.</div>
<div class="long">
- Returns the container element for this TreePanel
+ Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. "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>attribute</b>
+
+ </dt>
+ <dd>(optional) Defaults to null (return the actual nodes)</dd>
+
+ <dt>
+ <span class="fixedFont">TreeNode</span> <b>startNode</b>
+
+ </dt>
+ <dd>(optional) The node to start from, defaults to the root</dd>
+
+ </dl>
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> </dd>
+
+ </dl>
<td class="sig">
- <a id="Roo.tree.TreePanel-method-getLoader" name=".getLoader"></a>
+ <a id="Roo.tree.TreePanel-method-getEl" name=".getEl"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getLoader</b>
+ <span class="attributes"></span><b class="itemname">getEl</b>
()
</div>
<div class="mdesc">
- <div class="short">Returns the default TreeLoader for this TreePanel</div>
+ <div class="short">Returns the container element for this TreePanel</div>
<div class="long">
- Returns the default TreeLoader for this TreePanel
+ Returns the container element for this TreePanel
<td class="sig">
- <a id="Roo.tree.TreePanel-method-getSelectionModel" name=".getSelectionModel"></a>
+ <a id="Roo.tree.TreePanel-method-getLoader" name=".getLoader"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getSelectionModel</b>
+ <span class="attributes"></span><b class="itemname">getLoader</b>
()
</div>
<div class="mdesc">
- <div class="short">Returns the selection model used by this TreePanel</div>
+ <div class="short">Returns the default TreeLoader for this TreePanel</div>
<div class="long">
- Returns the selection model used by this TreePanel
+ Returns the default TreeLoader for this TreePanel
</tr>
- <tr class="method-row config-row-alt0 expandable notInherited">
+ <tr class="method-row config-row-alt0 expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
- <a id="Roo.tree.TreePanel-method-render" name=".render"></a>
+ <a id="Roo.data.Tree-method-getNodeById" name=".getNodeById"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">render</b>
+ <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>)
-
- </div>
+ :
+
+
+ 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">
+
+ <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</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.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">
+
+ <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</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.tree.TreePanel-method-getSelectionModel" name=".getSelectionModel"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getSelectionModel</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Returns the selection model used by this TreePanel</div>
+
+
+
+ <div class="long">
+
+ Returns the selection model used by this TreePanel
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.tree.TreePanel
+
+ </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-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-alt0 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-alt1 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-alt0 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-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.tree.TreePanel-method-render" name=".render"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">render</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Trigger rendering of this TreePanel</div>
+
+
+
+ <div class="long">
+
+ Trigger rendering of this TreePanel
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.tree.TreePanel
+
+ </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.tree.TreePanel-method-selectPath" name=".selectPath"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">selectPath</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>path</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>attr</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Selects the node in this tree at the specified path.</div>
+
+
+
+ <div class="long">
+
+ Selects the node in this tree at the specified path. A path can be retrieved from a node with {<b>link</b> Roo.data.Node<b>getPath</b>}
+
+
+
+
+
+
+ <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>path</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>attr</b>
+
+ </dt>
+ <dd>(optional) The attribute used in the path (see {<b>link</b> Roo.data.Node<b>getPath</b>} for more info)</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
+
+ </dt>
+ <dd>(optional) The callback to call when the selection is complete. The callback will be called with<br/>(bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.tree.TreePanel
+
+ </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.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">Trigger rendering of this TreePanel</div>
+ <div class="short">Sets the root node for this tree.</div>
<div class="long">
- Trigger rendering of this TreePanel
+ 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">
+
+ <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</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-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.tree.TreePanel-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">
+ <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">
+ <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1">
+ <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>
</td>
<td class="msource">
-
- Roo.tree.TreePanel
-
+ <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>
</td>
</tr>
-
- <tr class="method-row config-row-alt1 expandable notInherited">
+ <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.tree.TreePanel-method-selectPath" name=".selectPath"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">selectPath</b>
-
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>path</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>attr</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>)
-
-
-
+ <a id="Roo.tree.TreePanel-event-*beforechildrenrendered"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">beforechildrenrendered</b> (Node <B><i>node</i></B>)
+
</div>
+
<div class="mdesc">
-
- <div class="short">Selects the node in this tree at the specified path.</div>
-
-
-
+
+ <div class="short">Fires right before the child nodes for a node are rendered
+
+ </div>
+
<div class="long">
-
- Selects the node in this tree at the specified path. A path can be retrieved from a node with {<b>link</b> Roo.data.Node<b>getPath</b>}
-
-
+ Fires right before the child nodes for a node are rendered
+
+
<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>path</b>
+ <span class="fixedFont">Node</span> <b>node</b>
</dt>
- <dd></dd>
+ <dd>The node</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.tree.TreePanel
+ </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.tree.TreePanel-event-*beforeclick"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">beforeclick</b> (Node <B><i>node</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires before click processing on a node.
+
+ </div>
+
+ <div class="long">
+
+ Fires before click processing on a node. Return false to cancel the default action.
+
+
+
+
+
+ <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>attr</b>
+ <span class="fixedFont">Node</span> <b>node</b>
</dt>
- <dd>(optional) The attribute used in the path (see {<b>link</b> Roo.data.Node<b>getPath</b>} for more info)</dd>
+ <dd>The node</dd>
<dt>
- <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
+ <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
</dt>
- <dd>(optional) The callback to call when the selection is complete. The callback will be called with<br/>(bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.</dd>
+ <dd>The event object</dd>
</dl>
</td>
<td class="msource">
-
- Roo.tree.TreePanel
-
+ Roo.tree.TreePanel
</td>
</tr>
-
- </table>
-
-
- <!-- ============================== events summary / details ======================== -->
-
-
- <a id="Roo.tree.TreePanel-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.tree.TreePanel-event-*beforechildrenrendered"></a>
+ <a id="Roo.tree.TreePanel-event-*beforecollapse"></a>
<div class="fixedFont">
- <b class="itemname">beforechildrenrendered</b> (Node <B><i>node</i></B>)
+ <b class="itemname">beforecollapse</b> (Node <B><i>node</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>deep</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>anim</i></B>)
</div>
<div class="mdesc">
- <div class="short">Fires right before the child nodes for a node are rendered
+ <div class="short">Fires before a node is collapsed, return false to cancel.
</div>
<div class="long">
- Fires right before the child nodes for a node are rendered
+ Fires before a node is collapsed, return false to cancel.
</dt>
<dd>The node</dd>
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>deep</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>anim</b>
+
+ </dt>
+ <dd></dd>
+
</dl>
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
- <a id="Roo.tree.TreePanel-event-*beforeclick"></a>
+ <a id="Roo.tree.TreePanel-event-*beforeexpand"></a>
<div class="fixedFont">
- <b class="itemname">beforeclick</b> (Node <B><i>node</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
+ <b class="itemname">beforeexpand</b> (Node <B><i>node</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>deep</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>anim</i></B>)
</div>
<div class="mdesc">
- <div class="short">Fires before click processing on a node.
+ <div class="short">Fires before a node is expanded, return false to cancel.
</div>
<div class="long">
- Fires before click processing on a node. Return false to cancel the default action.
+ Fires before a node is expanded, return false to cancel.
<dd>The node</dd>
<dt>
- <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>deep</b>
</dt>
- <dd>The event object</dd>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>anim</b>
+
+ </dt>
+ <dd></dd>
</dl>
</td>
</tr>
- <tr class="method-row expandable config-row-alt0 notInherited">
+ <tr class="method-row expandable config-row-alt0">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
- <a id="Roo.tree.TreePanel-event-*beforecollapse"></a>
+ <a id="Roo.data.Tree-event-*beforeinsert"></a>
<div class="fixedFont">
- <b class="itemname">beforecollapse</b> (Node <B><i>node</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>deep</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>anim</i></B>)
+ <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 node is collapsed, return false to cancel.
+ <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 node is collapsed, return false to cancel.
+ 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 node</dd>
+ <dd>The child node to be inserted</dd>
<dt>
- <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>deep</b>
+ <span class="fixedFont">Node</span> <b>refNode</b>
</dt>
- <dd></dd>
+ <dd>The child node the node is being inserted before</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>
+ </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.tree.TreePanel-event-*beforeload"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">beforeload</b> (Node <B><i>node</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires before a node is loaded, return false to cancel
+
+ </div>
+
+ <div class="long">
+
+ Fires before a node is loaded, return false to cancel
+
+
+
+
+
+ <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:Boolean">Boolean</a></span> <b>anim</b>
+ <span class="fixedFont">Node</span> <b>node</b>
</dt>
- <dd></dd>
+ <dd>The node being loaded</dd>
</dl>
</td>
</tr>
- <tr class="method-row expandable config-row-alt1 notInherited">
+ <tr class="method-row expandable config-row-alt0">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
- <a id="Roo.tree.TreePanel-event-*beforeexpand"></a>
+ <a id="Roo.data.Tree-event-*beforemove"></a>
<div class="fixedFont">
- <b class="itemname">beforeexpand</b> (Node <B><i>node</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>deep</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>anim</i></B>)
+ <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 expanded, return false to cancel.
+ <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 expanded, return false to cancel.
+ 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</dd>
+ <dd>The node being moved</dd>
<dt>
- <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>deep</b>
+ <span class="fixedFont">Node</span> <b>oldParent</b>
</dt>
- <dd></dd>
+ <dd>The parent of the node</dd>
<dt>
- <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>anim</b>
+ <span class="fixedFont">Node</span> <b>newParent</b>
</dt>
- <dd></dd>
+ <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>
</td>
<td class="msource">
- Roo.tree.TreePanel
+ <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>
</td>
</tr>
- <tr class="method-row expandable config-row-alt0 notInherited">
+ <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.tree.TreePanel-event-*beforeload"></a>
+ <a id="Roo.tree.TreePanel-event-*beforenodedrop"></a>
<div class="fixedFont">
- <b class="itemname">beforeload</b> (Node <B><i>node</i></B>)
+ <b class="itemname">beforenodedrop</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>dropEvent</i></B>)
</div>
<div class="mdesc">
- <div class="short">Fires before a node is loaded, return false to cancel
+ <div class="short">Fires when a DD object is dropped on a node in this tree for preprocessing.
</div>
<div class="long">
- Fires before a node is loaded, return false to cancel
+ Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent<br/>passed to handlers has the following properties:<br /><br/><ul style="padding:5px;padding-left:16px;"><br/><li>tree - The TreePanel</li><br/><li>target - The node being targeted for the drop</li><br/><li>data - The drag data from the drag source</li><br/><li>point - The point of the drop - append, above or below</li><br/><li>source - The drag source</li><br/><li>rawEvent - Raw mouse event</li><br/><li>dropNode - Drop node(s) provided by the source <b>OR</b> you can supply node(s)<br/>to be inserted by setting them on this object.</li><br/><li>cancel - Set this to true to cancel the drop.</li><br/></ul>
<dt class="heading">Parameters:</dt>
<dt>
- <span class="fixedFont">Node</span> <b>node</b>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>dropEvent</b>
</dt>
- <dd>The node being loaded</dd>
+ <dd></dd>
</dl>
</td>
</tr>
- <tr class="method-row expandable config-row-alt1 notInherited">
+ <tr class="method-row expandable config-row-alt0">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
- <a id="Roo.tree.TreePanel-event-*beforenodedrop"></a>
+ <a id="Roo.data.Tree-event-*beforeremove"></a>
<div class="fixedFont">
- <b class="itemname">beforenodedrop</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>dropEvent</i></B>)
+ <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 when a DD object is dropped on a node in this tree for preprocessing.
+ <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 when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent<br/>passed to handlers has the following properties:<br /><br/><ul style="padding:5px;padding-left:16px;"><br/><li>tree - The TreePanel</li><br/><li>target - The node being targeted for the drop</li><br/><li>data - The drag data from the drag source</li><br/><li>point - The point of the drop - append, above or below</li><br/><li>source - The drag source</li><br/><li>rawEvent - Raw mouse event</li><br/><li>dropNode - Drop node(s) provided by the source <b>OR</b> you can supply node(s)<br/>to be inserted by setting them on this object.</li><br/><li>cancel - Set this to true to cancel the drop.</li><br/></ul>
+ Fires before a child is removed from a node in this tree, return false to cancel the remove.
<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>dropEvent</b>
+ <span class="fixedFont">Tree</span> <b>tree</b>
</dt>
- <dd></dd>
+ <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>
</td>
<td class="msource">
- Roo.tree.TreePanel
+ <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>
</td>
</tr>
- <tr class="method-row expandable config-row-alt0 notInherited">
+ <tr class="method-row expandable config-row-alt1 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</td>
</tr>
- <tr class="method-row expandable config-row-alt1 notInherited">
+ <tr class="method-row expandable config-row-alt0 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</td>
</tr>
- <tr class="method-row expandable config-row-alt0 notInherited">
+ <tr class="method-row expandable config-row-alt1 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</td>
</tr>
- <tr class="method-row expandable config-row-alt1 notInherited">
+ <tr class="method-row expandable config-row-alt0 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</td>
</tr>
- <tr class="method-row expandable config-row-alt0 notInherited">
+ <tr class="method-row expandable config-row-alt1 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</td>
</tr>
- <tr class="method-row expandable config-row-alt1 notInherited">
+ <tr class="method-row expandable config-row-alt0 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</td>
</tr>
- <tr class="method-row expandable config-row-alt0 notInherited">
+ <tr class="method-row expandable config-row-alt1 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</td>
</tr>
- <tr class="method-row expandable config-row-alt1 notInherited">
+ <tr class="method-row expandable config-row-alt0 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</td>
</tr>
- <tr class="method-row expandable config-row-alt0 notInherited">
+ <tr class="method-row expandable config-row-alt1 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</td>
</tr>
+ <tr class="method-row expandable config-row-alt0">
+ <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">
+ <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>
+ </td>
+ </tr>
+
<tr class="method-row expandable config-row-alt1 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
</td>
</tr>
- <tr class="method-row expandable config-row-alt0 notInherited">
+ <tr class="method-row expandable config-row-alt0">
+ <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">
+ <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</td>
</tr>
- <tr class="method-row expandable config-row-alt1 notInherited">
+ <tr class="method-row expandable config-row-alt0 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</td>
</tr>
+ <tr class="method-row expandable config-row-alt1">
+ <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">
+ <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>
+ </td>
+ </tr>
+
<tr class="method-row expandable config-row-alt0 notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<!-- ============================== 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 16 2010 19:32:58 GMT+0800 (HKT)
+ Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Dec 16 2011 12:06:13 GMT+0800 (HKT)
Based on
<a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
</div>