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.tree.TreePanel</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.tree.TreePanel-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.tree.TreePanel-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.tree.TreePanel-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.tree.TreePanel-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.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.tree.TreePanel
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.tree.TreePanel
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.tree</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_tree_TreePanel.js.html">Roo/tree/TreePanel.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">TreePanel</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.tree.TreePanel';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.tree" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.tree.TreePanel.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.tree.TreePanel-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.tree.TreePanel-cfg-animate" name=".animate"></a>
132 <div class="fixedFont">
133 <b class="itemname">animate</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
139 <div class="short">true to enable animated expand/collapse (defaults to the value of Roo.enableFx)</div>
143 <div class="long">true to enable animated expand/collapse (defaults to the value of Roo.enableFx)</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.tree.TreePanel-cfg-containerScroll" name=".containerScroll"></a>
162 <div class="fixedFont">
163 <b class="itemname">containerScroll</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
169 <div class="short">true to register this container with ScrollManager</div>
173 <div class="long">true to register this container with ScrollManager</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.tree.TreePanel-cfg-ddAppendOnly" name=".ddAppendOnly"></a>
192 <div class="fixedFont">
193 <b class="itemname">ddAppendOnly</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
199 <div class="short">True if the tree should only allow append drops (use for trees which are sorted)</div>
203 <div class="long">True if the tree should only allow append drops (use for trees which are sorted)</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.tree.TreePanel-cfg-ddGroup" name=".ddGroup"></a>
222 <div class="fixedFont">
223 <b class="itemname">ddGroup</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
229 <div class="short">The DD group this TreePanel belongs to</div>
233 <div class="long">The DD group this TreePanel belongs to</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.tree.TreePanel-cfg-ddScroll" name=".ddScroll"></a>
252 <div class="fixedFont">
253 <b class="itemname">ddScroll</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
259 <div class="short">true to enable YUI body scrolling</div>
263 <div class="long">true to enable YUI body scrolling</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.tree.TreePanel-cfg-dragConfig" name=".dragConfig"></a>
282 <div class="fixedFont">
283 <b class="itemname">dragConfig</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
289 <div class="short">Custom config to pass to the {<b>link</b> Roo.tree.TreeDragZone} instance</div>
293 <div class="long">Custom config to pass to the {<b>link</b> Roo.tree.TreeDragZone} instance</div>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.tree.TreePanel-cfg-dropConfig" name=".dropConfig"></a>
312 <div class="fixedFont">
313 <b class="itemname">dropConfig</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
319 <div class="short">Custom config to pass to the {<b>link</b> Roo.tree.TreeDropZone} instance</div>
323 <div class="long">Custom config to pass to the {<b>link</b> Roo.tree.TreeDropZone} instance</div>
337 <tr class="config-row expandable config-row-alt1 notInherited">
338 <td class="micon"><a class="exi" href="#expand"> </a></td>
341 <a id="Roo.tree.TreePanel-cfg-enableDD" name=".enableDD"></a>
342 <div class="fixedFont">
343 <b class="itemname">enableDD</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
349 <div class="short">true to enable drag and drop</div>
353 <div class="long">true to enable drag and drop</div>
367 <tr class="config-row expandable config-row-alt0 notInherited">
368 <td class="micon"><a class="exi" href="#expand"> </a></td>
371 <a id="Roo.tree.TreePanel-cfg-enableDrag" name=".enableDrag"></a>
372 <div class="fixedFont">
373 <b class="itemname">enableDrag</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
379 <div class="short">true to enable just drag</div>
383 <div class="long">true to enable just drag</div>
397 <tr class="config-row expandable config-row-alt1 notInherited">
398 <td class="micon"><a class="exi" href="#expand"> </a></td>
401 <a id="Roo.tree.TreePanel-cfg-enableDrop" name=".enableDrop"></a>
402 <div class="fixedFont">
403 <b class="itemname">enableDrop</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
409 <div class="short">true to enable just drop</div>
413 <div class="long">true to enable just drop</div>
427 <tr class="config-row expandable config-row-alt0 notInherited">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.tree.TreePanel-cfg-hlColor" name=".hlColor"></a>
432 <div class="fixedFont">
433 <b class="itemname">hlColor</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
439 <div class="short">The color of the node highlight (defaults to C3DAF9)</div>
443 <div class="long">The color of the node highlight (defaults to C3DAF9)</div>
457 <tr class="config-row expandable config-row-alt1 notInherited">
458 <td class="micon"><a class="exi" href="#expand"> </a></td>
461 <a id="Roo.tree.TreePanel-cfg-hlDrop" name=".hlDrop"></a>
462 <div class="fixedFont">
463 <b class="itemname">hlDrop</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
469 <div class="short">false to disable node highlight on drop (defaults to the value of Roo.enableFx)</div>
473 <div class="long">false to disable node highlight on drop (defaults to the value of Roo.enableFx)</div>
487 <tr class="config-row expandable config-row-alt0 notInherited">
488 <td class="micon"><a class="exi" href="#expand"> </a></td>
491 <a id="Roo.tree.TreePanel-cfg-lines" name=".lines"></a>
492 <div class="fixedFont">
493 <b class="itemname">lines</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
499 <div class="short">false to disable tree lines (defaults to true)</div>
503 <div class="long">false to disable tree lines (defaults to true)</div>
517 <tr class="config-row expandable config-row-alt1 notInherited">
518 <td class="micon"><a class="exi" href="#expand"> </a></td>
521 <a id="Roo.tree.TreePanel-cfg-loader" name=".loader"></a>
522 <div class="fixedFont">
523 <b class="itemname">loader</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
529 <div class="short">A TreeLoader for use with this TreePanel</div>
533 <div class="long">A TreeLoader for use with this TreePanel</div>
547 <tr class="config-row expandable config-row-alt0 notInherited">
548 <td class="micon"><a class="exi" href="#expand"> </a></td>
551 <a id="Roo.tree.TreePanel-cfg-pathSeparator" name=".pathSeparator"></a>
552 <div class="fixedFont">
553 <b class="itemname">pathSeparator</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
559 <div class="short">The token used to separate sub-paths in path strings (defaults to '/')</div>
563 <div class="long">The token used to separate sub-paths in path strings (defaults to '/')</div>
577 <tr class="config-row expandable config-row-alt1 notInherited">
578 <td class="micon"><a class="exi" href="#expand"> </a></td>
581 <a id="Roo.tree.TreePanel-cfg-renderer" name=".renderer"></a>
582 <div class="fixedFont">
583 <b class="itemname">renderer</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
589 <div class="short">Sets the rendering (formatting) function for the nodes.</div>
593 <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>
607 <tr class="config-row expandable config-row-alt0 notInherited">
608 <td class="micon"><a class="exi" href="#expand"> </a></td>
611 <a id="Roo.tree.TreePanel-cfg-rendererTip" name=".rendererTip"></a>
612 <div class="fixedFont">
613 <b class="itemname">rendererTip</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
619 <div class="short">Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view.</div>
623 <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>
637 <tr class="config-row expandable config-row-alt1 notInherited">
638 <td class="micon"><a class="exi" href="#expand"> </a></td>
641 <a id="Roo.tree.TreePanel-cfg-rootVisible" name=".rootVisible"></a>
642 <div class="fixedFont">
643 <b class="itemname">rootVisible</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
649 <div class="short">false to hide the root node (defaults to true)</div>
653 <div class="long">false to hide the root node (defaults to true)</div>
667 <tr class="config-row expandable config-row-alt0 notInherited">
668 <td class="micon"><a class="exi" href="#expand"> </a></td>
671 <a id="Roo.tree.TreePanel-cfg-selModel" name=".selModel"></a>
672 <div class="fixedFont">
673 <b class="itemname">selModel</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
679 <div class="short">A tree selection model to use with this TreePanel (defaults to a {<b>link</b> Roo.tree.DefaultSelectionModel})</div>
683 <div class="long">A tree selection model to use with this TreePanel (defaults to a {<b>link</b> Roo.tree.DefaultSelectionModel})</div>
697 <tr class="config-row expandable config-row-alt1 notInherited">
698 <td class="micon"><a class="exi" href="#expand"> </a></td>
701 <a id="Roo.tree.TreePanel-cfg-singleExpand" name=".singleExpand"></a>
702 <div class="fixedFont">
703 <b class="itemname">singleExpand</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
709 <div class="short">true if only 1 node per branch may be expanded</div>
713 <div class="long">true if only 1 node per branch may be expanded</div>
737 <!-- ============================== public properties ==================== -->
741 <a id="Roo.tree.TreePanel-props"></a>
747 <table cellspacing="0" class="member-table">
748 <caption class="Empty">Public Properties - Has None</caption>
754 <!-- ============================== methods summary / details ======================== -->
757 <a id="Roo.tree.TreePanel-methods"></a>
758 <!-- constructor?? -->
765 <!-- then dynamics first -->
772 <table cellspacing="0" class="member-table">
773 <caption>Public Methods</caption>
775 <th class="sig-header" colspan="2">Method</th>
776 <th class="msource-header">Defined By</th>
786 <tr class="method-row config-row-alt0 expandable notInherited">
787 <td class="micon"><a class="exi" href="#expand"> </a></td>
791 <a id="Roo.tree-method-TreePanel" name=".TreePanel"></a>
792 <div class="fixedFont">
793 <span class="attributes">new <B>Roo.tree.</B></span><b class="itemname">TreePanel</b>
795 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
803 <div class="short">Create a new Roo.tree.TreePanel</div>
810 Create a new Roo.tree.TreePanel
813 <dl class="detailList">
814 <dt class="heading">Parameters:</dt>
817 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
820 <dd>The container element</dd>
823 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
850 <tr class="method-row config-row-alt1 expandable notInherited">
851 <td class="micon"><a class="exi" href="#expand"> </a></td>
855 <a id="Roo.tree.TreePanel-method-collapseAll" name=".collapseAll"></a>
856 <div class="fixedFont">
857 <span class="attributes"></span><b class="itemname">collapseAll</b>
866 <div class="short">Collapse all nodes</div>
901 <tr class="method-row config-row-alt0 expandable notInherited">
902 <td class="micon"><a class="exi" href="#expand"> </a></td>
906 <a id="Roo.tree.TreePanel-method-expandAll" name=".expandAll"></a>
907 <div class="fixedFont">
908 <span class="attributes"></span><b class="itemname">expandAll</b>
917 <div class="short">Expand all nodes</div>
952 <tr class="method-row config-row-alt1 expandable notInherited">
953 <td class="micon"><a class="exi" href="#expand"> </a></td>
957 <a id="Roo.tree.TreePanel-method-expandPath" name=".expandPath"></a>
958 <div class="fixedFont">
959 <span class="attributes"></span><b class="itemname">expandPath</b>
961 (<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>)
968 <div class="short">Expands a specified path in this TreePanel.</div>
974 Expands a specified path in this TreePanel. A path can be retrieved from a node with {<b>link</b> Roo.data.Node<b>getPath</b>}
981 <dl class="detailList">
982 <dt class="heading">Parameters:</dt>
985 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>path</b>
991 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>attr</b>
994 <dd>(optional) The attribute used in the path (see {<b>link</b> Roo.data.Node<b>getPath</b>} for more info)</dd>
997 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
1000 <dd>(optional) The callback to call when the expand is complete. The callback will be called with<br/>(bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded.</dd>
1018 <td class="msource">
1026 <tr class="method-row config-row-alt0 expandable notInherited">
1027 <td class="micon"><a class="exi" href="#expand"> </a></td>
1031 <a id="Roo.tree.TreePanel-method-getChecked" name=".getChecked"></a>
1032 <div class="fixedFont">
1033 <span class="attributes"></span><b class="itemname">getChecked</b>
1035 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>attribute</i></B>, TreeNode <B><i>startNode</i></B>)
1041 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
1050 <div class="short">Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g.</div>
1056 Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. "id")
1063 <dl class="detailList">
1064 <dt class="heading">Parameters:</dt>
1067 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>attribute</b>
1070 <dd>(optional) Defaults to null (return the actual nodes)</dd>
1073 <span class="fixedFont">TreeNode</span> <b>startNode</b>
1076 <dd>(optional) The node to start from, defaults to the root</dd>
1084 <dl class="detailList">
1085 <dt class="heading">Returns:</dt>
1087 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> </dd>
1101 <td class="msource">
1109 <tr class="method-row config-row-alt1 expandable notInherited">
1110 <td class="micon"><a class="exi" href="#expand"> </a></td>
1114 <a id="Roo.tree.TreePanel-method-getEl" name=".getEl"></a>
1115 <div class="fixedFont">
1116 <span class="attributes"></span><b class="itemname">getEl</b>
1125 <div class="short">Returns the container element for this TreePanel</div>
1131 Returns the container element for this TreePanel
1152 <td class="msource">
1160 <tr class="method-row config-row-alt0 expandable notInherited">
1161 <td class="micon"><a class="exi" href="#expand"> </a></td>
1165 <a id="Roo.tree.TreePanel-method-getLoader" name=".getLoader"></a>
1166 <div class="fixedFont">
1167 <span class="attributes"></span><b class="itemname">getLoader</b>
1176 <div class="short">Returns the default TreeLoader for this TreePanel</div>
1182 Returns the default TreeLoader for this TreePanel
1203 <td class="msource">
1211 <tr class="method-row config-row-alt1 expandable notInherited">
1212 <td class="micon"><a class="exi" href="#expand"> </a></td>
1216 <a id="Roo.tree.TreePanel-method-getSelectionModel" name=".getSelectionModel"></a>
1217 <div class="fixedFont">
1218 <span class="attributes"></span><b class="itemname">getSelectionModel</b>
1227 <div class="short">Returns the selection model used by this TreePanel</div>
1233 Returns the selection model used by this TreePanel
1254 <td class="msource">
1262 <tr class="method-row config-row-alt0 expandable notInherited">
1263 <td class="micon"><a class="exi" href="#expand"> </a></td>
1267 <a id="Roo.tree.TreePanel-method-render" name=".render"></a>
1268 <div class="fixedFont">
1269 <span class="attributes"></span><b class="itemname">render</b>
1278 <div class="short">Trigger rendering of this TreePanel</div>
1284 Trigger rendering of this TreePanel
1305 <td class="msource">
1313 <tr class="method-row config-row-alt1 expandable notInherited">
1314 <td class="micon"><a class="exi" href="#expand"> </a></td>
1318 <a id="Roo.tree.TreePanel-method-selectPath" name=".selectPath"></a>
1319 <div class="fixedFont">
1320 <span class="attributes"></span><b class="itemname">selectPath</b>
1322 (<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>)
1329 <div class="short">Selects the node in this tree at the specified path.</div>
1335 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>}
1342 <dl class="detailList">
1343 <dt class="heading">Parameters:</dt>
1346 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>path</b>
1352 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>attr</b>
1355 <dd>(optional) The attribute used in the path (see {<b>link</b> Roo.data.Node<b>getPath</b>} for more info)</dd>
1358 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
1361 <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>
1379 <td class="msource">
1390 <!-- ============================== events summary / details ======================== -->
1393 <a id="Roo.tree.TreePanel-events"></a>
1402 <table cellspacing="0" class="member-table">
1403 <caption>Events</caption>
1406 <th class="sig-header" colspan="2">Event</th>
1407 <th class="msource-header">Defined By</th>
1416 <tr class="method-row expandable config-row-alt0 notInherited">
1417 <td class="micon"><a class="exi" href="#expand"> </a></td>
1420 <a id="Roo.tree.TreePanel-event-*beforechildrenrendered"></a>
1422 <div class="fixedFont">
1423 <b class="itemname">beforechildrenrendered</b> (Node <B><i>node</i></B>)
1429 <div class="short">Fires right before the child nodes for a node are rendered
1435 Fires right before the child nodes for a node are rendered
1441 <dl class="detailList">
1442 <dt class="heading">Parameters:</dt>
1445 <span class="fixedFont">Node</span> <b>node</b>
1466 <td class="msource">
1471 <tr class="method-row expandable config-row-alt1 notInherited">
1472 <td class="micon"><a class="exi" href="#expand"> </a></td>
1475 <a id="Roo.tree.TreePanel-event-*beforeclick"></a>
1477 <div class="fixedFont">
1478 <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>)
1484 <div class="short">Fires before click processing on a node.
1490 Fires before click processing on a node. Return false to cancel the default action.
1496 <dl class="detailList">
1497 <dt class="heading">Parameters:</dt>
1500 <span class="fixedFont">Node</span> <b>node</b>
1506 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
1509 <dd>The event object</dd>
1527 <td class="msource">
1532 <tr class="method-row expandable config-row-alt0 notInherited">
1533 <td class="micon"><a class="exi" href="#expand"> </a></td>
1536 <a id="Roo.tree.TreePanel-event-*beforecollapse"></a>
1538 <div class="fixedFont">
1539 <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>)
1545 <div class="short">Fires before a node is collapsed, return false to cancel.
1551 Fires before a node is collapsed, return false to cancel.
1557 <dl class="detailList">
1558 <dt class="heading">Parameters:</dt>
1561 <span class="fixedFont">Node</span> <b>node</b>
1567 <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>
1573 <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>
1594 <td class="msource">
1599 <tr class="method-row expandable config-row-alt1 notInherited">
1600 <td class="micon"><a class="exi" href="#expand"> </a></td>
1603 <a id="Roo.tree.TreePanel-event-*beforeexpand"></a>
1605 <div class="fixedFont">
1606 <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>)
1612 <div class="short">Fires before a node is expanded, return false to cancel.
1618 Fires before a node is expanded, return false to cancel.
1624 <dl class="detailList">
1625 <dt class="heading">Parameters:</dt>
1628 <span class="fixedFont">Node</span> <b>node</b>
1634 <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>
1640 <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>
1661 <td class="msource">
1666 <tr class="method-row expandable config-row-alt0 notInherited">
1667 <td class="micon"><a class="exi" href="#expand"> </a></td>
1670 <a id="Roo.tree.TreePanel-event-*beforeload"></a>
1672 <div class="fixedFont">
1673 <b class="itemname">beforeload</b> (Node <B><i>node</i></B>)
1679 <div class="short">Fires before a node is loaded, return false to cancel
1685 Fires before a node is loaded, return false to cancel
1691 <dl class="detailList">
1692 <dt class="heading">Parameters:</dt>
1695 <span class="fixedFont">Node</span> <b>node</b>
1698 <dd>The node being loaded</dd>
1716 <td class="msource">
1721 <tr class="method-row expandable config-row-alt1 notInherited">
1722 <td class="micon"><a class="exi" href="#expand"> </a></td>
1725 <a id="Roo.tree.TreePanel-event-*beforenodedrop"></a>
1727 <div class="fixedFont">
1728 <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>)
1734 <div class="short">Fires when a DD object is dropped on a node in this tree for preprocessing.
1740 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>
1746 <dl class="detailList">
1747 <dt class="heading">Parameters:</dt>
1750 <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>
1771 <td class="msource">
1776 <tr class="method-row expandable config-row-alt0 notInherited">
1777 <td class="micon"><a class="exi" href="#expand"> </a></td>
1780 <a id="Roo.tree.TreePanel-event-*checkchange"></a>
1782 <div class="fixedFont">
1783 <b class="itemname">checkchange</b> (Node <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>checked</i></B>)
1789 <div class="short">Fires when a node with a checkbox's checked property changes
1795 Fires when a node with a checkbox's checked property changes
1801 <dl class="detailList">
1802 <dt class="heading">Parameters:</dt>
1805 <span class="fixedFont">Node</span> <b>this</b>
1811 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>checked</b>
1832 <td class="msource">
1837 <tr class="method-row expandable config-row-alt1 notInherited">
1838 <td class="micon"><a class="exi" href="#expand"> </a></td>
1841 <a id="Roo.tree.TreePanel-event-*click"></a>
1843 <div class="fixedFont">
1844 <b class="itemname">click</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>)
1850 <div class="short">Fires when a node is clicked
1856 Fires when a node is clicked
1862 <dl class="detailList">
1863 <dt class="heading">Parameters:</dt>
1866 <span class="fixedFont">Node</span> <b>node</b>
1872 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
1875 <dd>The event object</dd>
1893 <td class="msource">
1898 <tr class="method-row expandable config-row-alt0 notInherited">
1899 <td class="micon"><a class="exi" href="#expand"> </a></td>
1902 <a id="Roo.tree.TreePanel-event-*collapse"></a>
1904 <div class="fixedFont">
1905 <b class="itemname">collapse</b> (Node <B><i>node</i></B>)
1911 <div class="short">Fires when a node is collapsed
1917 Fires when a node is collapsed
1923 <dl class="detailList">
1924 <dt class="heading">Parameters:</dt>
1927 <span class="fixedFont">Node</span> <b>node</b>
1948 <td class="msource">
1953 <tr class="method-row expandable config-row-alt1 notInherited">
1954 <td class="micon"><a class="exi" href="#expand"> </a></td>
1957 <a id="Roo.tree.TreePanel-event-*contextmenu"></a>
1959 <div class="fixedFont">
1960 <b class="itemname">contextmenu</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>)
1966 <div class="short">Fires when a node is right clicked
1972 Fires when a node is right clicked
1978 <dl class="detailList">
1979 <dt class="heading">Parameters:</dt>
1982 <span class="fixedFont">Node</span> <b>node</b>
1988 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
1991 <dd>The event object</dd>
2009 <td class="msource">
2014 <tr class="method-row expandable config-row-alt0 notInherited">
2015 <td class="micon"><a class="exi" href="#expand"> </a></td>
2018 <a id="Roo.tree.TreePanel-event-*dblclick"></a>
2020 <div class="fixedFont">
2021 <b class="itemname">dblclick</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>)
2027 <div class="short">Fires when a node is double clicked
2033 Fires when a node is double clicked
2039 <dl class="detailList">
2040 <dt class="heading">Parameters:</dt>
2043 <span class="fixedFont">Node</span> <b>node</b>
2049 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2052 <dd>The event object</dd>
2070 <td class="msource">
2075 <tr class="method-row expandable config-row-alt1 notInherited">
2076 <td class="micon"><a class="exi" href="#expand"> </a></td>
2079 <a id="Roo.tree.TreePanel-event-*disabledchange"></a>
2081 <div class="fixedFont">
2082 <b class="itemname">disabledchange</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>disabled</i></B>)
2088 <div class="short">Fires when the disabled status of a node changes
2094 Fires when the disabled status of a node changes
2100 <dl class="detailList">
2101 <dt class="heading">Parameters:</dt>
2104 <span class="fixedFont">Node</span> <b>node</b>
2110 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>disabled</b>
2131 <td class="msource">
2136 <tr class="method-row expandable config-row-alt0 notInherited">
2137 <td class="micon"><a class="exi" href="#expand"> </a></td>
2140 <a id="Roo.tree.TreePanel-event-*dragdrop"></a>
2142 <div class="fixedFont">
2143 <b class="itemname">dragdrop</b> (<a href="./Roo.tree.TreePanel.html#constructor" roo:cls="Roo.tree.TreePanel.html#constructor">Roo.tree.TreePanel</a> <B><i>this</i></B>, <a href="./Roo.tree.TreeNode.html#constructor" roo:cls="Roo.tree.TreeNode.html#constructor">Roo.tree.TreeNode</a> <B><i>node</i></B>, DD <B><i>dd</i></B>, event <B><i>e</i></B>)
2149 <div class="short">Fires when a dragged node is dropped on a valid DD target
2155 Fires when a dragged node is dropped on a valid DD target
2161 <dl class="detailList">
2162 <dt class="heading">Parameters:</dt>
2165 <span class="fixedFont"><a href="./Roo.tree.TreePanel.html#constructor" roo:cls="Roo.tree.TreePanel.html#constructor">Roo.tree.TreePanel</a></span> <b>this</b>
2171 <span class="fixedFont"><a href="./Roo.tree.TreeNode.html#constructor" roo:cls="Roo.tree.TreeNode.html#constructor">Roo.tree.TreeNode</a></span> <b>node</b>
2177 <span class="fixedFont">DD</span> <b>dd</b>
2180 <dd>The dd it was dropped on</dd>
2183 <span class="fixedFont">event</span> <b>e</b>
2186 <dd>The raw browser event</dd>
2204 <td class="msource">
2209 <tr class="method-row expandable config-row-alt1 notInherited">
2210 <td class="micon"><a class="exi" href="#expand"> </a></td>
2213 <a id="Roo.tree.TreePanel-event-*enddrag"></a>
2215 <div class="fixedFont">
2216 <b class="itemname">enddrag</b> (<a href="./Roo.tree.TreePanel.html#constructor" roo:cls="Roo.tree.TreePanel.html#constructor">Roo.tree.TreePanel</a> <B><i>this</i></B>, <a href="./Roo.tree.TreeNode.html#constructor" roo:cls="Roo.tree.TreeNode.html#constructor">Roo.tree.TreeNode</a> <B><i>node</i></B>, event <B><i>e</i></B>)
2222 <div class="short">Fires when a drag operation is complete
2228 Fires when a drag operation is complete
2234 <dl class="detailList">
2235 <dt class="heading">Parameters:</dt>
2238 <span class="fixedFont"><a href="./Roo.tree.TreePanel.html#constructor" roo:cls="Roo.tree.TreePanel.html#constructor">Roo.tree.TreePanel</a></span> <b>this</b>
2244 <span class="fixedFont"><a href="./Roo.tree.TreeNode.html#constructor" roo:cls="Roo.tree.TreeNode.html#constructor">Roo.tree.TreeNode</a></span> <b>node</b>
2250 <span class="fixedFont">event</span> <b>e</b>
2253 <dd>The raw browser event</dd>
2271 <td class="msource">
2276 <tr class="method-row expandable config-row-alt0 notInherited">
2277 <td class="micon"><a class="exi" href="#expand"> </a></td>
2280 <a id="Roo.tree.TreePanel-event-*expand"></a>
2282 <div class="fixedFont">
2283 <b class="itemname">expand</b> (Node <B><i>node</i></B>)
2289 <div class="short">Fires when a node is expanded
2295 Fires when a node is expanded
2301 <dl class="detailList">
2302 <dt class="heading">Parameters:</dt>
2305 <span class="fixedFont">Node</span> <b>node</b>
2326 <td class="msource">
2331 <tr class="method-row expandable config-row-alt1 notInherited">
2332 <td class="micon"><a class="exi" href="#expand"> </a></td>
2335 <a id="Roo.tree.TreePanel-event-*load"></a>
2337 <div class="fixedFont">
2338 <b class="itemname">load</b> (Node <B><i>node</i></B>)
2344 <div class="short">Fires when a node is loaded
2350 Fires when a node is loaded
2356 <dl class="detailList">
2357 <dt class="heading">Parameters:</dt>
2360 <span class="fixedFont">Node</span> <b>node</b>
2363 <dd>The node that was loaded</dd>
2381 <td class="msource">
2386 <tr class="method-row expandable config-row-alt0 notInherited">
2387 <td class="micon"><a class="exi" href="#expand"> </a></td>
2390 <a id="Roo.tree.TreePanel-event-*nodedragover"></a>
2392 <div class="fixedFont">
2393 <b class="itemname">nodedragover</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>dragOverEvent</i></B>)
2399 <div class="short">Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed.
2405 Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent<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.</li><br/><li>cancel - Set this to true to signal drop not allowed.</li><br/></ul>
2411 <dl class="detailList">
2412 <dt class="heading">Parameters:</dt>
2415 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>dragOverEvent</b>
2436 <td class="msource">
2441 <tr class="method-row expandable config-row-alt1 notInherited">
2442 <td class="micon"><a class="exi" href="#expand"> </a></td>
2445 <a id="Roo.tree.TreePanel-event-*nodedrop"></a>
2447 <div class="fixedFont">
2448 <b class="itemname">nodedrop</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>dropEvent</i></B>)
2454 <div class="short">Fires after a DD object is dropped on a node in this tree.
2460 Fires after a DD object is dropped on a node in this tree. 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 - Dropped node(s).</li><br/></ul>
2466 <dl class="detailList">
2467 <dt class="heading">Parameters:</dt>
2470 <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>
2491 <td class="msource">
2496 <tr class="method-row expandable config-row-alt0 notInherited">
2497 <td class="micon"><a class="exi" href="#expand"> </a></td>
2500 <a id="Roo.tree.TreePanel-event-*startdrag"></a>
2502 <div class="fixedFont">
2503 <b class="itemname">startdrag</b> (<a href="./Roo.tree.TreePanel.html#constructor" roo:cls="Roo.tree.TreePanel.html#constructor">Roo.tree.TreePanel</a> <B><i>this</i></B>, <a href="./Roo.tree.TreeNode.html#constructor" roo:cls="Roo.tree.TreeNode.html#constructor">Roo.tree.TreeNode</a> <B><i>node</i></B>, event <B><i>e</i></B>)
2509 <div class="short">Fires when a node starts being dragged
2515 Fires when a node starts being dragged
2521 <dl class="detailList">
2522 <dt class="heading">Parameters:</dt>
2525 <span class="fixedFont"><a href="./Roo.tree.TreePanel.html#constructor" roo:cls="Roo.tree.TreePanel.html#constructor">Roo.tree.TreePanel</a></span> <b>this</b>
2531 <span class="fixedFont"><a href="./Roo.tree.TreeNode.html#constructor" roo:cls="Roo.tree.TreeNode.html#constructor">Roo.tree.TreeNode</a></span> <b>node</b>
2537 <span class="fixedFont">event</span> <b>e</b>
2540 <dd>The raw browser event</dd>
2558 <td class="msource">
2563 <tr class="method-row expandable config-row-alt1 notInherited">
2564 <td class="micon"><a class="exi" href="#expand"> </a></td>
2567 <a id="Roo.tree.TreePanel-event-*textchange"></a>
2569 <div class="fixedFont">
2570 <b class="itemname">textchange</b> (Node <B><i>node</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>oldText</i></B>)
2576 <div class="short">Fires when the text for a node is changed
2582 Fires when the text for a node is changed
2588 <dl class="detailList">
2589 <dt class="heading">Parameters:</dt>
2592 <span class="fixedFont">Node</span> <b>node</b>
2598 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>text</b>
2601 <dd>The new text</dd>
2604 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>oldText</b>
2607 <dd>The old text</dd>
2625 <td class="msource">
2637 <!-- ============================== footer ================================= -->
2638 <div class="fineprint" style="clear:both">
2640 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:11:58 GMT+0800 (HKT)
2642 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>