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.TreeSorter</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.TreeSorter-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.tree.TreeSorter-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.tree.TreeSorter-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.tree.TreeSorter-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 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
50 Class Roo.tree.TreeSorter
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo.tree</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_tree_TreeSorter.js.html">Roo/tree/TreeSorter.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">TreeSorter</td></tr>
70 <!-- ============================== class summary ========================== -->
71 <div class="description">
72 Provides sorting of nodes in a TreePanel
76 <!-- ============================== Class comment block... ========================== -->
78 <div class="comments">
79 <b>Class Comments / Notes</B> =>
80 <u onclick="parent.CommentDialog.showCommentId = 'Roo.tree.TreeSorter';">[Add Your comment/notes about this class]</u>
82 <iframe frameborder="0" id="comments-Roo.tree" style="border: none;width:100%;"
83 src="/blog.php/GtkDjsComments/Roo.tree.TreeSorter.html"></iframe>
88 <!-- ============================== config options ========================== -->
93 <div class="hr"></div>
94 <a id="Roo.tree.TreeSorter-configs"></a>
100 <table cellspacing="0" class="member-table">
101 <caption>Config Options (Usually are also Properties)</caption>
105 <th class="sig-header" colspan="2">Options</th>
107 <th class="msource-header">Defined By</th>
114 <tr class="config-row expandable config-row-alt0 notInherited">
115 <td class="micon"><a class="exi" href="#expand"> </a></td>
118 <a id="Roo.tree.TreeSorter-cfg-caseSensitive" name=".caseSensitive"></a>
119 <div class="fixedFont">
120 <b class="itemname">caseSensitive</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
126 <div class="short">true for case sensitive sort (defaults to false)</div>
130 <div class="long">true for case sensitive sort (defaults to false)</div>
144 <tr class="config-row expandable config-row-alt1 notInherited">
145 <td class="micon"><a class="exi" href="#expand"> </a></td>
148 <a id="Roo.tree.TreeSorter-cfg-dir" name=".dir"></a>
149 <div class="fixedFont">
150 <b class="itemname">dir</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
156 <div class="short">The direction to sort (asc or desc) (defaults to asc)</div>
160 <div class="long">The direction to sort (asc or desc) (defaults to asc)</div>
174 <tr class="config-row expandable config-row-alt0 notInherited">
175 <td class="micon"><a class="exi" href="#expand"> </a></td>
178 <a id="Roo.tree.TreeSorter-cfg-folderSort" name=".folderSort"></a>
179 <div class="fixedFont">
180 <b class="itemname">folderSort</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
186 <div class="short">True to sort leaf nodes under non leaf nodes</div>
190 <div class="long">True to sort leaf nodes under non leaf nodes</div>
204 <tr class="config-row expandable config-row-alt1 notInherited">
205 <td class="micon"><a class="exi" href="#expand"> </a></td>
208 <a id="Roo.tree.TreeSorter-cfg-leafAttr" name=".leafAttr"></a>
209 <div class="fixedFont">
210 <b class="itemname">leafAttr</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
216 <div class="short">The attribute used to determine leaf nodes in folder sort (defaults to "leaf")</div>
220 <div class="long">The attribute used to determine leaf nodes in folder sort (defaults to "leaf")</div>
234 <tr class="config-row expandable config-row-alt0 notInherited">
235 <td class="micon"><a class="exi" href="#expand"> </a></td>
238 <a id="Roo.tree.TreeSorter-cfg-property" name=".property"></a>
239 <div class="fixedFont">
240 <b class="itemname">property</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
246 <div class="short">The named attribute on the node to sort by (defaults to text)</div>
250 <div class="long">The named attribute on the node to sort by (defaults to text)</div>
264 <tr class="config-row expandable config-row-alt1 notInherited">
265 <td class="micon"><a class="exi" href="#expand"> </a></td>
268 <a id="Roo.tree.TreeSorter-cfg-sortType" name=".sortType"></a>
269 <div class="fixedFont">
270 <b class="itemname">sortType</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
276 <div class="short">A custom "casting" function used to convert node values before sorting</div>
280 <div class="long">A custom "casting" function used to convert node values before sorting</div>
304 <!-- ============================== public properties ==================== -->
308 <a id="Roo.tree.TreeSorter-props"></a>
314 <table cellspacing="0" class="member-table">
315 <caption class="Empty">Public Properties - Has None</caption>
321 <!-- ============================== methods summary / details ======================== -->
324 <a id="Roo.tree.TreeSorter-methods"></a>
325 <!-- constructor?? -->
332 <!-- then dynamics first -->
339 <table cellspacing="0" class="member-table">
340 <caption>Public Methods</caption>
342 <th class="sig-header" colspan="2">Method</th>
343 <th class="msource-header">Defined By</th>
353 <tr class="method-row config-row-alt0 expandable notInherited">
354 <td class="micon"><a class="exi" href="#expand"> </a></td>
358 <a id="Roo.tree-method-TreeSorter" name=".TreeSorter"></a>
359 <div class="fixedFont">
360 <span class="attributes">new <B>Roo.tree.</B></span><b class="itemname">TreeSorter</b>
362 (TreePanel <B><i>tree</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>)
370 <div class="short">Create a new Roo.tree.TreeSorter</div>
377 Create a new Roo.tree.TreeSorter
380 <dl class="detailList">
381 <dt class="heading">Parameters:</dt>
384 <span class="fixedFont">TreePanel</span> <b>tree</b>
390 <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>
420 <!-- ============================== events summary / details ======================== -->
423 <a id="Roo.tree.TreeSorter-events"></a>
429 <table cellspacing="0" class="member-table">
430 <caption class="Empty">Events - Has None</caption>
441 <!-- ============================== footer ================================= -->
442 <div class="fineprint" style="clear:both">
444 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Apr 24 2014 16:54:42 GMT+0800 (HKT)
446 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>