Upgrade to ExtJS 3.3.0 - Released 10/06/2010
[extjs.git] / examples / docs / output / Ext.ux.tree.TreeGridSorter.html
1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.ux.tree.TreeGridSorter-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.ux.tree.TreeGridSorter-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.ux.tree.TreeGridSorter-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.ux.tree.TreeGridSorter-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.ux.tree.TreeGridSorter"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/TreeGridSorter.html#cls-Ext.ux.tree.TreeGridSorter">Ext.ux.tree.TreeGridSorter</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.ux.tree</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/TreeGridSorter.html#cls-Ext.ux.tree.TreeGridSorter">TreeGridSorter.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/TreeGridSorter.html#cls-Ext.ux.tree.TreeGridSorter">TreeGridSorter</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.ux.tree.TreeGrid.html" ext:cls="Ext.ux.tree.TreeGrid">Ext.ux.tree.TreeGrid</a>.  The TreeGridSorter automatically monitors events on the
2 associated TreeGrid that might affect the tree's sort order (beforechildrenrendered, append, insert and textchange).
3 Example usage:<br />
4 <pre><code><b>new</b> Ext.ux.tree.TreeGridSorter(myTreeGrid, {
5      folderSort: true,
6      dir: <em>"desc"</em>,
7      sortType: <b>function</b>(node) {
8          <i>// sort by a custom, typed attribute:</i>
9          <b>return</b> parseInt(node.id, 10);
10      }
11  });</code></pre></div><div class="hr"></div><a id="Ext.ux.tree.TreeGridSorter-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">&nbsp;</a></td><td class="sig"><a id="Ext.ux.tree.TreeGridSorter-sortAscText"></a><b><a href="source/TreeGridSorter.html#cfg-Ext.ux.tree.TreeGridSorter-sortAscText">sortAscText</a></b> : String<div class="mdesc">The text displayed in the 'Sort Ascending' menu item (defaults to <tt>'Sort Ascending'</tt>)</div></td><td class="msource">TreeGridSorter</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.tree.TreeGridSorter-sortAscText"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.tree.TreeGridSorter-sortAscText">sortAscText</a></b> : String<div class="mdesc">The text displayed in the 'Sort Ascending' menu item (defaults to <tt>'Sort Ascending'</tt>)</div></td><td class="msource">TreeGridSorter</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.tree.TreeGridSorter-sortClasses"></a><b><a href="source/TreeGridSorter.html#cfg-Ext.ux.tree.TreeGridSorter-sortClasses">sortClasses</a></b> : Array<div class="mdesc">The CSS classes applied to a header when it is sorted. (defaults to <tt>['sort-asc', 'sort-desc']</tt>)</div></td><td class="msource">TreeGridSorter</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.tree.TreeGridSorter-sortClasses"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.tree.TreeGridSorter-sortClasses">sortClasses</a></b> : Array<div class="mdesc">The CSS classes applied to a header when it is sorted. (defaults to <tt>['sort-asc', 'sort-desc']</tt>)</div></td><td class="msource">TreeGridSorter</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.tree.TreeGridSorter-sortDescText"></a><b><a href="source/TreeGridSorter.html#cfg-Ext.ux.tree.TreeGridSorter-sortDescText">sortDescText</a></b> : String<div class="mdesc">The text displayed in the 'Sort Descending' menu item (defaults to <tt>'Sort Descending'</tt>)</div></td><td class="msource">TreeGridSorter</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.tree.TreeGridSorter-sortDescText"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.tree.TreeGridSorter-sortDescText">sortDescText</a></b> : String<div class="mdesc">The text displayed in the 'Sort Descending' menu item (defaults to <tt>'Sort Descending'</tt>)</div></td><td class="msource">TreeGridSorter</td></tr></tbody></table><a id="Ext.ux.tree.TreeGridSorter-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.ux.tree.TreeGridSorter-methods"></a><h2>Public Methods</h2><div class="no-members">This class has no public methods.</div><a id="Ext.ux.tree.TreeGridSorter-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>