- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.tree.TreeSorter-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.tree.TreeSorter-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.tree.TreeSorter-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Ext.tree.TreeSorter-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="../docs/?class=Ext.tree.TreeSorter"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <h1>Class Ext.tree.TreeSorter</h1>
- <table cellspacing="0">
- <tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr>
- <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/TreeSorter.js" target="_blank">TreeSorter.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">TreeSorter</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
- </table>
- <div class="description">
- *
-Provides sorting of nodes in a <a ext:cls="Ext.tree.TreePanel" href="output/Ext.tree.TreePanel.html">Ext.tree.TreePanel</a>. The TreeSorter automatically monitors events on the
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.tree.TreeSorter-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.tree.TreeSorter-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.tree.TreeSorter-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.tree.TreeSorter-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.tree.TreeSorter"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><h1>Class <a href="source/TreeSorter.html#cls-Ext.tree.TreeSorter">Ext.tree.TreeSorter</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/TreeSorter.html#cls-Ext.tree.TreeSorter">TreeSorter.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/TreeSorter.html#cls-Ext.tree.TreeSorter">TreeSorter</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">Provides sorting of nodes in a <a href="output/Ext.tree.TreePanel.html" ext:cls="Ext.tree.TreePanel">Ext.tree.TreePanel</a>. The TreeSorter automatically monitors events on the
associated TreePanel that might affect the tree's sort order (beforechildrenrendered, append, insert and textchange).
Example usage:<br />
-<pre><code>new Ext.tree.TreeSorter(myTree, {
+<pre><code><b>new</b> Ext.tree.TreeSorter(myTree, {
folderSort: true,
dir: <em>"desc"</em>,
sortType: <b>function</b>(node) {
<i>// sort by a custom, typed attribute:</i>
<b>return</b> parseInt(node.id, 10);
}
-});</code></pre> </div>
-
- <div class="hr"></div>
- <a id="Ext.tree.TreeSorter-configs"></a>
- <h2>Config Options</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Config Options</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreeSorter-caseSensitive"></a>\r
- <b>caseSensitive</b> : Boolean <div class="mdesc">\r
- true for case-sensitive sort (defaults to false) </div>\r
- </td>\r
- <td class="msource">TreeSorter</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreeSorter-dir"></a>\r
- <b>dir</b> : String <div class="mdesc">\r
- The direction to sort ("asc" or "desc," case-insensitive, defaults to "asc") </div>\r
- </td>\r
- <td class="msource">TreeSorter</td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreeSorter-folderSort"></a>\r
- <b>folderSort</b> : Boolean <div class="mdesc">\r
- True to sort leaf nodes under non-leaf nodes (defaults to false) </div>\r
- </td>\r
- <td class="msource">TreeSorter</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreeSorter-leafAttr"></a>\r
- <b>leafAttr</b> : String <div class="mdesc">\r
- The attribute used to determine leaf nodes when <a ext:cls="Ext.tree.TreeSorter" ext:member="folderSort" href="output/Ext.tree.TreeSorter.html#folderSort">folderSort</a> = true (defaults to "leaf") </div>\r
- </td>\r
- <td class="msource">TreeSorter</td>\r
- </tr>\r
- <tr class="config-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreeSorter-property"></a>\r
- <b>property</b> : String <div class="mdesc">\r
- <div class="short">The named attribute on the node to sort by (defaults to "text"). Note that this property is only used if no sortType ...</div>\r
- <div class="long">\r
- The named attribute on the node to sort by (defaults to "text"). Note that this property is only used if no <a ext:cls="Ext.tree.TreeSorter" ext:member="sortType" href="output/Ext.tree.TreeSorter.html#sortType">sortType</a> function is specified, otherwise it is ignored. </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreeSorter</td>\r
- </tr>\r
- <tr class="config-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreeSorter-sortType"></a>\r
- <b>sortType</b> : Function <div class="mdesc">\r
- <div class="short">A custom "casting" function used to convert node values before sorting. The function will be called with a single par...</div>\r
- <div class="long">\r
- A custom "casting" function used to convert node values before sorting. The function will be called with a single parameter (the <a ext:cls="Ext.tree.TreeNode" href="output/Ext.tree.TreeNode.html">Ext.tree.TreeNode</a> being evaluated) and is expected to return the node's sort value cast to the specific data type required for sorting. This could be used, for example, when a node's text (or other attribute) should be sorted as a date or numeric value. See the class description for example usage. Note that if a sortType is specified, any <a ext:cls="Ext.tree.TreeSorter" ext:member="property" href="output/Ext.tree.TreeSorter.html#property">property</a> config will be ignored. </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreeSorter</td>\r
- </tr>\r
- </table>
- <a id="Ext.tree.TreeSorter-props"></a>
- <h2>Public Properties</h2>
- <div class="no-members">This class has no public properties.</div> <a id="Ext.tree.TreeSorter-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreeSorter-TreeSorter"></a>\r
- <b>TreeSorter</b>( <code>TreePanel tree</code>, <code>Object config</code> ) <div class="mdesc">\r
- <div class="short"></div>\r
- <div class="long">\r
- <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>tree</code> : TreePanel<div class="sub-desc"></div></li><li><code>config</code> : Object<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code></code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreeSorter</td>\r
- </tr>\r
- </table>
- <a id="Ext.tree.TreeSorter-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
\ No newline at end of file
+});</code></pre></div><div class="hr"></div><a id="Ext.tree.TreeSorter-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeSorter-caseSensitive"></a><b><a href="source/TreeSorter.html#cfg-Ext.tree.TreeSorter-caseSensitive">caseSensitive</a></b> : Boolean<div class="mdesc">true for case-sensitive sort (defaults to false)</div></td><td class="msource">TreeSorter</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeSorter-dir"></a><b><a href="source/TreeSorter.html#cfg-Ext.tree.TreeSorter-dir">dir</a></b> : String<div class="mdesc">The direction to sort ("asc" or "desc," case-insensitive, defaults to "asc")</div></td><td class="msource">TreeSorter</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeSorter-folderSort"></a><b><a href="source/TreeSorter.html#cfg-Ext.tree.TreeSorter-folderSort">folderSort</a></b> : Boolean<div class="mdesc">True to sort leaf nodes under non-leaf nodes (defaults to false)</div></td><td class="msource">TreeSorter</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeSorter-leafAttr"></a><b><a href="source/TreeSorter.html#cfg-Ext.tree.TreeSorter-leafAttr">leafAttr</a></b> : String<div class="mdesc">The attribute used to determine leaf nodes when <a href="output/Ext.tree.TreeSorter.html#Ext.tree.TreeSorter-folderSort" ext:member="folderSort" ext:cls="Ext.tree.TreeSorter">folderSort</a> = true (defaults to "leaf")</div></td><td class="msource">TreeSorter</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeSorter-property"></a><b><a href="source/TreeSorter.html#cfg-Ext.tree.TreeSorter-property">property</a></b> : String<div class="mdesc"><div class="short">The named attribute on the node to sort by (defaults to "text"). Note that this
+property is only used if no sortType...</div><div class="long">The named attribute on the node to sort by (defaults to "text"). Note that this
+property is only used if no <a href="output/Ext.tree.TreeSorter.html#Ext.tree.TreeSorter-sortType" ext:member="sortType" ext:cls="Ext.tree.TreeSorter">sortType</a> function is specified, otherwise it is ignored.</div></div></td><td class="msource">TreeSorter</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreeSorter-sortType"></a><b><a href="source/TreeSorter.html#cfg-Ext.tree.TreeSorter-sortType">sortType</a></b> : Function<div class="mdesc"><div class="short">A custom "casting" function used to convert node values before sorting. The function
+will be called with a single pa...</div><div class="long">A custom "casting" function used to convert node values before sorting. The function
+will be called with a single parameter (the <a href="output/Ext.tree.TreeNode.html" ext:cls="Ext.tree.TreeNode">Ext.tree.TreeNode</a> being evaluated) and is expected to return
+the node's sort value cast to the specific data type required for sorting. This could be used, for example, when
+a node's text (or other attribute) should be sorted as a date or numeric value. See the class description for
+example usage. Note that if a sortType is specified, any <a href="output/Ext.tree.TreeSorter.html#Ext.tree.TreeSorter-property" ext:member="property" ext:cls="Ext.tree.TreeSorter">property</a> config will be ignored.</div></div></td><td class="msource">TreeSorter</td></tr></tbody></table><a id="Ext.tree.TreeSorter-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.tree.TreeSorter-methods"></a><h2>Public Methods</h2><div class="no-members">This class has no public methods.</div><a id="Ext.tree.TreeSorter-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff