Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.data.TreeStore.html
1 <!DOCTYPE html><html><head><title>Ext.data.TreeStore | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.data.TreeStore',
13         docClass: 'Ext.data.TreeStore',
14         docReq: 'Ext.data.TreeStore',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'TreeStore.html#Ext-data.TreeStore';
33     clsInfo = {"methods":["addEvents","addListener","addManagedListener","capture","clearListeners","clearManagedListeners","enableBubble","fireEvent","getNewRecords","getNodeById","getProxy","getRootNode","getSortState","getUpdatedRecords","hasListener","initSortable","isLoading","load","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","setProxy","setRootNode","sort","suspendEvents","sync","un"],"cfgs":["autoLoad","autoSync","clearOnLoad","defaultRootId","defaultRootProperty","fields","folderSort","listeners","nodeParam","proxy","storeId"],"properties":["","batchUpdateMode","defaultProxyType","defaultSortDirection","fields","filterOnLoad","filters","isDestroyed","isSortable","removeAll","sortOnLoad","sortRoot","sorters"],"events":["add","append","beforeappend","beforecollapse","beforeexpand","beforeinsert","beforeload","beforemove","beforeremove","beforesync","clear","collapse","datachanged","expand","insert","load","move","remove","rootchange","sort","update"],"subclasses":[]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/TreeStore.html#Ext-data.TreeStore" target="_blank">Ext.data.TreeStore</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.data.AbstractStore.html" rel="Ext.data.AbstractStore" class="cls docClass">Ext.data.AbstractStore</a><div class="subclass"><strong>Ext.data.TreeStore</strong></div></div><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div><div class="mixin"><a href="Ext.util.Sortable.html" rel="Ext.util.Sortable" class="cls docClass">Ext.util.Sortable</a></div></pre><p>The TreeStore is a store implementation that is backed by by an <a href="Ext.data.Tree.html" rel="Ext.data.Tree" class="docClass">Ext.data.Tree</a>.
38 It provides convenience methods for loading nodes, as well as the ability to use
39 the hierarchical tree structure combined with a store. This class is generally used
40 in conjunction with <a href="Ext.tree.Panel.html" rel="Ext.tree.Panel" class="docClass">Ext.tree.Panel</a>. This class also relays many events from
41 the Tree for convenience.</p>
42
43 <h2>Using Models</h2>
44
45 <p>If no Model is specified, an implicit model will be created that implements <a href="Ext.data.NodeInterface.html" rel="Ext.data.NodeInterface" class="docClass">Ext.data.NodeInterface</a>.
46 The standard Tree fields will also be copied onto the Model for maintaining their state.</p>
47
48 <h2>Reading Nested Data</h2>
49
50 <p>For the tree to read nested data, the <a href="Ext.data.Reader.html" rel="Ext.data.Reader" class="docClass">Ext.data.Reader</a> must be configured with a root property,
51 so the reader can find nested data for each node. If a root is not specified, it will default to
52 'children'.</p>
53 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-autoLoad" class="member f inherited"><a href="Ext.data.TreeStore.html#config-autoLoad" rel="config-autoLoad" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-cfg-autoLoad" class="viewSource">view source</a></div><a name="autoLoad"></a><a name="config-autoLoad"></a><a href="Ext.data.TreeStore.html#" rel="config-autoLoad" class="cls expand">autoLoad</a><span> : Boolean/Object</span></div><div class="description"><div class="short">If data is not specified, and if autoLoad is true or an Object, this store's load method
54 is automatically called afte...</div><div class="long"><p>If data is not specified, and if autoLoad is true or an Object, this store's load method
55 is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's
56 load method. Defaults to false.</p>
57 </div></div></div><div id="config-autoSync" class="member inherited"><a href="Ext.data.TreeStore.html#config-autoSync" rel="config-autoSync" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-cfg-autoSync" class="viewSource">view source</a></div><a name="autoSync"></a><a name="config-autoSync"></a><a href="Ext.data.TreeStore.html#" rel="config-autoSync" class="cls expand">autoSync</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to automatically sync the Store with its Proxy after every edit to one of its Records.
58 Defaults to false.</p>
59 </div><div class="long"><p>True to automatically sync the Store with its Proxy after every edit to one of its Records.
60 Defaults to false.</p>
61 </div></div></div><div id="config-clearOnLoad" class="member ni"><a href="Ext.data.TreeStore.html#config-clearOnLoad" rel="config-clearOnLoad" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-cfg-clearOnLoad" class="viewSource">view source</a></div><a name="clearOnLoad"></a><a name="config-clearOnLoad"></a><a href="Ext.data.TreeStore.html#" rel="config-clearOnLoad" class="cls expand">clearOnLoad</a><span> : Boolean</span></div><div class="description"><div class="short"><p>(optional) Default to true. Remove previously existing
62 child nodes before loading.</p>
63 </div><div class="long"><p>(optional) Default to true. Remove previously existing
64 child nodes before loading.</p>
65 </div></div></div><div id="config-defaultRootId" class="member ni"><a href="Ext.data.TreeStore.html#config-defaultRootId" rel="config-defaultRootId" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-cfg-defaultRootId" class="viewSource">view source</a></div><a name="defaultRootId"></a><a name="config-defaultRootId"></a><a href="Ext.data.TreeStore.html#" rel="config-defaultRootId" class="cls expand">defaultRootId</a><span> : String</span></div><div class="description"><div class="short"><p>The default root id. Defaults to 'root'</p>
66 </div><div class="long"><p>The default root id. Defaults to 'root'</p>
67 </div></div></div><div id="config-defaultRootProperty" class="member ni"><a href="Ext.data.TreeStore.html#config-defaultRootProperty" rel="config-defaultRootProperty" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-cfg-defaultRootProperty" class="viewSource">view source</a></div><a name="defaultRootProperty"></a><a name="config-defaultRootProperty"></a><a href="Ext.data.TreeStore.html#" rel="config-defaultRootProperty" class="cls expand">defaultRootProperty</a><span> : String</span></div><div class="description"><div class="short"><p>The root property to specify on the reader if one is not explicitly defined.</p>
68 </div><div class="long"><p>The root property to specify on the reader if one is not explicitly defined.</p>
69 </div></div></div><div id="config-fields" class="member inherited"><a href="Ext.data.TreeStore.html#config-fields" rel="config-fields" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-cfg-fields" class="viewSource">view source</a></div><a name="fields"></a><a name="config-fields"></a><a href="Ext.data.TreeStore.html#" rel="config-fields" class="cls expand">fields</a><span> : Array</span></div><div class="description"><div class="short">This may be used in place of specifying a model configuration. The fields should be a
70 set of Ext.data.Field configura...</div><div class="long"><p>This may be used in place of specifying a <a href="Ext.data.TreeStore.html#model" rel="Ext.data.TreeStore#model" class="docClass">model</a> configuration. The fields should be a
71 set of <a href="Ext.data.Field.html" rel="Ext.data.Field" class="docClass">Ext.data.Field</a> configuration objects. The store will automatically create a <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Ext.data.Model</a>
72 with these fields. In general this configuration option should be avoided, it exists for the purposes of
73 backwards compatibility. For anything more complicated, such as specifying a particular id property or
74 assocations, a <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Ext.data.Model</a> should be defined and specified for the <a href="Ext.data.TreeStore.html#model" rel="Ext.data.TreeStore#model" class="docClass">model</a> config.</p>
75 </div></div></div><div id="config-folderSort" class="member ni"><a href="Ext.data.TreeStore.html#config-folderSort" rel="config-folderSort" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-cfg-folderSort" class="viewSource">view source</a></div><a name="folderSort"></a><a name="config-folderSort"></a><a href="Ext.data.TreeStore.html#" rel="config-folderSort" class="cls expand">folderSort</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Set to true to automatically prepend a leaf sorter (defaults to <tt>undefined</tt>)</p>
76 </div><div class="long"><p>Set to true to automatically prepend a leaf sorter (defaults to <tt>undefined</tt>)</p>
77 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.data.TreeStore.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.data.TreeStore.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
78 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
79 object during initialization.  This should be a valid listeners config object as specified in the
80 <a href="Ext.data.TreeStore.html#addListener" rel="Ext.data.TreeStore#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
81
82 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
83
84
85 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
86
87
88 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
89 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
90 events directly from a child element of a Component, we need to specify the <code>element</code> option to
91 identify the Component property to add a DOM listener to:</p>
92
93 <pre><code>new Ext.panel.Panel({
94     width: 400,
95     height: 200,
96     dockedItems: [{
97         xtype: 'toolbar'
98     }],
99     listeners: {
100         click: {
101             element: 'el', //bind to the underlying el property on the panel
102             fn: function(){ console.log('click el'); }
103         },
104         dblclick: {
105             element: 'body', //bind to the underlying body property on the panel
106             fn: function(){ console.log('dblclick body'); }
107         }
108     }
109 });
110 </code></pre>
111
112
113 <p></p></p>
114 </div></div></div><div id="config-nodeParam" class="member ni"><a href="Ext.data.TreeStore.html#config-nodeParam" rel="config-nodeParam" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-cfg-nodeParam" class="viewSource">view source</a></div><a name="nodeParam"></a><a name="config-nodeParam"></a><a href="Ext.data.TreeStore.html#" rel="config-nodeParam" class="cls expand">nodeParam</a><span> : String</span></div><div class="description"><div class="short"><p>The name of the parameter sent to the server which contains
115 the identifier of the node. Defaults to <tt>'node'</tt>.</p>
116 </div><div class="long"><p>The name of the parameter sent to the server which contains
117 the identifier of the node. Defaults to <tt>'node'</tt>.</p>
118 </div></div></div><div id="config-proxy" class="member inherited"><a href="Ext.data.TreeStore.html#config-proxy" rel="config-proxy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-cfg-proxy" class="viewSource">view source</a></div><a name="proxy"></a><a name="config-proxy"></a><a href="Ext.data.TreeStore.html#" rel="config-proxy" class="cls expand">proxy</a><span> : String/Ext.data.proxy.Proxy/Object</span></div><div class="description"><div class="short">The Proxy to use for this Store. This can be either a string, a config
119 object or a Proxy instance - see setProxy for ...</div><div class="long"><p>The Proxy to use for this Store. This can be either a string, a config
120 object or a Proxy instance - see <a href="Ext.data.TreeStore.html#setProxy" rel="Ext.data.TreeStore#setProxy" class="docClass">setProxy</a> for details.</p>
121 </div></div></div><div id="config-storeId" class="member inherited"><a href="Ext.data.TreeStore.html#config-storeId" rel="config-storeId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-cfg-storeId" class="viewSource">view source</a></div><a name="storeId"></a><a name="config-storeId"></a><a href="Ext.data.TreeStore.html#" rel="config-storeId" class="cls expand">storeId</a><span> : String</span></div><div class="description"><div class="short">Optional unique identifier for this store. If present, this Store will be registered with
122 the Ext.data.StoreManager, ...</div><div class="long"><p>Optional unique identifier for this store. If present, this Store will be registered with
123 the <a href="Ext.data.StoreManager.html" rel="Ext.data.StoreManager" class="docClass">Ext.data.StoreManager</a>, making it easy to reuse elsewhere. Defaults to undefined.</p>
124 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-" class="member f ni"><a href="Ext.data.TreeStore.html#property-" rel="property-" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-property-" class="viewSource">view source</a></div><a></a><a name="property-"></a><a href="Ext.data.TreeStore.html#" rel="property-" class="cls expand"></a><span> : Object</span></div><div class="description"><div class="short">Loop over each record returned from the server. Assume they are
125 returned in order of how they were sent. If we find a...</div><div class="long"><p>Loop over each record returned from the server. Assume they are
126 returned in order of how they were sent. If we find a matching
127 record, replace it with the newly created one.</p>
128 </div></div></div><div id="property-batchUpdateMode" class="member inherited"><a href="Ext.data.TreeStore.html#property-batchUpdateMode" rel="property-batchUpdateMode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-batchUpdateMode" class="viewSource">view source</a></div><a name="batchUpdateMode"></a><a name="property-batchUpdateMode"></a><a href="Ext.data.TreeStore.html#" rel="property-batchUpdateMode" class="cls expand">batchUpdateMode</a><span> : String</span></div><div class="description"><div class="short">Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's
129 internal...</div><div class="long"><p>Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's
130 internal representation of the data after each operation of the batch has completed, 'complete' will wait until
131 the entire batch has been completed before updating the Store's data. 'complete' is a good choice for local
132 storage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency.</p>
133 </div></div></div><div id="property-defaultProxyType" class="member inherited"><a href="Ext.data.TreeStore.html#property-defaultProxyType" rel="property-defaultProxyType" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-defaultProxyType" class="viewSource">view source</a></div><a name="defaultProxyType"></a><a name="property-defaultProxyType"></a><a href="Ext.data.TreeStore.html#" rel="property-defaultProxyType" class="cls expand">defaultProxyType</a><span> : String</span></div><div class="description"><div class="short"><p>The string type of the Proxy to create if none is specified. This defaults to creating a <a href="Ext.data.proxy.Memory.html" rel="Ext.data.proxy.Memory" class="docClass">memory proxy</a>.</p>
134 </div><div class="long"><p>The string type of the Proxy to create if none is specified. This defaults to creating a <a href="Ext.data.proxy.Memory.html" rel="Ext.data.proxy.Memory" class="docClass">memory proxy</a>.</p>
135 </div></div></div><div id="property-defaultSortDirection" class="member inherited"><a href="Ext.data.TreeStore.html#property-defaultSortDirection" rel="property-defaultSortDirection" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-property-defaultSortDirection" class="viewSource">view source</a></div><a name="defaultSortDirection"></a><a name="property-defaultSortDirection"></a><a href="Ext.data.TreeStore.html#" rel="property-defaultSortDirection" class="cls expand">defaultSortDirection</a><span> : String</span></div><div class="description"><div class="short"><p>The default sort direction to use if one is not specified (defaults to "ASC")</p>
136 </div><div class="long"><p>The default sort direction to use if one is not specified (defaults to "ASC")</p>
137 </div></div></div><div id="property-fields" class="member ni"><a href="Ext.data.TreeStore.html#property-fields" rel="property-fields" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-property-fields" class="viewSource">view source</a></div><a name="fields"></a><a name="property-fields"></a><a href="Ext.data.TreeStore.html#" rel="property-fields" class="cls expand">fields</a><span> : Object</span></div><div class="description"><div class="short">If we have no fields declare for the store, add some defaults.
138 These will be ignored if a model is explicitly specifi...</div><div class="long"><p>If we have no fields declare for the store, add some defaults.
139 These will be ignored if a model is explicitly specified.</p>
140 </div></div></div><div id="property-filterOnLoad" class="member inherited"><a href="Ext.data.TreeStore.html#property-filterOnLoad" rel="property-filterOnLoad" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-filterOnLoad" class="viewSource">view source</a></div><a name="filterOnLoad"></a><a name="property-filterOnLoad"></a><a href="Ext.data.TreeStore.html#" rel="property-filterOnLoad" class="cls expand">filterOnLoad</a><span> : Boolean</span></div><div class="description"><div class="short">If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired.
141 De...</div><div class="long"><p>If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired.
142 Defaults to true, ignored if <a href="Ext.data.TreeStore.html#remoteFilter" rel="Ext.data.TreeStore#remoteFilter" class="docClass">remoteFilter</a> is true</p>
143 </div></div></div><div id="property-filters" class="member inherited"><a href="Ext.data.TreeStore.html#property-filters" rel="property-filters" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-filters" class="viewSource">view source</a></div><a name="filters"></a><a name="property-filters"></a><a href="Ext.data.TreeStore.html#" rel="property-filters" class="cls expand">filters</a><span> : Ext.util.MixedCollection</span></div><div class="description"><div class="short"><p>The collection of <a href="Ext.util.Filter.html" rel="Ext.util.Filter" class="docClass">Filters</a> currently applied to this Store</p>
144 </div><div class="long"><p>The collection of <a href="Ext.util.Filter.html" rel="Ext.util.Filter" class="docClass">Filters</a> currently applied to this Store</p>
145 </div></div></div><div id="property-isDestroyed" class="member inherited"><a href="Ext.data.TreeStore.html#property-isDestroyed" rel="property-isDestroyed" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-isDestroyed" class="viewSource">view source</a></div><a name="isDestroyed"></a><a name="property-isDestroyed"></a><a href="Ext.data.TreeStore.html#" rel="property-isDestroyed" class="cls expand">isDestroyed</a><span> : Boolean</span></div><div class="description"><div class="short">True if the Store has already been destroyed via destroyStore. If this is true, the reference to Store should be dele...</div><div class="long"><p>True if the Store has already been destroyed via <a href="Ext.data.TreeStore.html#destroyStore" rel="Ext.data.TreeStore#destroyStore" class="docClass">destroyStore</a>. If this is true, the reference to Store should be deleted
146 as it will not function correctly any more.</p>
147 </div></div></div><div id="property-isSortable" class="member inherited"><a href="Ext.data.TreeStore.html#property-isSortable" rel="property-isSortable" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-property-isSortable" class="viewSource">view source</a></div><a name="isSortable"></a><a name="property-isSortable"></a><a href="Ext.data.TreeStore.html#" rel="property-isSortable" class="cls expand">isSortable</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Flag denoting that this object is sortable. Always true.</p>
148 </div><div class="long"><p>Flag denoting that this object is sortable. Always true.</p>
149 </div></div></div><div id="property-removeAll" class="member inherited"><a href="Ext.data.TreeStore.html#property-removeAll" rel="property-removeAll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-removeAll" class="viewSource">view source</a></div><a name="removeAll"></a><a name="property-removeAll"></a><a href="Ext.data.TreeStore.html#" rel="property-removeAll" class="cls expand">removeAll</a><span> : Object</span></div><div class="description"><div class="short">Removes all records from the store. This method does a "fast remove",
150 individual remove events are not called. The cl...</div><div class="long"><p>Removes all records from the store. This method does a "fast remove",
151 individual remove events are not called. The <a href="Ext.data.TreeStore.html#clear" rel="Ext.data.TreeStore#clear" class="docClass">clear</a> event is
152 fired upon completion.</p>
153 </div></div></div><div id="property-sortOnLoad" class="member inherited"><a href="Ext.data.TreeStore.html#property-sortOnLoad" rel="property-sortOnLoad" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-sortOnLoad" class="viewSource">view source</a></div><a name="sortOnLoad"></a><a name="property-sortOnLoad"></a><a href="Ext.data.TreeStore.html#" rel="property-sortOnLoad" class="cls expand">sortOnLoad</a><span> : Boolean</span></div><div class="description"><div class="short">If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired.
154 De...</div><div class="long"><p>If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired.
155 Defaults to true, igored if <a href="Ext.data.TreeStore.html#remoteSort" rel="Ext.data.TreeStore#remoteSort" class="docClass">remoteSort</a> is true</p>
156 </div></div></div><div id="property-sortRoot" class="member inherited"><a href="Ext.data.TreeStore.html#property-sortRoot" rel="property-sortRoot" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-property-sortRoot" class="viewSource">view source</a></div><a name="sortRoot"></a><a name="property-sortRoot"></a><a href="Ext.data.TreeStore.html#" rel="property-sortRoot" class="cls expand">sortRoot</a><span> : String</span></div><div class="description"><div class="short"><p>The property in each item that contains the data to sort. (defaults to null)</p>
157 </div><div class="long"><p>The property in each item that contains the data to sort. (defaults to null)</p>
158 </div></div></div><div id="property-sorters" class="member inherited"><a href="Ext.data.TreeStore.html#property-sorters" rel="property-sorters" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-property-sorters" class="viewSource">view source</a></div><a name="sorters"></a><a name="property-sorters"></a><a href="Ext.data.TreeStore.html#" rel="property-sorters" class="cls expand">sorters</a><span> : Ext.util.MixedCollection</span></div><div class="description"><div class="short"><p>The collection of <a href="Ext.util.Sorter.html" rel="Ext.util.Sorter" class="docClass">Sorters</a> currently applied to this Store</p>
159 </div><div class="long"><p>The collection of <a href="Ext.util.Sorter.html" rel="Ext.util.Sorter" class="docClass">Sorters</a> currently applied to this Store</p>
160 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-addEvents" class="member f inherited"><a href="Ext.data.TreeStore.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.data.TreeStore.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
161 <span class="pre">Object/String o, String </span>)
162  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
163 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
164 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
165 or the first event name string if multiple event names are being passed as separate parameters.</p>
166 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
167 Usage:</p>
168
169 <pre><code>this.addEvents('storeloaded', 'storecleared');
170 </code></pre>
171
172 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
173 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.data.TreeStore.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.data.TreeStore.html#" rel="method-addListener" class="cls expand">addListener</a>(
174 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
175  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
176 </div><div class="long"><p>Appends an event handler to this object.</p>
177 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
178 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
179 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
180 <b>If omitted, defaults to the object which fired the event.</b></p>
181 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
182 properties. This may contain any of the following properties:<ul>
183 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
184 <b>If omitted, defaults to the object which fired the event.</b></div></li>
185 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
186 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
187 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
188 by the specified number of milliseconds. If the event fires again within that time, the original
189 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
190 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
191 if the event was bubbled up from a child Observable.</div></li>
192 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
193 The name of a Component property which references an element to add a listener to.</p>
194
195 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
196 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
197 <pre><code>new Ext.panel.Panel({
198     title: 'The title',
199     listeners: {
200         click: this.handlePanelClick,
201         element: 'body'
202     }
203 });
204 </code></pre></p>
205
206
207 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
208
209
210 <p></div></li>
211 </ul><br></p>
212
213 <p>
214 <b>Combining Options</b><br>
215 Using the options argument, it is possible to combine different types of listeners:<br>
216 <br>
217 A delayed, one-time listener.
218 <pre><code>myPanel.on('hide', this.handleClick, this, {
219 single: true,
220 delay: 100
221 });</code></pre>
222 <p>
223 <b>Attaching multiple handlers in 1 call</b><br>
224 The method also allows for a single argument to be passed which is a config object containing properties
225 which specify multiple events. For example:
226 <pre><code>myGridPanel.on({
227     cellClick: this.onCellClick,
228     mouseover: this.onMouseOver,
229     mouseout: this.onMouseOut,
230     scope: this // Important. Ensure "this" is correct during handler execution
231 });
232 </code></pre>.
233 <p>
234
235 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
236 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.data.TreeStore.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.data.TreeStore.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
237 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
238  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
239 is destroyed.
240
241 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
242 is destroyed.
243
244 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
245 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
246 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
247 is the handler function.</p>
248 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
249 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
250 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
251 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
252 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
253 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.data.TreeStore.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.data.TreeStore.html#" rel="method-capture" class="cls expand">capture</a>(
254 <span class="pre">Observable o, Function fn, [Object scope]</span>)
255  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
256 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
257 to the supplied function with the event name + standard signature of the event
258 <b>before</b> the event is fired. If the supplied function returns false,
259 the event will not fire.</p>
260 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
261 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
262 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
263 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
264 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.data.TreeStore.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.data.TreeStore.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
265 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
266 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
267 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.data.TreeStore.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.data.TreeStore.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
268 </div><div class="long"><p>Removes all managed listeners for this object.</p>
269 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
270 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.data.TreeStore.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.data.TreeStore.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
271 <span class="pre">String/Array events</span>)
272  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
273 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
274 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
275
276
277 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
278 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
279 access the required target more quickly.</p>
280
281
282 <p>Example:</p>
283
284
285 <pre><code>Ext.override(Ext.form.field.Base, {
286 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
287 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
288     this.enableBubble('change');
289 }),
290
291 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
292 getBubbleTarget : function() {
293     if (!this.formPanel) {
294         this.formPanel = this.findParentByType('form');
295     }
296     return this.formPanel;
297 }
298 });
299
300 var myForm = new Ext.formPanel({
301 title: 'User Details',
302 items: [{
303     ...
304 }],
305 listeners: {
306     change: function() {
307         // Title goes red if form has been modified.
308         myForm.header.setStyle('color', 'red');
309     }
310 }
311 });
312 </code></pre>
313
314 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
315 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
316 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.data.TreeStore.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.data.TreeStore.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
317 <span class="pre">String eventName, Object... args</span>)
318  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
319
320
321 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
322
323
324 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
325 by calling <a href="Ext.data.TreeStore.html#enableBubble" rel="Ext.data.TreeStore#enableBubble" class="docClass">enableBubble</a>.</p>
326
327 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
328 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
329 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
330 </li></ul></div></div></div><div id="method-getNewRecords" class="member inherited"><a href="Ext.data.TreeStore.html#method-getNewRecords" rel="method-getNewRecords" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-method-getNewRecords" class="viewSource">view source</a></div><a name="getNewRecords"></a><a name="method-getNewRecords"></a><a href="Ext.data.TreeStore.html#" rel="method-getNewRecords" class="cls expand">getNewRecords</a> : Array</div><div class="description"><div class="short">Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not
331 yet bee...</div><div class="long"><p>Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not
332 yet been saved on this Store (this happens when adding a non-phantom record from another Store into this one)</p>
333 <h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The Model instances</p>
334 </li></ul></div></div></div><div id="method-getNodeById" class="member ni"><a href="Ext.data.TreeStore.html#method-getNodeById" rel="method-getNodeById" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-method-getNodeById" class="viewSource">view source</a></div><a name="getNodeById"></a><a name="method-getNodeById"></a><a href="Ext.data.TreeStore.html#" rel="method-getNodeById" class="cls expand">getNodeById</a>(
335 <span class="pre">Object id</span>)
336  : Ext.data.NodeInterface</div><div class="description"><div class="short"><p>Returns the record node by id</p>
337 </div><div class="long"><p>Returns the record node by id</p>
338 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : Object<div class="sub-desc">
339 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.NodeInterface</span>&nbsp; &nbsp;
340 </li></ul></div></div></div><div id="method-getProxy" class="member inherited"><a href="Ext.data.TreeStore.html#method-getProxy" rel="method-getProxy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-method-getProxy" class="viewSource">view source</a></div><a name="getProxy"></a><a name="method-getProxy"></a><a href="Ext.data.TreeStore.html#" rel="method-getProxy" class="cls expand">getProxy</a> : Ext.data.proxy.Proxy</div><div class="description"><div class="short"><p>Returns the proxy currently attached to this proxy instance</p>
341 </div><div class="long"><p>Returns the proxy currently attached to this proxy instance</p>
342 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.proxy.Proxy</span>&nbsp; &nbsp;<p>The Proxy instance</p>
343 </li></ul></div></div></div><div id="method-getRootNode" class="member ni"><a href="Ext.data.TreeStore.html#method-getRootNode" rel="method-getRootNode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-method-getRootNode" class="viewSource">view source</a></div><a name="getRootNode"></a><a name="method-getRootNode"></a><a href="Ext.data.TreeStore.html#" rel="method-getRootNode" class="cls expand">getRootNode</a> : Ext.data.NodeInterface</div><div class="description"><div class="short"><p>Returns the root node for this tree.</p>
344 </div><div class="long"><p>Returns the root node for this tree.</p>
345 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.NodeInterface</span>&nbsp; &nbsp;
346 </li></ul></div></div></div><div id="method-getSortState" class="member inherited"><a href="Ext.data.TreeStore.html#method-getSortState" rel="method-getSortState" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-method-getSortState" class="viewSource">view source</a></div><a name="getSortState"></a><a name="method-getSortState"></a><a href="Ext.data.TreeStore.html#" rel="method-getSortState" class="cls expand">getSortState</a> : Object</div><div class="description"><div class="short"><p>Returns an object describing the current sort state of this Store.</p>
347 </div><div class="long"><p>Returns an object describing the current sort state of this Store.</p>
348 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The sort state of the Store. An object with two properties:<ul>
349 <li><b>field</b> : String<p class="sub-desc">The name of the field by which the Records are sorted.</p></li>
350 <li><b>direction</b> : String<p class="sub-desc">The sort order, 'ASC' or 'DESC' (case-sensitive).</p></li>
351 </ul>
352 See <tt><a href="Ext.data.TreeStore.html#sortInfo" rel="Ext.data.TreeStore#sortInfo" class="docClass">sortInfo</a></tt> for additional details.</p>
353 </li></ul></div></div></div><div id="method-getUpdatedRecords" class="member inherited"><a href="Ext.data.TreeStore.html#method-getUpdatedRecords" rel="method-getUpdatedRecords" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-method-getUpdatedRecords" class="viewSource">view source</a></div><a name="getUpdatedRecords"></a><a name="method-getUpdatedRecords"></a><a href="Ext.data.TreeStore.html#" rel="method-getUpdatedRecords" class="cls expand">getUpdatedRecords</a> : Array</div><div class="description"><div class="short"><p>Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy</p>
354 </div><div class="long"><p>Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy</p>
355 <h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The updated Model instances</p>
356 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.data.TreeStore.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.data.TreeStore.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
357 <span class="pre">String eventName</span>)
358  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
359 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
360 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
361 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
362 </li></ul></div></div></div><div id="method-initSortable" class="member inherited"><a href="Ext.data.TreeStore.html#method-initSortable" rel="method-initSortable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-method-initSortable" class="viewSource">view source</a></div><a name="initSortable"></a><a name="method-initSortable"></a><a href="Ext.data.TreeStore.html#" rel="method-initSortable" class="cls expand">initSortable</a> : void</div><div class="description"><div class="short">Performs initialization of this mixin. Component classes using this mixin should call this method
363 during their own in...</div><div class="long"><p>Performs initialization of this mixin. Component classes using this mixin should call this method
364 during their own initialization.</p>
365 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
366 </li></ul></div></div></div><div id="method-isLoading" class="member inherited"><a href="Ext.data.TreeStore.html#method-isLoading" rel="method-isLoading" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-method-isLoading" class="viewSource">view source</a></div><a name="isLoading"></a><a name="method-isLoading"></a><a href="Ext.data.TreeStore.html#" rel="method-isLoading" class="cls expand">isLoading</a> : Boolean</div><div class="description"><div class="short"><p>Returns true if the Store is currently performing a load operation</p>
367 </div><div class="long"><p>Returns true if the Store is currently performing a load operation</p>
368 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the Store is currently loading</p>
369 </li></ul></div></div></div><div id="method-load" class="member ni"><a href="Ext.data.TreeStore.html#method-load" rel="method-load" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-method-load" class="viewSource">view source</a></div><a name="load"></a><a name="method-load"></a><a href="Ext.data.TreeStore.html#" rel="method-load" class="cls expand">load</a>(
370 <span class="pre">Object options</span>)
371  : void</div><div class="description"><div class="short"><p>Loads the Store using its configured <a href="Ext.data.TreeStore.html#proxy" rel="Ext.data.TreeStore#proxy" class="docClass">proxy</a>.</p>
372 </div><div class="long"><p>Loads the Store using its configured <a href="Ext.data.TreeStore.html#proxy" rel="Ext.data.TreeStore#proxy" class="docClass">proxy</a>.</p>
373 <h3 class="pa">Parameters</h3><ul><li><span class="pre">options</span> : Object<div class="sub-desc"><p>Optional config object. This is passed into the <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">Operation</a>
374 object that is created and then sent to the proxy's <a href="Ext.data.proxy.Proxy.html#read" rel="Ext.data.proxy.Proxy#read" class="docClass">Ext.data.proxy.Proxy.read</a> function.
375 The options can also contain a node, which indicates which node is to be loaded. If not specified, it will
376 default to the root node.</p>
377 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
378 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.data.TreeStore.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.data.TreeStore.html#" rel="method-observe" class="cls expand">observe</a>(
379 <span class="pre">Function c, Object listeners</span>)
380  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
381
382 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
383
384 <p>This makes any event fired on any instance of the passed class also fire a single event through
385 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
386
387 <p>Usage:</p>
388
389 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
390 Ext.data.Connection.on('beforerequest', function(con, options) {
391     console.log('Ajax request made to ' + options.url);
392 });
393 </code></pre>
394 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
395 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.data.TreeStore.html#addListener" rel="Ext.data.TreeStore#addListener" class="docClass">addListener</a>.</p>
396 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
397 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.data.TreeStore.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.data.TreeStore.html#" rel="method-on" class="cls expand">on</a>(
398 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
399  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.TreeStore.html#addListener" rel="Ext.data.TreeStore#addListener" class="docClass">addListener</a>.)</p>
400 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.TreeStore.html#addListener" rel="Ext.data.TreeStore#addListener" class="docClass">addListener</a>.)</p>
401 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
402 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
403 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
404 <b>If omitted, defaults to the object which fired the event.</b></p>
405 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
406 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
407 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.data.TreeStore.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.data.TreeStore.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
408 <span class="pre">Object origin, Array events, Object prefix</span>)
409  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
410 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
411 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
412 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
413 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
414 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
415 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.data.TreeStore.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.data.TreeStore.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
416 <span class="pre">Observable o</span>)
417  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
418 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
419 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
420 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
421 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.data.TreeStore.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.data.TreeStore.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
422 <span class="pre">String eventName, Function handler, [Object scope]</span>)
423  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
424 </div><div class="long"><p>Removes an event handler.</p>
425 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
426 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.data.TreeStore.html#addListener" rel="Ext.data.TreeStore#addListener" class="docClass">addListener</a> call.</b></p>
427 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
428 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
429 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.data.TreeStore.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.data.TreeStore.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
430 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
431  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.data.TreeStore.html#mon" rel="Ext.data.TreeStore#mon" class="docClass">mon</a> method.</p>
432 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.data.TreeStore.html#mon" rel="Ext.data.TreeStore#mon" class="docClass">mon</a> method.</p>
433 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
434 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
435 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
436 is the handler function.</p>
437 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
438 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
439 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
440 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.data.TreeStore.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.data.TreeStore.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
441 If events were suspended using the queueSuspended parameter, then all
442 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.data.TreeStore.html#suspendEvents" rel="Ext.data.TreeStore#suspendEvents" class="docClass">suspendEvents</a>)
443 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
444 events fired during event suspension will be sent to any listeners now.</p>
445 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
446 </li></ul></div></div></div><div id="method-setProxy" class="member inherited"><a href="Ext.data.TreeStore.html#method-setProxy" rel="method-setProxy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-method-setProxy" class="viewSource">view source</a></div><a name="setProxy"></a><a name="method-setProxy"></a><a href="Ext.data.TreeStore.html#" rel="method-setProxy" class="cls expand">setProxy</a>(
447 <span class="pre">String|Object|Ext.data.proxy.Proxy proxy</span>)
448  : Ext.data.proxy.Proxy</div><div class="description"><div class="short"><p>Sets the Store's Proxy by string, config object or Proxy instance</p>
449 </div><div class="long"><p>Sets the Store's Proxy by string, config object or Proxy instance</p>
450 <h3 class="pa">Parameters</h3><ul><li><span class="pre">proxy</span> : String|Object|Ext.data.proxy.Proxy<div class="sub-desc"><p>The new Proxy, which can be either a type string, a configuration object
451 or an <a href="Ext.data.proxy.Proxy.html" rel="Ext.data.proxy.Proxy" class="docClass">Ext.data.proxy.Proxy</a> instance</p>
452 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.proxy.Proxy</span>&nbsp; &nbsp;<p>The attached Proxy object</p>
453 </li></ul></div></div></div><div id="method-setRootNode" class="member ni"><a href="Ext.data.TreeStore.html#method-setRootNode" rel="method-setRootNode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-method-setRootNode" class="viewSource">view source</a></div><a name="setRootNode"></a><a name="method-setRootNode"></a><a href="Ext.data.TreeStore.html#" rel="method-setRootNode" class="cls expand">setRootNode</a>(
454 <span class="pre">Ext.data.Model/Ext.data.NodeInterface root</span>)
455  : Ext.data.NodeInterface</div><div class="description"><div class="short"><p>Sets the root node for this store</p>
456 </div><div class="long"><p>Sets the root node for this store</p>
457 <h3 class="pa">Parameters</h3><ul><li><span class="pre">root</span> : Ext.data.Model/Ext.data.NodeInterface<div class="sub-desc">
458 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.NodeInterface</span>&nbsp; &nbsp;<p>The new root</p>
459 </li></ul></div></div></div><div id="method-sort" class="member inherited"><a href="Ext.data.TreeStore.html#method-sort" rel="method-sort" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-method-sort" class="viewSource">view source</a></div><a name="sort"></a><a name="method-sort"></a><a href="Ext.data.TreeStore.html#" rel="method-sort" class="cls expand">sort</a>(
460 <span class="pre">String|Array sorters, String direction, Object where, Object doSort</span>)
461  : void</div><div class="description"><div class="short">Sorts the data in the Store by one or more of its properties. Example usage:
462
463
464 //sort by a single field
465 myStore.sort(...</div><div class="long"><p>Sorts the data in the Store by one or more of its properties. Example usage:</p>
466
467
468 <pre><code>//sort by a single field
469 myStore.sort('myField', 'DESC');
470
471 //sorting by multiple fields
472 myStore.sort([
473     {
474         property : 'age',
475         direction: 'ASC'
476     },
477     {
478         property : 'name',
479         direction: 'DESC'
480     }
481 ]);
482 </code></pre>
483
484
485 <p>Internally, Store converts the passed arguments into an array of <a href="Ext.util.Sorter.html" rel="Ext.util.Sorter" class="docClass">Ext.util.Sorter</a> instances, and delegates the actual
486 sorting to its internal <a href="Ext.util.MixedCollection.html" rel="Ext.util.MixedCollection" class="docClass">Ext.util.MixedCollection</a>.</p>
487
488
489 <p>When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:</p>
490
491
492 <pre><code>store.sort('myField');
493 store.sort('myField');
494      </code></pre>
495
496
497 <p>Is equivalent to this code, because Store handles the toggling automatically:</p>
498
499
500 <pre><code>store.sort('myField', 'ASC');
501 store.sort('myField', 'DESC');
502 </code></pre>
503
504 <h3 class="pa">Parameters</h3><ul><li><span class="pre">sorters</span> : String|Array<div class="sub-desc"><p>Either a string name of one of the fields in this Store's configured <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Model</a>,
505 or an Array of sorter configurations.</p>
506 </div></li><li><span class="pre">direction</span> : String<div class="sub-desc"><p>The overall direction to sort the data by. Defaults to "ASC".</p>
507 </div></li><li><span class="pre">where</span> : Object<div class="sub-desc">
508 </div></li><li><span class="pre">doSort</span> : Object<div class="sub-desc">
509 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
510 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.data.TreeStore.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.data.TreeStore.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
511 <span class="pre">Boolean queueSuspended</span>)
512  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.data.TreeStore.html#resumeEvents" rel="Ext.data.TreeStore#resumeEvents" class="docClass">resumeEvents</a>)</p>
513 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.data.TreeStore.html#resumeEvents" rel="Ext.data.TreeStore#resumeEvents" class="docClass">resumeEvents</a>)</p>
514 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
515 after the <a href="Ext.data.TreeStore.html#resumeEvents" rel="Ext.data.TreeStore#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
516 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
517 </li></ul></div></div></div><div id="method-sync" class="member inherited"><a href="Ext.data.TreeStore.html#method-sync" rel="method-sync" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-method-sync" class="viewSource">view source</a></div><a name="sync"></a><a name="method-sync"></a><a href="Ext.data.TreeStore.html#" rel="method-sync" class="cls expand">sync</a> : void</div><div class="description"><div class="short">Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated
518 and deleted records in ...</div><div class="long"><p>Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated
519 and deleted records in the store, updating the Store's internal representation of the records
520 as each operation completes.</p>
521 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
522 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.data.TreeStore.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.data.TreeStore.html#" rel="method-un" class="cls expand">un</a>(
523 <span class="pre">String eventName, Function handler, [Object scope]</span>)
524  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.data.TreeStore.html#removeListener" rel="Ext.data.TreeStore#removeListener" class="docClass">removeListener</a>.)</p>
525 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.data.TreeStore.html#removeListener" rel="Ext.data.TreeStore#removeListener" class="docClass">removeListener</a>.)</p>
526 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
527 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.data.TreeStore.html#addListener" rel="Ext.data.TreeStore#addListener" class="docClass">addListener</a> call.</b></p>
528 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
529 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
530 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-add" class="member f inherited"><a href="Ext.data.TreeStore.html#event-add" rel="event-add" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-add" class="viewSource">view source</a></div><a name="add"></a><a name="event-add"></a><a href="Ext.data.TreeStore.html#" rel="event-add" class="cls expand">add</a>(
531 <span class="pre">Ext.data.Store store, Array records, Number index</span>)
532 </div><div class="description"><div class="short"><p>Fired when a Model instance has been added to this Store</p>
533 </div><div class="long"><p>Fired when a Model instance has been added to this Store</p>
534 <h3 class="pa">Parameters</h3><ul><li><span class="pre">store</span> : Ext.data.Store<div class="sub-desc"><p>The store</p>
535 </div></li><li><span class="pre">records</span> : Array<div class="sub-desc"><p>The Model instances that were added</p>
536 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index at which the instances were inserted</p>
537 </div></li></ul></div></div></div><div id="event-append" class="member ni"><a href="Ext.data.TreeStore.html#event-append" rel="event-append" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-append" class="viewSource">view source</a></div><a name="append"></a><a name="event-append"></a><a href="Ext.data.TreeStore.html#" rel="event-append" class="cls expand">append</a>(
538 <span class="pre">Tree tree, Node parent, Node node, Number index</span>)
539 </div><div class="description"><div class="short"><p>Fires when a new child node is appended to a node in this store's tree.</p>
540 </div><div class="long"><p>Fires when a new child node is appended to a node in this store's tree.</p>
541 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
542 </div></li><li><span class="pre">parent</span> : Node<div class="sub-desc"><p>The parent node</p>
543 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The newly appended node</p>
544 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index of the newly appended node</p>
545 </div></li></ul></div></div></div><div id="event-beforeappend" class="member ni"><a href="Ext.data.TreeStore.html#event-beforeappend" rel="event-beforeappend" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-beforeappend" class="viewSource">view source</a></div><a name="beforeappend"></a><a name="event-beforeappend"></a><a href="Ext.data.TreeStore.html#" rel="event-beforeappend" class="cls expand">beforeappend</a>(
546 <span class="pre">Tree tree, Node parent, Node node</span>)
547 </div><div class="description"><div class="short"><p>Fires before a new child is appended to a node in this store's tree, return false to cancel the append.</p>
548 </div><div class="long"><p>Fires before a new child is appended to a node in this store's tree, return false to cancel the append.</p>
549 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
550 </div></li><li><span class="pre">parent</span> : Node<div class="sub-desc"><p>The parent node</p>
551 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The child node to be appended</p>
552 </div></li></ul></div></div></div><div id="event-beforecollapse" class="member ni"><a href="Ext.data.TreeStore.html#event-beforecollapse" rel="event-beforecollapse" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-beforecollapse" class="viewSource">view source</a></div><a name="beforecollapse"></a><a name="event-beforecollapse"></a><a href="Ext.data.TreeStore.html#" rel="event-beforecollapse" class="cls expand">beforecollapse</a>(
553 <span class="pre">Node this</span>)
554 </div><div class="description"><div class="short"><p>Fires before this node is collapsed.</p>
555 </div><div class="long"><p>Fires before this node is collapsed.</p>
556 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Node<div class="sub-desc"><p>The collapsing node</p>
557 </div></li></ul></div></div></div><div id="event-beforeexpand" class="member ni"><a href="Ext.data.TreeStore.html#event-beforeexpand" rel="event-beforeexpand" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-beforeexpand" class="viewSource">view source</a></div><a name="beforeexpand"></a><a name="event-beforeexpand"></a><a href="Ext.data.TreeStore.html#" rel="event-beforeexpand" class="cls expand">beforeexpand</a>(
558 <span class="pre">Node this</span>)
559 </div><div class="description"><div class="short"><p>Fires before this node is expanded.</p>
560 </div><div class="long"><p>Fires before this node is expanded.</p>
561 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Node<div class="sub-desc"><p>The expanding node</p>
562 </div></li></ul></div></div></div><div id="event-beforeinsert" class="member ni"><a href="Ext.data.TreeStore.html#event-beforeinsert" rel="event-beforeinsert" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-beforeinsert" class="viewSource">view source</a></div><a name="beforeinsert"></a><a name="event-beforeinsert"></a><a href="Ext.data.TreeStore.html#" rel="event-beforeinsert" class="cls expand">beforeinsert</a>(
563 <span class="pre">Tree tree, Node parent, Node node, Node refNode</span>)
564 </div><div class="description"><div class="short"><p>Fires before a new child is inserted in a node in this store's tree, return false to cancel the insert.</p>
565 </div><div class="long"><p>Fires before a new child is inserted in a node in this store's tree, return false to cancel the insert.</p>
566 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
567 </div></li><li><span class="pre">parent</span> : Node<div class="sub-desc"><p>The parent node</p>
568 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The child node to be inserted</p>
569 </div></li><li><span class="pre">refNode</span> : Node<div class="sub-desc"><p>The child node the node is being inserted before</p>
570 </div></li></ul></div></div></div><div id="event-beforeload" class="member inherited"><a href="Ext.data.TreeStore.html#event-beforeload" rel="event-beforeload" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-beforeload" class="viewSource">view source</a></div><a name="beforeload"></a><a name="event-beforeload"></a><a href="Ext.data.TreeStore.html#" rel="event-beforeload" class="cls expand">beforeload</a>(
571 <span class="pre">Ext.data.Store store, Ext.data.Operation operation</span>)
572 </div><div class="description"><div class="short"><p>Event description</p>
573 </div><div class="long"><p>Event description</p>
574 <h3 class="pa">Parameters</h3><ul><li><span class="pre">store</span> : Ext.data.Store<div class="sub-desc"><p>This Store</p>
575 </div></li><li><span class="pre">operation</span> : Ext.data.Operation<div class="sub-desc"><p>The <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">Ext.data.Operation</a> object that will be passed to the Proxy to load the Store</p>
576 </div></li></ul></div></div></div><div id="event-beforemove" class="member ni"><a href="Ext.data.TreeStore.html#event-beforemove" rel="event-beforemove" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-beforemove" class="viewSource">view source</a></div><a name="beforemove"></a><a name="event-beforemove"></a><a href="Ext.data.TreeStore.html#" rel="event-beforemove" class="cls expand">beforemove</a>(
577 <span class="pre">Tree tree, Node node, Node oldParent, Node newParent, Number index</span>)
578 </div><div class="description"><div class="short"><p>Fires before a node is moved to a new location in the store's tree. Return false to cancel the move.</p>
579 </div><div class="long"><p>Fires before a node is moved to a new location in the store's tree. Return false to cancel the move.</p>
580 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
581 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The node being moved</p>
582 </div></li><li><span class="pre">oldParent</span> : Node<div class="sub-desc"><p>The parent of the node</p>
583 </div></li><li><span class="pre">newParent</span> : Node<div class="sub-desc"><p>The new parent the node is moving to</p>
584 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index it is being moved to</p>
585 </div></li></ul></div></div></div><div id="event-beforeremove" class="member ni"><a href="Ext.data.TreeStore.html#event-beforeremove" rel="event-beforeremove" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-beforeremove" class="viewSource">view source</a></div><a name="beforeremove"></a><a name="event-beforeremove"></a><a href="Ext.data.TreeStore.html#" rel="event-beforeremove" class="cls expand">beforeremove</a>(
586 <span class="pre">Tree tree, Node parent, Node node</span>)
587 </div><div class="description"><div class="short"><p>Fires before a child is removed from a node in this store's tree, return false to cancel the remove.</p>
588 </div><div class="long"><p>Fires before a child is removed from a node in this store's tree, return false to cancel the remove.</p>
589 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
590 </div></li><li><span class="pre">parent</span> : Node<div class="sub-desc"><p>The parent node</p>
591 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The child node to be removed</p>
592 </div></li></ul></div></div></div><div id="event-beforesync" class="member inherited"><a href="Ext.data.TreeStore.html#event-beforesync" rel="event-beforesync" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-beforesync" class="viewSource">view source</a></div><a name="beforesync"></a><a name="event-beforesync"></a><a href="Ext.data.TreeStore.html#" rel="event-beforesync" class="cls expand">beforesync</a>(
593 <span class="pre">Object options</span>)
594 </div><div class="description"><div class="short"><p>Called before a call to <a href="Ext.data.TreeStore.html#sync" rel="Ext.data.TreeStore#sync" class="docClass">sync</a> is executed. Return false from any listener to cancel the synv</p>
595 </div><div class="long"><p>Called before a call to <a href="Ext.data.TreeStore.html#sync" rel="Ext.data.TreeStore#sync" class="docClass">sync</a> is executed. Return false from any listener to cancel the synv</p>
596 <h3 class="pa">Parameters</h3><ul><li><span class="pre">options</span> : Object<div class="sub-desc"><p>Hash of all records to be synchronized, broken down into create, update and destroy</p>
597 </div></li></ul></div></div></div><div id="event-clear" class="member inherited"><a href="Ext.data.TreeStore.html#event-clear" rel="event-clear" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-clear" class="viewSource">view source</a></div><a name="clear"></a><a name="event-clear"></a><a href="Ext.data.TreeStore.html#" rel="event-clear" class="cls expand">clear</a>(
598 <span class="pre">Ext.data.Store this</span>)
599 </div><div class="description"><div class="short"><p>Fired after the <a href="Ext.data.TreeStore.html#removeAll" rel="Ext.data.TreeStore#removeAll" class="docClass">removeAll</a> method is called.</p>
600 </div><div class="long"><p>Fired after the <a href="Ext.data.TreeStore.html#removeAll" rel="Ext.data.TreeStore#removeAll" class="docClass">removeAll</a> method is called.</p>
601 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.data.Store<div class="sub-desc">
602 </div></li></ul></div></div></div><div id="event-collapse" class="member ni"><a href="Ext.data.TreeStore.html#event-collapse" rel="event-collapse" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-collapse" class="viewSource">view source</a></div><a name="collapse"></a><a name="event-collapse"></a><a href="Ext.data.TreeStore.html#" rel="event-collapse" class="cls expand">collapse</a>(
603 <span class="pre">Node this</span>)
604 </div><div class="description"><div class="short"><p>Fires when this node is collapsed.</p>
605 </div><div class="long"><p>Fires when this node is collapsed.</p>
606 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Node<div class="sub-desc"><p>The collapsing node</p>
607 </div></li></ul></div></div></div><div id="event-datachanged" class="member inherited"><a href="Ext.data.TreeStore.html#event-datachanged" rel="event-datachanged" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-datachanged" class="viewSource">view source</a></div><a name="datachanged"></a><a name="event-datachanged"></a><a href="Ext.data.TreeStore.html#" rel="event-datachanged" class="cls expand">datachanged</a>(
608 <span class="pre">Ext.data.Store this</span>)
609 </div><div class="description"><div class="short">Fires whenever the records in the Store have changed in some way - this could include adding or removing records,
610 or ...</div><div class="long"><p>Fires whenever the records in the Store have changed in some way - this could include adding or removing records,
611 or updating the data in existing records</p>
612 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.data.Store<div class="sub-desc"><p>The data store</p>
613 </div></li></ul></div></div></div><div id="event-expand" class="member ni"><a href="Ext.data.TreeStore.html#event-expand" rel="event-expand" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-expand" class="viewSource">view source</a></div><a name="expand"></a><a name="event-expand"></a><a href="Ext.data.TreeStore.html#" rel="event-expand" class="cls expand">expand</a>(
614 <span class="pre">Node this</span>)
615 </div><div class="description"><div class="short"><p>Fires when this node is expanded.</p>
616 </div><div class="long"><p>Fires when this node is expanded.</p>
617 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Node<div class="sub-desc"><p>The expanding node</p>
618 </div></li></ul></div></div></div><div id="event-insert" class="member ni"><a href="Ext.data.TreeStore.html#event-insert" rel="event-insert" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-insert" class="viewSource">view source</a></div><a name="insert"></a><a name="event-insert"></a><a href="Ext.data.TreeStore.html#" rel="event-insert" class="cls expand">insert</a>(
619 <span class="pre">Tree tree, Node parent, Node node, Node refNode</span>)
620 </div><div class="description"><div class="short"><p>Fires when a new child node is inserted in a node in this store's tree.</p>
621 </div><div class="long"><p>Fires when a new child node is inserted in a node in this store's tree.</p>
622 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
623 </div></li><li><span class="pre">parent</span> : Node<div class="sub-desc"><p>The parent node</p>
624 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The child node inserted</p>
625 </div></li><li><span class="pre">refNode</span> : Node<div class="sub-desc"><p>The child node the node was inserted before</p>
626 </div></li></ul></div></div></div><div id="event-load" class="member inherited"><a href="Ext.data.TreeStore.html#event-load" rel="event-load" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-load" class="viewSource">view source</a></div><a name="load"></a><a name="event-load"></a><a href="Ext.data.TreeStore.html#" rel="event-load" class="cls expand">load</a>(
627 <span class="pre">Ext.data.Store this, Array records, Boolean successful</span>)
628 </div><div class="description"><div class="short"><p>Fires whenever the store reads data from a remote data source.</p>
629 </div><div class="long"><p>Fires whenever the store reads data from a remote data source.</p>
630 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.data.Store<div class="sub-desc">
631 </div></li><li><span class="pre">records</span> : Array<div class="sub-desc"><p>An array of records</p>
632 </div></li><li><span class="pre">successful</span> : Boolean<div class="sub-desc"><p>True if the operation was successful.</p>
633 </div></li></ul></div></div></div><div id="event-move" class="member ni"><a href="Ext.data.TreeStore.html#event-move" rel="event-move" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-move" class="viewSource">view source</a></div><a name="move"></a><a name="event-move"></a><a href="Ext.data.TreeStore.html#" rel="event-move" class="cls expand">move</a>(
634 <span class="pre">Tree tree, Node node, Node oldParent, Node newParent, Number index</span>)
635 </div><div class="description"><div class="short"><p>Fires when a node is moved to a new location in the store's tree</p>
636 </div><div class="long"><p>Fires when a node is moved to a new location in the store's tree</p>
637 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
638 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The node moved</p>
639 </div></li><li><span class="pre">oldParent</span> : Node<div class="sub-desc"><p>The old parent of this node</p>
640 </div></li><li><span class="pre">newParent</span> : Node<div class="sub-desc"><p>The new parent of this node</p>
641 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index it was moved to</p>
642 </div></li></ul></div></div></div><div id="event-remove" class="member ni"><a href="Ext.data.TreeStore.html#event-remove" rel="event-remove" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-remove" class="viewSource">view source</a></div><a name="remove"></a><a name="event-remove"></a><a href="Ext.data.TreeStore.html#" rel="event-remove" class="cls expand">remove</a>(
643 <span class="pre">Tree tree, Node parent, Node node</span>)
644 </div><div class="description"><div class="short"><p>Fires when a child node is removed from a node in this store's tree.</p>
645 </div><div class="long"><p>Fires when a child node is removed from a node in this store's tree.</p>
646 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
647 </div></li><li><span class="pre">parent</span> : Node<div class="sub-desc"><p>The parent node</p>
648 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The child node removed</p>
649 </div></li></ul></div></div></div><div id="event-rootchange" class="member ni"><a href="Ext.data.TreeStore.html#event-rootchange" rel="event-rootchange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-rootchange" class="viewSource">view source</a></div><a name="rootchange"></a><a name="event-rootchange"></a><a href="Ext.data.TreeStore.html#" rel="event-rootchange" class="cls expand">rootchange</a>(
650 <span class="pre">Ext.data.TreeStore store, Node The</span>)
651 </div><div class="description"><div class="short"><p>Fires when the root node on this TreeStore is changed.</p>
652 </div><div class="long"><p>Fires when the root node on this TreeStore is changed.</p>
653 <h3 class="pa">Parameters</h3><ul><li><span class="pre">store</span> : Ext.data.TreeStore<div class="sub-desc"><p>This TreeStore</p>
654 </div></li><li><span class="pre">The</span> : Node<div class="sub-desc"><p>new root node.</p>
655 </div></li></ul></div></div></div><div id="event-sort" class="member ni"><a href="Ext.data.TreeStore.html#event-sort" rel="event-sort" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.TreeStore.html" class="definedIn docClass">Ext.data.TreeStore</a><br/><a href="../source/TreeStore.html#Ext-data.TreeStore-event-sort" class="viewSource">view source</a></div><a name="sort"></a><a name="event-sort"></a><a href="Ext.data.TreeStore.html#" rel="event-sort" class="cls expand">sort</a>(
656 <span class="pre">Node node</span>)
657 </div><div class="description"><div class="short"><p>Fires when this TreeStore is sorted.</p>
658 </div><div class="long"><p>Fires when this TreeStore is sorted.</p>
659 <h3 class="pa">Parameters</h3><ul><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The node that is sorted.</p>
660 </div></li></ul></div></div></div><div id="event-update" class="member inherited"><a href="Ext.data.TreeStore.html#event-update" rel="event-update" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-update" class="viewSource">view source</a></div><a name="update"></a><a name="event-update"></a><a href="Ext.data.TreeStore.html#" rel="event-update" class="cls expand">update</a>(
661 <span class="pre">Store this, Ext.data.Model record, String operation</span>)
662 </div><div class="description"><div class="short"><p>Fires when a Record has been updated</p>
663 </div><div class="long"><p>Fires when a Record has been updated</p>
664 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Store<div class="sub-desc">
665 </div></li><li><span class="pre">record</span> : Ext.data.Model<div class="sub-desc"><p>The Model instance that was updated</p>
666 </div></li><li><span class="pre">operation</span> : String<div class="sub-desc"><p>The update operation being performed. Value may be one of:</p>
667
668 <pre><code>               Ext.data.Model.EDIT
669                Ext.data.Model.REJECT
670                Ext.data.Model.COMMIT
671 </code></pre>
672
673 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>