Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.data.AbstractStore.html
1 <!DOCTYPE html><html><head><title>Ext.data.AbstractStore | 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.AbstractStore',
13         docClass: 'Ext.data.AbstractStore',
14         docReq: 'Ext.data.AbstractStore',
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 = 'AbstractStore.html#Ext-data.AbstractStore';
33     clsInfo = {"methods":["addEvents","addListener","addManagedListener","capture","clearListeners","clearManagedListeners","enableBubble","fireEvent","getNewRecords","getProxy","getSortState","getUpdatedRecords","hasListener","initSortable","isLoading","load","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","setProxy","sort","suspendEvents","sync","un"],"cfgs":["autoLoad","autoSync","fields","listeners","proxy","storeId"],"properties":["batchUpdateMode","defaultProxyType","defaultSortDirection","filterOnLoad","filters","isDestroyed","isSortable","removeAll","sortOnLoad","sortRoot","sorters"],"events":["add","beforeload","beforesync","clear","datachanged","load","remove","update"],"subclasses":["Ext.data.NodeStore","Ext.data.Store","Ext.data.TreeStore"]};
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/AbstractStore.html#Ext-data.AbstractStore" target="_blank">Ext.data.AbstractStore</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><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>AbstractStore is a superclass of <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Ext.data.Store</a> and <a href="Ext.data.TreeStore.html" rel="Ext.data.TreeStore" class="docClass">Ext.data.TreeStore</a>. It's never used directly,
38 but offers a set of methods used by both of those subclasses.</p>
39
40
41
42
43 <p>We've left it here in the docs for reference purposes, but unless you need to make a whole new type of Store, what
44 you're probably looking for is <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Ext.data.Store</a>. If you're still interested, here's a brief description of what 
45 AbstractStore is and is not.</p>
46
47
48
49
50 <p>AbstractStore provides the basic configuration for anything that can be considered a Store. It expects to be 
51 given a <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Model</a> that represents the type of data in the Store. It also expects to be given a 
52 <a href="Ext.data.proxy.Proxy.html" rel="Ext.data.proxy.Proxy" class="docClass">Proxy</a> that handles the loading of data into the Store.</p>
53
54
55
56
57 <p>AbstractStore provides a few helpful methods such as <a href="Ext.data.AbstractStore.html#load" rel="Ext.data.AbstractStore#load" class="docClass">load</a> and <a href="Ext.data.AbstractStore.html#sync" rel="Ext.data.AbstractStore#sync" class="docClass">sync</a>, which load and save data
58 respectively, passing the requests through the configured <a href="Ext.data.AbstractStore.html#proxy" rel="Ext.data.AbstractStore#proxy" class="docClass">proxy</a>. Both built-in Store subclasses add extra
59 behavior to each of these functions. Note also that each AbstractStore subclass has its own way of storing data - 
60 in <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Ext.data.Store</a> the data is saved as a flat <a href="Ext.util.MixedCollection.html" rel="Ext.util.MixedCollection" class="docClass">MixedCollection</a>, whereas in
61 <a href="Ext.data.TreeStore.html" rel="Ext.data.TreeStore" class="docClass">TreeStore</a> we use a <a href="Ext.data.Tree.html" rel="Ext.data.Tree" class="docClass">Ext.data.Tree</a> to maintain the data's hierarchy.</p>
62
63
64 <p>TODO: Update these docs to explain about the sortable and filterable mixins.</p>
65
66 <p>Finally, AbstractStore provides an API for sorting and filtering data via its <a href="Ext.data.AbstractStore.html#sorters" rel="Ext.data.AbstractStore#sorters" class="docClass">sorters</a> and <a href="Ext.data.AbstractStore.html#filters" rel="Ext.data.AbstractStore#filters" class="docClass">filters</a>
67 <a href="Ext.util.MixedCollection.html" rel="Ext.util.MixedCollection" class="docClass">MixedCollections</a>. Although this functionality is provided by AbstractStore, there's a
68 good description of how to use it in the introduction of <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Ext.data.Store</a>.
69
70 <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 ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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
71 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
72 is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's
73 load method. Defaults to false.</p>
74 </div></div></div><div id="config-autoSync" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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.
75 Defaults to false.</p>
76 </div><div class="long"><p>True to automatically sync the Store with its Proxy after every edit to one of its Records.
77 Defaults to false.</p>
78 </div></div></div><div id="config-fields" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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
79 set of Ext.data.Field configura...</div><div class="long"><p>This may be used in place of specifying a <a href="Ext.data.AbstractStore.html#model" rel="Ext.data.AbstractStore#model" class="docClass">model</a> configuration. The fields should be a
80 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>
81 with these fields. In general this configuration option should be avoided, it exists for the purposes of
82 backwards compatibility. For anything more complicated, such as specifying a particular id property or
83 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.AbstractStore.html#model" rel="Ext.data.AbstractStore#model" class="docClass">model</a> config.</p>
84 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.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
85 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
86 object during initialization.  This should be a valid listeners config object as specified in the
87 <a href="Ext.data.AbstractStore.html#addListener" rel="Ext.data.AbstractStore#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
88
89 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
90
91
92 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
93
94
95 <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
96 <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
97 events directly from a child element of a Component, we need to specify the <code>element</code> option to
98 identify the Component property to add a DOM listener to:</p>
99
100 <pre><code>new Ext.panel.Panel({
101     width: 400,
102     height: 200,
103     dockedItems: [{
104         xtype: 'toolbar'
105     }],
106     listeners: {
107         click: {
108             element: 'el', //bind to the underlying el property on the panel
109             fn: function(){ console.log('click el'); }
110         },
111         dblclick: {
112             element: 'body', //bind to the underlying body property on the panel
113             fn: function(){ console.log('dblclick body'); }
114         }
115     }
116 });
117 </code></pre>
118
119
120 <p></p></p>
121 </div></div></div><div id="config-proxy" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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
122 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
123 object or a Proxy instance - see <a href="Ext.data.AbstractStore.html#setProxy" rel="Ext.data.AbstractStore#setProxy" class="docClass">setProxy</a> for details.</p>
124 </div></div></div><div id="config-storeId" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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
125 the Ext.data.StoreManager, ...</div><div class="long"><p>Optional unique identifier for this store. If present, this Store will be registered with
126 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>
127 </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-batchUpdateMode" class="member f ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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
128 internal...</div><div class="long"><p>Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's
129 internal representation of the data after each operation of the batch has completed, 'complete' will wait until
130 the entire batch has been completed before updating the Store's data. 'complete' is a good choice for local
131 storage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency.</p>
132 </div></div></div><div id="property-defaultProxyType" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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>
133 </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>
134 </div></div></div><div id="property-defaultSortDirection" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.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>
135 </div><div class="long"><p>The default sort direction to use if one is not specified (defaults to "ASC")</p>
136 </div></div></div><div id="property-filterOnLoad" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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.
137 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.
138 Defaults to true, ignored if <a href="Ext.data.AbstractStore.html#remoteFilter" rel="Ext.data.AbstractStore#remoteFilter" class="docClass">remoteFilter</a> is true</p>
139 </div></div></div><div id="property-filters" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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>
140 </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>
141 </div></div></div><div id="property-isDestroyed" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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.AbstractStore.html#destroyStore" rel="Ext.data.AbstractStore#destroyStore" class="docClass">destroyStore</a>. If this is true, the reference to Store should be deleted
142 as it will not function correctly any more.</p>
143 </div></div></div><div id="property-isSortable" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.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>
144 </div><div class="long"><p>Flag denoting that this object is sortable. Always true.</p>
145 </div></div></div><div id="property-removeAll" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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",
146 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",
147 individual remove events are not called. The <a href="Ext.data.AbstractStore.html#clear" rel="Ext.data.AbstractStore#clear" class="docClass">clear</a> event is
148 fired upon completion.</p>
149 </div></div></div><div id="property-sortOnLoad" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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.
150 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.
151 Defaults to true, igored if <a href="Ext.data.AbstractStore.html#remoteSort" rel="Ext.data.AbstractStore#remoteSort" class="docClass">remoteSort</a> is true</p>
152 </div></div></div><div id="property-sortRoot" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.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>
153 </div><div class="long"><p>The property in each item that contains the data to sort. (defaults to null)</p>
154 </div></div></div><div id="property-sorters" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.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>
155 </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>
156 </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.AbstractStore.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.AbstractStore.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
157 <span class="pre">Object/String o, String </span>)
158  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
159 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
160 <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>
161 or the first event name string if multiple event names are being passed as separate parameters.</p>
162 </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.
163 Usage:</p>
164
165 <pre><code>this.addEvents('storeloaded', 'storecleared');
166 </code></pre>
167
168 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
169 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-addListener" class="cls expand">addListener</a>(
170 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
171  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
172 </div><div class="long"><p>Appends an event handler to this object.</p>
173 <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>
174 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
175 </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.
176 <b>If omitted, defaults to the object which fired the event.</b></p>
177 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
178 properties. This may contain any of the following properties:<ul>
179 <li><b>scope</b> : Object<div class="sub-desc">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></div></li>
181 <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>
182 <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>
183 <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
184 by the specified number of milliseconds. If the event fires again within that time, the original
185 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
186 <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>
187 if the event was bubbled up from a child Observable.</div></li>
188 <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>
189 The name of a Component property which references an element to add a listener to.</p>
190
191 <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
192 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
193 <pre><code>new Ext.panel.Panel({
194     title: 'The title',
195     listeners: {
196         click: this.handlePanelClick,
197         element: 'body'
198     }
199 });
200 </code></pre></p>
201
202
203 <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>
204
205
206 <p></div></li>
207 </ul><br></p>
208
209 <p>
210 <b>Combining Options</b><br>
211 Using the options argument, it is possible to combine different types of listeners:<br>
212 <br>
213 A delayed, one-time listener.
214 <pre><code>myPanel.on('hide', this.handleClick, this, {
215 single: true,
216 delay: 100
217 });</code></pre>
218 <p>
219 <b>Attaching multiple handlers in 1 call</b><br>
220 The method also allows for a single argument to be passed which is a config object containing properties
221 which specify multiple events. For example:
222 <pre><code>myGridPanel.on({
223     cellClick: this.onCellClick,
224     mouseover: this.onMouseOver,
225     mouseout: this.onMouseOut,
226     scope: this // Important. Ensure "this" is correct during handler execution
227 });
228 </code></pre>.
229 <p>
230
231 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
232 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
233 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
234  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
235 is destroyed.
236
237 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
238 is destroyed.
239
240 <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>
241 </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>
242 </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
243 is the handler function.</p>
244 </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
245 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
246 </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
247 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
248 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
249 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-capture" class="cls expand">capture</a>(
250 <span class="pre">Observable o, Function fn, [Object scope]</span>)
251  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
252 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
253 to the supplied function with the event name + standard signature of the event
254 <b>before</b> the event is fired. If the supplied function returns false,
255 the event will not fire.</p>
256 <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>
257 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
258 </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>
259 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
260 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.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>
261 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
262 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
263 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.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>
264 </div><div class="long"><p>Removes all managed listeners for this object.</p>
265 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
266 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
267 <span class="pre">String/Array events</span>)
268  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
269 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
270 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
271
272
273 <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
274 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
275 access the required target more quickly.</p>
276
277
278 <p>Example:</p>
279
280
281 <pre><code>Ext.override(Ext.form.field.Base, {
282 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
283 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
284     this.enableBubble('change');
285 }),
286
287 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
288 getBubbleTarget : function() {
289     if (!this.formPanel) {
290         this.formPanel = this.findParentByType('form');
291     }
292     return this.formPanel;
293 }
294 });
295
296 var myForm = new Ext.formPanel({
297 title: 'User Details',
298 items: [{
299     ...
300 }],
301 listeners: {
302     change: function() {
303         // Title goes red if form has been modified.
304         myForm.header.setStyle('color', 'red');
305     }
306 }
307 });
308 </code></pre>
309
310 <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>
311 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
312 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
313 <span class="pre">String eventName, Object... args</span>)
314  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
315
316
317 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>
318
319
320 <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>)
321 by calling <a href="Ext.data.AbstractStore.html#enableBubble" rel="Ext.data.AbstractStore#enableBubble" class="docClass">enableBubble</a>.</p>
322
323 <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>
324 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
325 </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>
326 </li></ul></div></div></div><div id="method-getNewRecords" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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
327 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
328 yet been saved on this Store (this happens when adding a non-phantom record from another Store into this one)</p>
329 <h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The Model instances</p>
330 </li></ul></div></div></div><div id="method-getProxy" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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>
331 </div><div class="long"><p>Returns the proxy currently attached to this proxy instance</p>
332 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.proxy.Proxy</span>&nbsp; &nbsp;<p>The Proxy instance</p>
333 </li></ul></div></div></div><div id="method-getSortState" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.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>
334 </div><div class="long"><p>Returns an object describing the current sort state of this Store.</p>
335 <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>
336 <li><b>field</b> : String<p class="sub-desc">The name of the field by which the Records are sorted.</p></li>
337 <li><b>direction</b> : String<p class="sub-desc">The sort order, 'ASC' or 'DESC' (case-sensitive).</p></li>
338 </ul>
339 See <tt><a href="Ext.data.AbstractStore.html#sortInfo" rel="Ext.data.AbstractStore#sortInfo" class="docClass">sortInfo</a></tt> for additional details.</p>
340 </li></ul></div></div></div><div id="method-getUpdatedRecords" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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>
341 </div><div class="long"><p>Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy</p>
342 <h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The updated Model instances</p>
343 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
344 <span class="pre">String eventName</span>)
345  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
346 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
347 <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>
348 </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>
349 </li></ul></div></div></div><div id="method-initSortable" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.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
350 during their own in...</div><div class="long"><p>Performs initialization of this mixin. Component classes using this mixin should call this method
351 during their own initialization.</p>
352 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
353 </li></ul></div></div></div><div id="method-isLoading" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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>
354 </div><div class="long"><p>Returns true if the Store is currently performing a load operation</p>
355 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the Store is currently loading</p>
356 </li></ul></div></div></div><div id="method-load" class="member ni"><a href="Ext.data.AbstractStore.html#method-load" rel="method-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-method-load" class="viewSource">view source</a></div><a name="load"></a><a name="method-load"></a><a href="Ext.data.AbstractStore.html#" rel="method-load" class="cls expand">load</a>(
357 <span class="pre">Object options</span>)
358  : void</div><div class="description"><div class="short"><p>Loads the Store using its configured <a href="Ext.data.AbstractStore.html#proxy" rel="Ext.data.AbstractStore#proxy" class="docClass">proxy</a>.</p>
359 </div><div class="long"><p>Loads the Store using its configured <a href="Ext.data.AbstractStore.html#proxy" rel="Ext.data.AbstractStore#proxy" class="docClass">proxy</a>.</p>
360 <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>
361 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</p>
362 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
363 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-observe" class="cls expand">observe</a>(
364 <span class="pre">Function c, Object listeners</span>)
365  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
366
367 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>
368
369 <p>This makes any event fired on any instance of the passed class also fire a single event through
370 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
371
372 <p>Usage:</p>
373
374 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
375 Ext.data.Connection.on('beforerequest', function(con, options) {
376     console.log('Ajax request made to ' + options.url);
377 });
378 </code></pre>
379 <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>
380 </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.AbstractStore.html#addListener" rel="Ext.data.AbstractStore#addListener" class="docClass">addListener</a>.</p>
381 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
382 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-on" class="cls expand">on</a>(
383 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
384  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.AbstractStore.html#addListener" rel="Ext.data.AbstractStore#addListener" class="docClass">addListener</a>.)</p>
385 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.AbstractStore.html#addListener" rel="Ext.data.AbstractStore#addListener" class="docClass">addListener</a>.)</p>
386 <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>
387 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
388 </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.
389 <b>If omitted, defaults to the object which fired the event.</b></p>
390 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
391 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
392 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
393 <span class="pre">Object origin, Array events, Object prefix</span>)
394  : 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>
395 </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>
396 <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>
397 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
398 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
399 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
400 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
401 <span class="pre">Observable o</span>)
402  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
403 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
404 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
405 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
406 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
407 <span class="pre">String eventName, Function handler, [Object scope]</span>)
408  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
409 </div><div class="long"><p>Removes an event handler.</p>
410 <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>
411 </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.AbstractStore.html#addListener" rel="Ext.data.AbstractStore#addListener" class="docClass">addListener</a> call.</b></p>
412 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
413 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
414 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
415 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
416  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.data.AbstractStore.html#mon" rel="Ext.data.AbstractStore#mon" class="docClass">mon</a> method.</p>
417 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.data.AbstractStore.html#mon" rel="Ext.data.AbstractStore#mon" class="docClass">mon</a> method.</p>
418 <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>
419 </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>
420 </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
421 is the handler function.</p>
422 </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
423 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
424 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
425 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
426 If events were suspended using the queueSuspended parameter, then all
427 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.data.AbstractStore.html#suspendEvents" rel="Ext.data.AbstractStore#suspendEvents" class="docClass">suspendEvents</a>)
428 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
429 events fired during event suspension will be sent to any listeners now.</p>
430 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
431 </li></ul></div></div></div><div id="method-setProxy" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-setProxy" class="cls expand">setProxy</a>(
432 <span class="pre">String|Object|Ext.data.proxy.Proxy proxy</span>)
433  : 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>
434 </div><div class="long"><p>Sets the Store's Proxy by string, config object or Proxy instance</p>
435 <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
436 or an <a href="Ext.data.proxy.Proxy.html" rel="Ext.data.proxy.Proxy" class="docClass">Ext.data.proxy.Proxy</a> instance</p>
437 </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>
438 </li></ul></div></div></div><div id="method-sort" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-sort" class="cls expand">sort</a>(
439 <span class="pre">String|Array sorters, String direction, Object where, Object doSort</span>)
440  : void</div><div class="description"><div class="short">Sorts the data in the Store by one or more of its properties. Example usage:
441
442
443 //sort by a single field
444 myStore.sort(...</div><div class="long"><p>Sorts the data in the Store by one or more of its properties. Example usage:</p>
445
446
447 <pre><code>//sort by a single field
448 myStore.sort('myField', 'DESC');
449
450 //sorting by multiple fields
451 myStore.sort([
452     {
453         property : 'age',
454         direction: 'ASC'
455     },
456     {
457         property : 'name',
458         direction: 'DESC'
459     }
460 ]);
461 </code></pre>
462
463
464 <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
465 sorting to its internal <a href="Ext.util.MixedCollection.html" rel="Ext.util.MixedCollection" class="docClass">Ext.util.MixedCollection</a>.</p>
466
467
468 <p>When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:</p>
469
470
471 <pre><code>store.sort('myField');
472 store.sort('myField');
473      </code></pre>
474
475
476 <p>Is equivalent to this code, because Store handles the toggling automatically:</p>
477
478
479 <pre><code>store.sort('myField', 'ASC');
480 store.sort('myField', 'DESC');
481 </code></pre>
482
483 <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>,
484 or an Array of sorter configurations.</p>
485 </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>
486 </div></li><li><span class="pre">where</span> : Object<div class="sub-desc">
487 </div></li><li><span class="pre">doSort</span> : Object<div class="sub-desc">
488 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
489 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
490 <span class="pre">Boolean queueSuspended</span>)
491  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.data.AbstractStore.html#resumeEvents" rel="Ext.data.AbstractStore#resumeEvents" class="docClass">resumeEvents</a>)</p>
492 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.data.AbstractStore.html#resumeEvents" rel="Ext.data.AbstractStore#resumeEvents" class="docClass">resumeEvents</a>)</p>
493 <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
494 after the <a href="Ext.data.AbstractStore.html#resumeEvents" rel="Ext.data.AbstractStore#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
495 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
496 </li></ul></div></div></div><div id="method-sync" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.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
497 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
498 and deleted records in the store, updating the Store's internal representation of the records
499 as each operation completes.</p>
500 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
501 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="method-un" class="cls expand">un</a>(
502 <span class="pre">String eventName, Function handler, [Object scope]</span>)
503  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.data.AbstractStore.html#removeListener" rel="Ext.data.AbstractStore#removeListener" class="docClass">removeListener</a>.)</p>
504 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.data.AbstractStore.html#removeListener" rel="Ext.data.AbstractStore#removeListener" class="docClass">removeListener</a>.)</p>
505 <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>
506 </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.AbstractStore.html#addListener" rel="Ext.data.AbstractStore#addListener" class="docClass">addListener</a> call.</b></p>
507 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
508 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
509 </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 ni"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="event-add" class="cls expand">add</a>(
510 <span class="pre">Ext.data.Store store, Array records, Number index</span>)
511 </div><div class="description"><div class="short"><p>Fired when a Model instance has been added to this Store</p>
512 </div><div class="long"><p>Fired when a Model instance has been added to this Store</p>
513 <h3 class="pa">Parameters</h3><ul><li><span class="pre">store</span> : Ext.data.Store<div class="sub-desc"><p>The store</p>
514 </div></li><li><span class="pre">records</span> : Array<div class="sub-desc"><p>The Model instances that were added</p>
515 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index at which the instances were inserted</p>
516 </div></li></ul></div></div></div><div id="event-beforeload" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="event-beforeload" class="cls expand">beforeload</a>(
517 <span class="pre">Ext.data.Store store, Ext.data.Operation operation</span>)
518 </div><div class="description"><div class="short"><p>Event description</p>
519 </div><div class="long"><p>Event description</p>
520 <h3 class="pa">Parameters</h3><ul><li><span class="pre">store</span> : Ext.data.Store<div class="sub-desc"><p>This Store</p>
521 </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>
522 </div></li></ul></div></div></div><div id="event-beforesync" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="event-beforesync" class="cls expand">beforesync</a>(
523 <span class="pre">Object options</span>)
524 </div><div class="description"><div class="short"><p>Called before a call to <a href="Ext.data.AbstractStore.html#sync" rel="Ext.data.AbstractStore#sync" class="docClass">sync</a> is executed. Return false from any listener to cancel the synv</p>
525 </div><div class="long"><p>Called before a call to <a href="Ext.data.AbstractStore.html#sync" rel="Ext.data.AbstractStore#sync" class="docClass">sync</a> is executed. Return false from any listener to cancel the synv</p>
526 <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>
527 </div></li></ul></div></div></div><div id="event-clear" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="event-clear" class="cls expand">clear</a>(
528 <span class="pre">Ext.data.Store this</span>)
529 </div><div class="description"><div class="short"><p>Fired after the <a href="Ext.data.AbstractStore.html#removeAll" rel="Ext.data.AbstractStore#removeAll" class="docClass">removeAll</a> method is called.</p>
530 </div><div class="long"><p>Fired after the <a href="Ext.data.AbstractStore.html#removeAll" rel="Ext.data.AbstractStore#removeAll" class="docClass">removeAll</a> method is called.</p>
531 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.data.Store<div class="sub-desc">
532 </div></li></ul></div></div></div><div id="event-datachanged" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="event-datachanged" class="cls expand">datachanged</a>(
533 <span class="pre">Ext.data.Store this</span>)
534 </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,
535 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,
536 or updating the data in existing records</p>
537 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.data.Store<div class="sub-desc"><p>The data store</p>
538 </div></li></ul></div></div></div><div id="event-load" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="event-load" class="cls expand">load</a>(
539 <span class="pre">Ext.data.Store this, Array records, Boolean successful</span>)
540 </div><div class="description"><div class="short"><p>Fires whenever the store reads data from a remote data source.</p>
541 </div><div class="long"><p>Fires whenever the store reads data from a remote data source.</p>
542 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.data.Store<div class="sub-desc">
543 </div></li><li><span class="pre">records</span> : Array<div class="sub-desc"><p>An array of records</p>
544 </div></li><li><span class="pre">successful</span> : Boolean<div class="sub-desc"><p>True if the operation was successful.</p>
545 </div></li></ul></div></div></div><div id="event-remove" class="member ni"><a href="Ext.data.AbstractStore.html#event-remove" rel="event-remove" 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-remove" class="viewSource">view source</a></div><a name="remove"></a><a name="event-remove"></a><a href="Ext.data.AbstractStore.html#" rel="event-remove" class="cls expand">remove</a>(
546 <span class="pre">Ext.data.Store store, Ext.data.Model record, Number index</span>)
547 </div><div class="description"><div class="short"><p>Fired when a Model instance has been removed from this Store</p>
548 </div><div class="long"><p>Fired when a Model instance has been removed from this Store</p>
549 <h3 class="pa">Parameters</h3><ul><li><span class="pre">store</span> : Ext.data.Store<div class="sub-desc"><p>The Store object</p>
550 </div></li><li><span class="pre">record</span> : Ext.data.Model<div class="sub-desc"><p>The record that was removed</p>
551 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index of the record that was removed</p>
552 </div></li></ul></div></div></div><div id="event-update" class="member ni"><a href="Ext.data.AbstractStore.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.AbstractStore.html#" rel="event-update" class="cls expand">update</a>(
553 <span class="pre">Store this, Ext.data.Model record, String operation</span>)
554 </div><div class="description"><div class="short"><p>Fires when a Record has been updated</p>
555 </div><div class="long"><p>Fires when a Record has been updated</p>
556 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Store<div class="sub-desc">
557 </div></li><li><span class="pre">record</span> : Ext.data.Model<div class="sub-desc"><p>The Model instance that was updated</p>
558 </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>
559
560 <pre><code>               Ext.data.Model.EDIT
561                Ext.data.Model.REJECT
562                Ext.data.Model.COMMIT
563 </code></pre>
564
565 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>