Upgrade to ExtJS 3.0.3 - Released 10/11/2009
[extjs.git] / docs / output / Ext.data.XmlStore.html
1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.data.XmlStore-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.data.XmlStore-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.data.XmlStore-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.data.XmlStore-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.data.XmlStore"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.data.Store.html" ext:member="" ext:cls="Ext.data.Store">Store</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif">XmlStore</pre></div><h1>Class <a href="source/XmlStore.html#cls-Ext.data.XmlStore">Ext.data.XmlStore</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">XmlStore.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/XmlStore.html#cls-Ext.data.XmlStore">XmlStore</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store" ext:member="">Store</a></td></tr><tr><td class="hd-info"></td></tr><tr><td class="label">xtype:</td><td class="hd-info">xmlstore</td></tr></table><div class="description"><p>Small helper class to make creating <a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Ext.data.Store</a>s from XML data easier.\r
2 A XmlStore will be automatically configured with a <a href="output/Ext.data.XmlReader.html" ext:cls="Ext.data.XmlReader">Ext.data.XmlReader</a>.</p>\r
3 <p>A store configuration would be something like:<pre><code><b>var</b> store = <b>new</b> Ext.data.XmlStore({\r
4     <i>// store configs\r</i>
5     autoDestroy: true,\r
6     storeId: <em>'myStore'</em>,\r
7     url: <em>'sheldon.xml'</em>, <i>// automatically configures a HttpProxy\r</i>
8     <i>// reader configs\r</i>
9     record: <em>'Item'</em>, <i>// records will have an <em>"Item"</em> tag\r</i>
10     idPath: <em>'ASIN'</em>,\r
11     totalRecords: <em>'@TotalResults'</em>\r
12     fields: [\r
13         <i>// set up the fields mapping into the xml doc\r</i>
14         <i>// The first needs mapping, the others are very basic\r</i>
15         {name: <em>'Author'</em>, mapping: <em>'ItemAttributes > Author'</em>},\r
16         <em>'Title'</em>, <em>'Manufacturer'</em>, <em>'ProductGroup'</em>\r
17     ]\r
18 });</code></pre></p>\r
19 <p>This store is configured to consume a returned object of the form:<pre><code>&#60?xml version=<em>"1.0"</em> encoding=<em>"UTF-8"</em>?>\r
20 &#60ItemSearchResponse xmlns=<em>"http:<i>//webservices.amazon.com/AWSECommerceService/2009-05-15"</em>>\r</i>
21     &#60Items>\r
22         &#60Request>\r
23             &#60IsValid>True&#60/IsValid>\r
24             &#60ItemSearchRequest>\r
25                 &#60Author>Sidney Sheldon&#60/Author>\r
26                 &#60SearchIndex>Books&#60/SearchIndex>\r
27             &#60/ItemSearchRequest>\r
28         &#60/Request>\r
29         &#60TotalResults>203&#60/TotalResults>\r
30         &#60TotalPages>21&#60/TotalPages>\r
31         &#60Item>\r
32             &#60ASIN>0446355453&#60/ASIN>\r
33             &#60DetailPageURL>\r
34                 http:<i>//www.amazon.com/\r</i>
35             &#60/DetailPageURL>\r
36             &#60ItemAttributes>\r
37                 &#60Author>Sidney Sheldon&#60/Author>\r
38                 &#60Manufacturer>Warner Books&#60/Manufacturer>\r
39                 &#60ProductGroup>Book&#60/ProductGroup>\r
40                 &#60Title>Master of the Game&#60/Title>\r
41             &#60/ItemAttributes>\r
42         &#60/Item>\r
43     &#60/Items>\r
44 &#60/ItemSearchResponse></code></pre>\r
45 An object literal of this form could also be used as the <a href="output/Ext.data.XmlStore.html#Ext.data.XmlStore-data" ext:member="data" ext:cls="Ext.data.XmlStore">data</a> config option.</p>\r
46 <p><b>Note:</b> Although not listed here, this class accepts all of the configuration options of \r
47 <b><a href="output/Ext.data.XmlReader.html" ext:cls="Ext.data.XmlReader">XmlReader</a></b>.</p></div><div class="hr"></div><a id="Ext.data.XmlStore-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-autoDestroy"></a><b><a href="source/Store.html#cfg-Ext.data.Store-autoDestroy">autoDestroy</a></b> : Boolean<div class="mdesc"><div class="short">true to destroy the store when the component the store is bound\r
48 to is destroyed (defaults to false).\r
49 Note: this shoul...</div><div class="long"><tt>true</tt> to destroy the store when the component the store is bound
50 to is destroyed (defaults to <tt>false</tt>).
51 <p><b>Note</b>: this should be set to true when using stores that are bound to only 1 component.</p></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#autoDestroy" ext:member="#autoDestroy" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-autoLoad"></a><b><a href="source/Store.html#cfg-Ext.data.Store-autoLoad">autoLoad</a></b> : Boolean/Object<div class="mdesc"><div class="short">If data is not specified, and if autoLoad\r
52 is true or an Object, this store's load method is automatically called\r
53 afte...</div><div class="long">If <tt><a href="output/Ext.data.Store.html#Ext.data.Store-data" ext:member="data" ext:cls="Ext.data.Store">data</a></tt> is not specified, and if <tt>autoLoad</tt>
54 is <tt>true</tt> or an <tt>Object</tt>, this store's <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a> method is automatically called
55 after creation. If the value of <tt>autoLoad</tt> is an <tt>Object</tt>, this <tt>Object</tt> will
56 be passed to the store's <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a> method.</div></div></td><td class="msource"><a href="output/Ext.data.Store.html#autoLoad" ext:member="#autoLoad" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-autoSave"></a><b><a href="source/Store.html#cfg-Ext.data.Store-autoSave">autoSave</a></b> : Boolean<div class="mdesc"><div class="short">Defaults to true causing the store to automatically save records to\r
57 the server when a record is modified (ie: becomes...</div><div class="long"><p>Defaults to <tt>true</tt> causing the store to automatically <a href="output/Ext.data.Store.html#Ext.data.Store-save" ext:member="save" ext:cls="Ext.data.Store">save</a> records to
58 the server when a record is modified (ie: becomes 'dirty'). Specify <tt>false</tt> to manually call <a href="output/Ext.data.Store.html#Ext.data.Store-save" ext:member="save" ext:cls="Ext.data.Store">save</a>
59 to send all modifiedRecords to the server.</p>
60 <br><p><b>Note</b>: each CRUD action will be sent as a separate request.</p></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#autoSave" ext:member="#autoSave" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-baseParams"></a><b><a href="source/Store.html#cfg-Ext.data.Store-baseParams">baseParams</a></b> : Object<div class="mdesc"><div class="short">An object containing properties which are to be sent as parameters\r
61 for every HTTP request.\r
62 Parameters are encoded as ...</div><div class="long"><p>An object containing properties which are to be sent as parameters
63 for <i>every</i> HTTP request.</p>
64 <p>Parameters are encoded as standard HTTP parameters using <a href="output/Ext.html#Ext-urlEncode" ext:member="urlEncode" ext:cls="Ext">Ext.urlEncode</a>.</p>
65 <p><b>Note</b>: <code>baseParams</code> may be superseded by any <code>params</code>
66 specified in a <code><a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a></code> request, see <code><a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a></code>
67 for more details.</p>
68 This property may be modified after creation using the <code><a href="output/Ext.data.Store.html#Ext.data.Store-setBaseParam" ext:member="setBaseParam" ext:cls="Ext.data.Store">setBaseParam</a></code>
69 method.</div></div></td><td class="msource"><a href="output/Ext.data.Store.html#baseParams" ext:member="#baseParams" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-batch"></a><b><a href="source/Store.html#cfg-Ext.data.Store-batch">batch</a></b> : Boolean<div class="mdesc"><div class="short">Defaults to true (unless restful:true). Multiple\r
70 requests for each CRUD action (CREATE, READ, UPDATE and DESTROY) wil...</div><div class="long"><p>Defaults to <tt>true</tt> (unless <code><a href="output/Ext.data.Store.html#Ext.data.Store-restful" ext:member="restful" ext:cls="Ext.data.Store">restful</a>:true</code>). Multiple
71 requests for each CRUD action (CREATE, READ, UPDATE and DESTROY) will be combined
72 and sent as one transaction. Only applies when <code><a href="output/Ext.data.Store.html#Ext.data.Store-autoSave" ext:member="autoSave" ext:cls="Ext.data.Store">autoSave</a></code> is set
73 to <tt>false</tt>.</p>
74 <br><p>If Store is RESTful, the DataProxy is also RESTful, and a unique transaction is
75 generated for each record.</p></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#batch" ext:member="#batch" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-data"></a><b><a href="source/Store.html#cfg-Ext.data.Store-data">data</a></b> : Array<div class="mdesc">An inline data object readable by the <code><a href="output/Ext.data.Store.html#Ext.data.Store-reader" ext:member="reader" ext:cls="Ext.data.Store">reader</a></code>.
76 Typically this option, or the <code><a href="output/Ext.data.Store.html#Ext.data.Store-url" ext:member="url" ext:cls="Ext.data.Store">url</a></code> option will be specified.</div></td><td class="msource"><a href="output/Ext.data.Store.html#data" ext:member="#data" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-defaultParamNames"></a><b><a href="source/Store.html#cfg-Ext.data.Store-defaultParamNames">defaultParamNames</a></b> : Object<div class="mdesc"><div class="short">Provides the default values for the paramNames property. To globally modify the parameters\r
77 for all stores, this objec...</div><div class="long">Provides the default values for the <a href="output/Ext.data.Store.html#Ext.data.Store-paramNames" ext:member="paramNames" ext:cls="Ext.data.Store">paramNames</a> property. To globally modify the parameters
78 for all stores, this object should be changed on the store prototype.</div></div></td><td class="msource"><a href="output/Ext.data.Store.html#defaultParamNames" ext:member="#defaultParamNames" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this\r
79 object during initialization.  This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
80 object during initialization.  This should be a valid listeners config object as specified in the
81 <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
82 <br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
83 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
84 is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
85 <b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
86 events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
87 has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
88 <i>// The Component is appended to the argument list of all handler functions.</i>
89 Ext.DomObserver = Ext.extend(Object, {
90     constructor: <b>function</b>(config) {
91         this.listeners = config.listeners ? config.listeners : config;
92     },
93
94     <i>// Component passes itself into plugin&#39;s init method</i>
95     init: <b>function</b>(c) {
96         <b>var</b> p, l = this.listeners;
97         <b>for</b> (p <b>in</b> l) {
98             <b>if</b> (Ext.isFunction(l[p])) {
99                 l[p] = this.createHandler(l[p], c);
100             } <b>else</b> {
101                 l[p].fn = this.createHandler(l[p].fn, c);
102             }
103         }
104
105         <i>// Add the listeners to the Element immediately following the render call</i>
106         c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
107             <b>var</b> e = c.getEl();
108             <b>if</b> (e) {
109                 e.on(l);
110             }
111         });
112     },
113
114     createHandler: <b>function</b>(fn, c) {
115         <b>return</b> <b>function</b>(e) {
116             fn.call(this, e, c);
117         };
118     }
119 });
120
121 <b>var</b> combo = <b>new</b> Ext.form.ComboBox({
122
123     <i>// Collapse combo when its element is clicked on</i>
124     plugins: [ <b>new</b> Ext.DomObserver({
125         click: <b>function</b>(evt, comp) {
126             comp.collapse();
127         }
128     })],
129     store: myStore,
130     typeAhead: true,
131     mode: <em>'local'</em>,
132     triggerAction: <em>'all'</em>
133 });</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-paramNames"></a><b><a href="source/Store.html#cfg-Ext.data.Store-paramNames">paramNames</a></b> : Object<div class="mdesc"><div class="short">An object containing properties which specify the names of the paging and\r
134 sorting parameters passed to remote servers...</div><div class="long"><p>An object containing properties which specify the names of the paging and
135 sorting parameters passed to remote servers when loading blocks of data. By default, this
136 object takes the following form:</p><pre><code>{
137     start : <em>'start'</em>,  <i>// The parameter name which specifies the start row</i>
138     limit : <em>'limit'</em>,  <i>// The parameter name which specifies number of rows to <b>return</b></i>
139     sort : <em>'sort'</em>,    <i>// The parameter name which specifies the column to sort on</i>
140     dir : <em>'dir'</em>       <i>// The parameter name which specifies the sort direction</i>
141 }</code></pre>
142 <p>The server must produce the requested data block upon receipt of these parameter names.
143 If different parameter names are required, this property can be overriden using a configuration
144 property.</p>
145 <p>A <a href="output/Ext.PagingToolbar.html" ext:cls="Ext.PagingToolbar">PagingToolbar</a> bound to this Store uses this property to determine
146 the parameter names to use in its <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">requests</a>.</div></div></td><td class="msource"><a href="output/Ext.data.Store.html#paramNames" ext:member="#paramNames" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-proxy"></a><b><a href="source/Store.html#cfg-Ext.data.Store-proxy">proxy</a></b> : Ext.data.DataProxy<div class="mdesc">The <a href="output/Ext.data.DataProxy.html" ext:cls="Ext.data.DataProxy">DataProxy</a> object which provides
147 access to a data object.  See <code><a href="output/Ext.data.Store.html#Ext.data.Store-url" ext:member="url" ext:cls="Ext.data.Store">url</a></code>.</div></td><td class="msource"><a href="output/Ext.data.Store.html#proxy" ext:member="#proxy" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-pruneModifiedRecords"></a><b><a href="source/Store.html#cfg-Ext.data.Store-pruneModifiedRecords">pruneModifiedRecords</a></b> : Boolean<div class="mdesc"><div class="short">true to clear all modified record information each time\r
148 the store is loaded or when a record is removed (defaults to ...</div><div class="long"><tt>true</tt> to clear all modified record information each time
149 the store is loaded or when a record is removed (defaults to <tt>false</tt>). See <a href="output/Ext.data.Store.html#Ext.data.Store-getModifiedRecords" ext:member="getModifiedRecords" ext:cls="Ext.data.Store">getModifiedRecords</a>
150 for the accessor method to retrieve the modified records.</div></div></td><td class="msource"><a href="output/Ext.data.Store.html#pruneModifiedRecords" ext:member="#pruneModifiedRecords" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-remoteSort"></a><b><a href="source/Store.html#cfg-Ext.data.Store-remoteSort">remoteSort</a></b> : boolean<div class="mdesc"><div class="short">true if sorting is to be handled by requesting the Proxy\r
151 to provide a refreshed version of the data object in sorted ...</div><div class="long"><tt>true</tt> if sorting is to be handled by requesting the <tt><a href="output/Ext.data.Store.html#Ext.data.Store-proxy" ext:member="proxy" ext:cls="Ext.data.Store">Proxy</a></tt>
152 to provide a refreshed version of the data object in sorted order, as opposed to sorting the Record cache
153 in place (defaults to <tt>false</tt>).
154 <p>If <tt>remoteSort</tt> is <tt>true</tt>, then clicking on a <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Grid Column</a>'s
155 <a href="output/Ext.grid.Column.html#Ext.grid.Column-header" ext:member="header" ext:cls="Ext.grid.Column">header</a> causes the current page to be requested from the server appending
156 the following two parameters to the <b><tt><a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">params</a></tt></b>:<div class="mdetail-params"><ul>
157 <li><b><tt>sort</tt></b> : String<p class="sub-desc">The <tt>name</tt> (as specified in the Record's
158 <a href="output/Ext.data.Field.html" ext:cls="Ext.data.Field">Field definition</a>) of the field to sort on.</p></li>
159 <li><b><tt>dir</tt></b> : String<p class="sub-desc">The direction of the sort, 'ASC' or 'DESC' (case-sensitive).</p></li>
160 </ul></div></p></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#remoteSort" ext:member="#remoteSort" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-restful"></a><b><a href="source/Store.html#cfg-Ext.data.Store-restful">restful</a></b> : Boolean<div class="mdesc"><div class="short">Defaults to false.  Set to true to have the Store and the set\r
161 Proxy operate in a RESTful manner. The store will autom...</div><div class="long">Defaults to <tt>false</tt>.  Set to <tt>true</tt> to have the Store and the set
162 Proxy operate in a RESTful manner. The store will automatically generate GET, POST,
163 PUT and DELETE requests to the server. The HTTP method used for any given CRUD
164 action is described in <a href="output/Ext.data.Api.html#Ext.data.Api-restActions" ext:member="restActions" ext:cls="Ext.data.Api">Ext.data.Api.restActions</a>.  For additional information
165 see <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-restful" ext:member="restful" ext:cls="Ext.data.DataProxy">Ext.data.DataProxy.restful</a>.
166 <p><b>Note</b>: if <code><a href="output/Ext.data.Store.html#Ext.data.Store-restful" ext:member="restful" ext:cls="Ext.data.Store">restful</a>:true</code> <code>batch</code> will
167 internally be set to <tt>false</tt>.</p></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#restful" ext:member="#restful" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-sortInfo"></a><b><a href="source/Store.html#cfg-Ext.data.Store-sortInfo">sortInfo</a></b> : Object<div class="mdesc"><div class="short">A config object to specify the sort order in the request of a Store's\r
168 load operation.  Note that for local sorting, t...</div><div class="long">A config object to specify the sort order in the request of a Store's
169 <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a> operation.  Note that for local sorting, the <tt>direction</tt> property is
170 case-sensitive. See also <a href="output/Ext.data.Store.html#Ext.data.Store-remoteSort" ext:member="remoteSort" ext:cls="Ext.data.Store">remoteSort</a> and <a href="output/Ext.data.Store.html#Ext.data.Store-paramNames" ext:member="paramNames" ext:cls="Ext.data.Store">paramNames</a>.
171 For example:<pre><code>sortInfo: {
172     field: <em>'fieldName'</em>,
173     direction: <em>'ASC'</em> <i>// or <em>'DESC'</em> (<b>case</b> sensitive <b>for</b> local sorting)</i>
174 }</code></pre></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#sortInfo" ext:member="#sortInfo" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-storeId"></a><b><a href="source/Store.html#cfg-Ext.data.Store-storeId">storeId</a></b> : String<div class="mdesc"><div class="short">If passed, the id to use to register with the StoreMgr.\r
175 Note: if a (deprecated) id is specified it will supersede the...</div><div class="long">If passed, the id to use to register with the <b><a href="output/Ext.StoreMgr.html" ext:cls="Ext.StoreMgr">StoreMgr</a></b>.
176 <p><b>Note</b>: if a (deprecated) <tt><a href="output/Ext.data.Store.html#Ext.data.Store-id" ext:member="id" ext:cls="Ext.data.Store">id</a></tt> is specified it will supersede the <tt>storeId</tt>
177 assignment.</p></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#storeId" ext:member="#storeId" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-url"></a><b><a href="source/Store.html#cfg-Ext.data.Store-url">url</a></b> : String<div class="mdesc"><div class="short">If a proxy is not specified the url will be used to\r
178 implicitly configure a HttpProxy if an url is specified.\r
179 Typicall...</div><div class="long">If a <tt><a href="output/Ext.data.Store.html#Ext.data.Store-proxy" ext:member="proxy" ext:cls="Ext.data.Store">proxy</a></tt> is not specified the <tt>url</tt> will be used to
180 implicitly configure a <a href="output/Ext.data.HttpProxy.html" ext:cls="Ext.data.HttpProxy">HttpProxy</a> if an <tt>url</tt> is specified.
181 Typically this option, or the <code><a href="output/Ext.data.Store.html#Ext.data.Store-data" ext:member="data" ext:cls="Ext.data.Store">data</a></code> option will be specified.</div></div></td><td class="msource"><a href="output/Ext.data.Store.html#url" ext:member="#url" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-writer"></a><b><a href="source/Store.html#cfg-Ext.data.Store-writer">writer</a></b> : Ext.data.DataWriter<div class="mdesc"><div class="short">The Writer object which processes a record object for being written\r
182 to the server-side database.\r
183 When a writer is ins...</div><div class="long"><p>The <a href="output/Ext.data.DataWriter.html" ext:cls="Ext.data.DataWriter">Writer</a> object which processes a record object for being written
184 to the server-side database.</p>
185 <br><p>When a writer is installed into a Store the <a href="output/Ext.data.Store.html#Ext.data.Store-add" ext:member="add" ext:cls="Ext.data.Store">add</a>, <a href="output/Ext.data.Store.html#Ext.data.Store-remove" ext:member="remove" ext:cls="Ext.data.Store">remove</a>, and <a href="output/Ext.data.Store.html#Ext.data.Store-update" ext:member="update" ext:cls="Ext.data.Store">update</a>
186 events on the store are monitored in order to remotely <a href="output/Ext.data.Store.html#Ext.data.Store-createRecords" ext:member="createRecords" ext:cls="Ext.data.Store">create records</a>,
187 <a href="output/Ext.data.Store.html#Ext.data.Store-destroyRecord" ext:member="destroyRecord" ext:cls="Ext.data.Store">destroy records</a>, or <a href="output/Ext.data.Store.html#Ext.data.Store-updateRecord" ext:member="updateRecord" ext:cls="Ext.data.Store">update records</a>.</p>
188 <br><p>The proxy for this store will relay any <a href="output/Ext.data.Store.html#Ext.data.Store-writexception" ext:member="writexception" ext:cls="Ext.data.Store">writexception</a> events to this store.</p>
189 <br><p>Sample implementation:
190 <pre><code><b>var</b> writer = <b>new</b> <a href="output/Ext.data.JsonWriter.html" ext:cls="Ext.data.JsonWriter">Ext.data.JsonWriter</a>({
191     encode: true,
192     writeAllFields: true <i>// write all fields, not just those that changed</i>
193 });
194
195 <i>// Typical Store collecting the Proxy, Reader and Writer together.</i>
196 <b>var</b> store = <b>new</b> Ext.data.Store({
197     storeId: <em>'user'</em>,
198     root: <em>'records'</em>,
199     proxy: proxy,
200     reader: reader,
201     writer: writer,     <i>// <-- plug a DataWriter into the store just as you would a Reader</i>
202     paramsAsHash: true,
203     autoSave: false    <i>// <-- false to delay executing create, update, destroy requests</i>
204                         <i>//     until specifically told to <b>do</b> so.</i>
205 });</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#writer" ext:member="#writer" ext:cls="Ext.data.Store">Store</a></td></tr></tbody></table><a id="Ext.data.XmlStore-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-baseParams"></a><b><a href="source/Store.html#prop-Ext.data.Store-baseParams">baseParams</a></b> : Object<div class="mdesc"><div class="short">See the corresponding configuration option\r
206 for a description of this property.\r
207 To modify this property see setBasePar...</div><div class="long">See the <code><a href="output/Ext.data.Store.html#Ext.data.Store-baseParams" ext:member="baseParams" ext:cls="Ext.data.Store">corresponding configuration option</a></code>
208 for a description of this property.
209 To modify this property see <code><a href="output/Ext.data.Store.html#Ext.data.Store-setBaseParam" ext:member="setBaseParam" ext:cls="Ext.data.Store">setBaseParam</a></code>.</div></div></td><td class="msource"><a href="output/Ext.data.Store.html#baseParams" ext:member="#baseParams" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-fields"></a><b><a href="source/Store.html#prop-Ext.data.Store-fields">fields</a></b> : Ext.util.MixedCollection<div class="mdesc">A <a href="output/Ext.util.MixedCollection.html" ext:cls="Ext.util.MixedCollection">MixedCollection</a> containing the defined <a href="output/Ext.data.Field.html" ext:cls="Ext.data.Field">Field</a>s
210 for the <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Records</a> stored in this Store. Read-only.</div></td><td class="msource"><a href="output/Ext.data.Store.html#fields" ext:member="#fields" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-lastOptions"></a><b><a href="source/Store.html#prop-Ext.data.Store-lastOptions">lastOptions</a></b> : Object<div class="mdesc"><div class="short">Contains the last options object used as the parameter to the load method. See load\r
211 for the details of what this may ...</div><div class="long">Contains the last options object used as the parameter to the <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a> method. See <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a>
212 for the details of what this may contain. This may be useful for accessing any params which were used
213 to load the current Record cache.</div></div></td><td class="msource"><a href="output/Ext.data.Store.html#lastOptions" ext:member="#lastOptions" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-recordType"></a><b><a href="source/Store.html#prop-Ext.data.Store-recordType">recordType</a></b> : Function<div class="mdesc"><div class="short">The Record constructor as supplied to (or created by) the\r
214 Reader. Read-only.\r
215 If the Reader was constructed by passing...</div><div class="long">The <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Record</a> constructor as supplied to (or created by) the
216 <a href="output/Ext.data.DataReader.html" ext:cls="Ext.data.DataReader">Reader</a>. Read-only.
217 <p>If the Reader was constructed by passing in an Array of <a href="output/Ext.data.Field.html" ext:cls="Ext.data.Field">Ext.data.Field</a> definition objects,
218 instead of a Record constructor, it will implicitly create a Record constructor from that Array (see
219 <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Ext.data.Record</a>.<a href="output/Ext.data.Record.html#Ext.data.Record-create" ext:member="create" ext:cls="Ext.data.Record">create</a> for additional details).</p>
220 <p>This property may be used to create new Records of the type held in this Store, for example:</p><pre><code><i>// create the data store</i>
221 <b>var</b> store = <b>new</b> Ext.data.ArrayStore({
222     autoDestroy: true,
223     fields: [
224        {name: <em>'company'</em>},
225        {name: <em>'price'</em>, type: <em>'float'</em>},
226        {name: <em>'change'</em>, type: <em>'float'</em>},
227        {name: <em>'pctChange'</em>, type: <em>'float'</em>},
228        {name: <em>'lastChange'</em>, type: <em>'date'</em>, dateFormat: <em>'n/j h:ia'</em>}
229     ]
230 });
231 store.loadData(myData);
232
233 <i>// create the Grid</i>
234 <b>var</b> grid = <b>new</b> Ext.grid.EditorGridPanel({
235     store: store,
236     colModel: <b>new</b> Ext.grid.ColumnModel({
237         columns: [
238             {id:<em>'company'</em>, header: <em>'Company'</em>, width: 160, dataIndex: <em>'company'</em>},
239             {header: <em>'Price'</em>, renderer: <em>'usMoney'</em>, dataIndex: <em>'price'</em>},
240             {header: <em>'Change'</em>, renderer: change, dataIndex: <em>'change'</em>},
241             {header: <em>'% Change'</em>, renderer: pctChange, dataIndex: <em>'pctChange'</em>},
242             {header: <em>'Last Updated'</em>, width: 85,
243                 renderer: Ext.util.Format.dateRenderer(<em>'m/d/Y'</em>),
244                 dataIndex: <em>'lastChange'</em>}
245         ],
246         defaults: {
247             sortable: true,
248             width: 75
249         }
250     }),
251     autoExpandColumn: <em>'company'</em>, <i>// match the id specified <b>in</b> the column model</i>
252     height:350,
253     width:600,
254     title:<em>'Array Grid'</em>,
255     tbar: [{
256         text: <em>'Add Record'</em>,
257         handler : <b>function</b>(){
258             <b>var</b> defaultData = {
259                 change: 0,
260                 company: <em>'New Company'</em>,
261                 lastChange: (<b>new</b> Date()).clearTime(),
262                 pctChange: 0,
263                 price: 10
264             };
265             <b>var</b> recId = 3; <i>// provide unique id</i>
266             <b>var</b> p = <b>new</b> store.recordType(defaultData, recId); <i>// create <b>new</b> record</i>
267             grid.stopEditing();
268             store.<a href="output/Ext.data.Store.html#Ext.data.Store-insert" ext:member="insert" ext:cls="Ext.data.Store">insert</a>(0, p); <i>// insert a <b>new</b> record into the store (also see <a href="output/Ext.data.Store.html#Ext.data.Store-add" ext:member="add" ext:cls="Ext.data.Store">add</a>)</i>
269             grid.startEditing(0, 0);
270         }
271     }]
272 });</code></pre></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#recordType" ext:member="#recordType" ext:cls="Ext.data.Store">Store</a></td></tr></tbody></table><a id="Ext.data.XmlStore-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.XmlStore-XmlStore"></a><b><a href="source/XmlStore.html#cls-Ext.data.XmlStore">XmlStore</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)\r
273     <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div><table><tr><td class="label">xtype:</td><td class="hd-info">xmlstore</td></tr></table></div></div></td><td class="msource">XmlStore</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-add"></a><b><a href="source/Store.html#method-Ext.data.Store-add">add</a></b>(&nbsp;<code>Ext.data.Record[]&nbsp;records</code>&nbsp;)\r
274     :\r
275                                         void<div class="mdesc"><div class="short">Add Records to the Store and fires the add event.  To add Records\r
276 to the store from a remote source use load({add:tru...</div><div class="long">Add Records to the Store and fires the <a href="output/Ext.data.Store.html#Ext.data.Store-add" ext:member="add" ext:cls="Ext.data.Store">add</a> event.  To add Records
277 to the store from a remote source use <code><a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a>({add:true})</code>.
278 See also <code><a href="output/Ext.data.Store.html#Ext.data.Store-recordType" ext:member="recordType" ext:cls="Ext.data.Store">recordType</a></code> and <code><a href="output/Ext.data.Store.html#Ext.data.Store-insert" ext:member="insert" ext:cls="Ext.data.Store">insert</a></code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>records</code> : Ext.data.Record[]<div class="sub-desc">An Array of Ext.data.Record objects
279 to add to the cache. See <a href="output/Ext.data.Store.html#Ext.data.Store-recordType" ext:member="recordType" ext:cls="Ext.data.Store">recordType</a>.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#add" ext:member="#add" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>(&nbsp;<code>Object|String&nbsp;o</code>,&nbsp;<code>string&nbsp;Optional.</code>&nbsp;)\r
280     :\r
281                                         void<div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code>
282 or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters.
283 Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
284     :\r
285                                         void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
286 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
287 properties. This may contain any of the following properties:<ul>
288 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
289 <b>If omitted, defaults to the object which fired the event.</b></div></li>
290 <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>
291 <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>
292 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
293 by the specified number of milliseconds. If the event fires again within that time, the original
294 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
295 <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>
296 if the event was bubbled up from a child Observable.</div></li>
297 </ul><br>
298 <p>
299 <b>Combining Options</b><br>
300 Using the options argument, it is possible to combine different types of listeners:<br>
301 <br>
302 A delayed, one-time listener.
303 <pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
304 single: true,
305 delay: 100
306 });</code></pre>
307 <p>
308 <b>Attaching multiple handlers in 1 call</b><br>
309 The method also allows for a single argument to be passed which is a config object containing properties
310 which specify multiple handlers.
311 <p>
312 <pre><code>myGridPanel.on({
313 <em>'click'</em> : {
314     fn: this.onClick,
315     scope: this,
316     delay: 100
317 },
318 <em>'mouseover'</em> : {
319     fn: this.onMouseOver,
320     scope: this
321 },
322 <em>'mouseout'</em> : {
323     fn: this.onMouseOut,
324     scope: this
325 }
326 });</code></pre>
327 <p>
328 Or a shorthand syntax:<br>
329 <pre><code>myGridPanel.on({
330 <em>'click'</em> : this.onClick,
331 <em>'mouseover'</em> : this.onMouseOver,
332 <em>'mouseout'</em> : this.onMouseOut,
333  scope: this
334 });</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-addSorted"></a><b><a href="source/Store.html#method-Ext.data.Store-addSorted">addSorted</a></b>(&nbsp;<code>Ext.data.Record&nbsp;record</code>&nbsp;)\r
335     :\r
336                                         void<div class="mdesc"><div class="short">(Local sort only) Inserts the passed Record into the Store at the index where it\r
337 should go based on the current sort ...</div><div class="long">(Local sort only) Inserts the passed Record into the Store at the index where it
338 should go based on the current sort information.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>record</code> : Ext.data.Record<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#addSorted" ext:member="#addSorted" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-clearFilter"></a><b><a href="source/Store.html#method-Ext.data.Store-clearFilter">clearFilter</a></b>(&nbsp;<code>Boolean&nbsp;suppressEvent</code>&nbsp;)\r
339     :\r
340                                         void<div class="mdesc"><div class="short">Revert to a view of the Record cache with no filtering applied.</div><div class="long">Revert to a view of the Record cache with no filtering applied.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>suppressEvent</code> : Boolean<div class="sub-desc">If <tt>true</tt> the filter is cleared silently without firing the
341 <a href="output/Ext.data.Store.html#Ext.data.Store-datachanged" ext:member="datachanged" ext:cls="Ext.data.Store">datachanged</a> event.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#clearFilter" ext:member="#clearFilter" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-collect"></a><b><a href="source/Store.html#method-Ext.data.Store-collect">collect</a></b>(&nbsp;<code>String&nbsp;dataIndex</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;allowNull</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;bypassFilter</code>]</span>&nbsp;)\r
342     :\r
343                                         Array<div class="mdesc"><div class="short">Collects unique values for a particular dataIndex from this store.</div><div class="long">Collects unique values for a particular dataIndex from this store.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>dataIndex</code> : String<div class="sub-desc">The property to collect</div></li><li><code>allowNull</code> : Boolean<div class="sub-desc">(optional) Pass true to allow null, undefined or empty string values</div></li><li><code>bypassFilter</code> : Boolean<div class="sub-desc">(optional) Pass true to collect from all records, even ones which are filtered</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">An array of the unique values</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#collect" ext:member="#collect" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-commitChanges"></a><b><a href="source/Store.html#method-Ext.data.Store-commitChanges">commitChanges</a></b>()\r
344     :\r
345                                         void<div class="mdesc"><div class="short">Commit all Records with outstanding changes. To handle updates for changes,\r
346 subscribe to the Store's update event, an...</div><div class="long">Commit all Records with <a href="output/Ext.data.Store.html#Ext.data.Store-getModifiedRecords" ext:member="getModifiedRecords" ext:cls="Ext.data.Store">outstanding changes</a>. To handle updates for changes,
347 subscribe to the Store's <a href="output/Ext.data.Store.html#Ext.data.Store-update" ext:member="update" ext:cls="Ext.data.Store">update event</a>, and perform updating when the third parameter is
348 Ext.data.Record.COMMIT.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#commitChanges" ext:member="#commitChanges" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-destroy"></a><b><a href="source/Store.html#method-Ext.data.Store-destroy">destroy</a></b>()\r
349     :\r
350                                         void<div class="mdesc"><div class="short">Destroys the store.</div><div class="long">Destroys the store.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#destroy" ext:member="#destroy" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-each"></a><b><a href="source/Store.html#method-Ext.data.Store-each">each</a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
351     :\r
352                                         void<div class="mdesc"><div class="short">Calls the specified function for each of the Records in the cache.</div><div class="long">Calls the specified function for each of the <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Records</a> in the cache.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The function to call. The <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Record</a> is passed as the first parameter.
353 Returning <tt>false</tt> aborts and exits the iteration.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to call the function (defaults to the <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Record</a>).</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#each" ext:member="#each" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>(&nbsp;<code>Object&nbsp;events</code>&nbsp;)\r
354     :\r
355                                         void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling&#13;\r
356 this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
357 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\r
358 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default\r
359 implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\r
360 access the required target more quickly.</p>\r
361 <p>Example:</p><pre><code>Ext.override(Ext.form.Field, {\r
362 <i>//  Add functionality to Field<em>'s initComponent to enable the change event to bubble\r</i>
363     initComponent: Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
364         this.enableBubble('</em>change<em>');\r
365     }),\r
366 \r
367 <i>//  We know that we want Field'</em>s events to bubble directly to the FormPanel.\r</i>
368     getBubbleTarget: <b>function</b>() {\r
369         <b>if</b> (!this.formPanel) {\r
370             this.formPanel = this.findParentByType(<em>'form'</em>);\r
371         }\r
372         <b>return</b> this.formPanel;\r
373     }\r
374 });\r
375 \r
376 <b>var</b> myForm = <b>new</b> Ext.formPanel({\r
377     title: <em>'User Details'</em>,\r
378     items: [{\r
379         ...\r
380     }],\r
381     listeners: {\r
382         change: <b>function</b>() {\r
383 <i>//          Title goes red <b>if</b> form has been modified.\r</i>
384             myForm.header.setStyle(<em>"color"</em>, <em>"red"</em>);\r
385         }\r
386     }\r
387 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : Object<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-filter"></a><b><a href="source/Store.html#method-Ext.data.Store-filter">filter</a></b>(&nbsp;<code>String&nbsp;field</code>,&nbsp;<code>String/RegExp&nbsp;value</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;anyMatch</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;caseSensitive</code>]</span>&nbsp;)\r
388     :\r
389                                         void<div class="mdesc"><div class="short">Filter the records by a specified property.</div><div class="long">Filter the <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">records</a> by a specified property.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>field</code> : String<div class="sub-desc">A field on your records</div></li><li><code>value</code> : String/RegExp<div class="sub-desc">Either a string that the field should begin with, or a RegExp to test
390 against the field.</div></li><li><code>anyMatch</code> : Boolean<div class="sub-desc">(optional) <tt>true</tt> to match any part not just the beginning</div></li><li><code>caseSensitive</code> : Boolean<div class="sub-desc">(optional) <tt>true</tt> for case sensitive comparison</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#filter" ext:member="#filter" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-filterBy"></a><b><a href="source/Store.html#method-Ext.data.Store-filterBy">filterBy</a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
391     :\r
392                                         void<div class="mdesc"><div class="short">Filter by a function. The specified function will be called for each\r
393 Record in this Store. If the function returns tr...</div><div class="long">Filter by a function. The specified function will be called for each
394 Record in this Store. If the function returns <tt>true</tt> the Record is included,
395 otherwise it is filtered out.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called. It will be passed the following parameters:<ul>
396 <li><b>record</b> : Ext.data.Record<p class="sub-desc">The <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">record</a>
397 to test for filtering. Access field values using <a href="output/Ext.data.Record.html#Ext.data.Record-get" ext:member="get" ext:cls="Ext.data.Record">Ext.data.Record.get</a>.</p></li>
398 <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
399 </ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to this)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#filterBy" ext:member="#filterBy" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-find"></a><b><a href="source/Store.html#method-Ext.data.Store-find">find</a></b>(&nbsp;<code>String&nbsp;property</code>,&nbsp;<code>String/RegExp&nbsp;value</code>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;startIndex</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;anyMatch</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;caseSensitive</code>]</span>&nbsp;)\r
400     :\r
401                                         Number<div class="mdesc"><div class="short">Finds the index of the first matching record in this store by a specific property/value.</div><div class="long">Finds the index of the first matching record in this store by a specific property/value.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>property</code> : String<div class="sub-desc">A property on your objects</div></li><li><code>value</code> : String/RegExp<div class="sub-desc">Either a string that the property value
402 should begin with, or a RegExp to test against the property.</div></li><li><code>startIndex</code> : Number<div class="sub-desc">(optional) The index to start searching at</div></li><li><code>anyMatch</code> : Boolean<div class="sub-desc">(optional) True to match any part of the string, not just the beginning</div></li><li><code>caseSensitive</code> : Boolean<div class="sub-desc">(optional) True for case sensitive comparison</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The matched index or -1</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#find" ext:member="#find" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-findBy"></a><b><a href="source/Store.html#method-Ext.data.Store-findBy">findBy</a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;startIndex</code>]</span>&nbsp;)\r
403     :\r
404                                         Number<div class="mdesc"><div class="short">Find the index of the first matching Record in this Store by a function.\r
405 If the function returns true it is considere...</div><div class="long">Find the index of the first matching Record in this Store by a function.
406 If the function returns <tt>true</tt> it is considered a match.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called. It will be passed the following parameters:<ul>
407 <li><b>record</b> : Ext.data.Record<p class="sub-desc">The <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">record</a>
408 to test for filtering. Access field values using <a href="output/Ext.data.Record.html#Ext.data.Record-get" ext:member="get" ext:cls="Ext.data.Record">Ext.data.Record.get</a>.</p></li>
409 <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
410 </ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to this)</div></li><li><code>startIndex</code> : Number<div class="sub-desc">(optional) The index to start searching at</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The matched index or -1</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#findBy" ext:member="#findBy" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-findExact"></a><b><a href="source/Store.html#method-Ext.data.Store-findExact">findExact</a></b>(&nbsp;<code>String&nbsp;property</code>,&nbsp;<code>String/RegExp&nbsp;value</code>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;startIndex</code>]</span>&nbsp;)\r
411     :\r
412                                         Number<div class="mdesc"><div class="short">Finds the index of the first matching record in this store by a specific property/value.</div><div class="long">Finds the index of the first matching record in this store by a specific property/value.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>property</code> : String<div class="sub-desc">A property on your objects</div></li><li><code>value</code> : String/RegExp<div class="sub-desc">The value to match against</div></li><li><code>startIndex</code> : Number<div class="sub-desc">(optional) The index to start searching at</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The matched index or -1</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#findExact" ext:member="#findExact" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Object...&nbsp;args</code>&nbsp;)\r
413     :\r
414                                         Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).\r
415 An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
416 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
417 by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-getAt"></a><b><a href="source/Store.html#method-Ext.data.Store-getAt">getAt</a></b>(&nbsp;<code>Number&nbsp;index</code>&nbsp;)\r
418     :\r
419                                         Ext.data.Record<div class="mdesc"><div class="short">Get the Record at the specified index.</div><div class="long">Get the Record at the specified index.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>index</code> : Number<div class="sub-desc">The index of the Record to find.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.data.Record</code><div class="sub-desc">The Record at the passed index. Returns undefined if not found.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#getAt" ext:member="#getAt" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-getById"></a><b><a href="source/Store.html#method-Ext.data.Store-getById">getById</a></b>(&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
420     :\r
421                                         Ext.data.Record<div class="mdesc"><div class="short">Get the Record with the specified id.</div><div class="long">Get the Record with the specified id.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc">The id of the Record to find.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.data.Record</code><div class="sub-desc">The Record with the passed id. Returns undefined if not found.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#getById" ext:member="#getById" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-getCount"></a><b><a href="source/Store.html#method-Ext.data.Store-getCount">getCount</a></b>()\r
422     :\r
423                                         Number<div class="mdesc"><div class="short">Gets the number of cached records.\r
424 If using paging, this may not be the total size of the dataset. If the data object...</div><div class="long">Gets the number of cached records.
425 <p>If using paging, this may not be the total size of the dataset. If the data object
426 used by the Reader contains the dataset size, then the <a href="output/Ext.data.Store.html#Ext.data.Store-getTotalCount" ext:member="getTotalCount" ext:cls="Ext.data.Store">getTotalCount</a> function returns
427 the dataset size.  <b>Note</b>: see the Important note in <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The number of Records in the Store's cache.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#getCount" ext:member="#getCount" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-getModifiedRecords"></a><b><a href="source/Store.html#method-Ext.data.Store-getModifiedRecords">getModifiedRecords</a></b>()\r
428     :\r
429                                         Ext.data.Record[]<div class="mdesc"><div class="short">Gets all records modified since the last commit.  Modified records are\r
430 persisted across load operations (e.g., during...</div><div class="long">Gets all <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">records</a> modified since the last commit.  Modified records are
431 persisted across load operations (e.g., during paging). <b>Note</b>: deleted records are not
432 included.  See also <tt><a href="output/Ext.data.Store.html#Ext.data.Store-pruneModifiedRecords" ext:member="pruneModifiedRecords" ext:cls="Ext.data.Store">pruneModifiedRecords</a></tt> and
433 <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Ext.data.Record</a><tt><a href="output/Ext.data.Record.html#Ext.data.Record-markDirty" ext:member="markDirty" ext:cls="Ext.data.Record">markDirty</a>.</tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.data.Record[]</code><div class="sub-desc">An array of {@link Ext.data.Record Records} containing outstanding\r
434 modifications.  To obtain modified fields within a modified record see\r
435 {@link Ext.data.Record}&lt;tt&gt;{@link Ext.data.Record#modified modified}.&lt;/tt&gt;.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#getModifiedRecords" ext:member="#getModifiedRecords" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-getRange"></a><b><a href="source/Store.html#method-Ext.data.Store-getRange">getRange</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;startIndex</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;endIndex</code>]</span>&nbsp;)\r
436     :\r
437                                         Ext.data.Record[]<div class="mdesc"><div class="short">Returns a range of Records between specified indices.</div><div class="long">Returns a range of Records between specified indices.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>startIndex</code> : Number<div class="sub-desc">(optional) The starting index (defaults to 0)</div></li><li><code>endIndex</code> : Number<div class="sub-desc">(optional) The ending index (defaults to the last Record in the Store)</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.data.Record[]</code><div class="sub-desc">An array of Records</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#getRange" ext:member="#getRange" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-getSortState"></a><b><a href="source/Store.html#method-Ext.data.Store-getSortState">getSortState</a></b>()\r
438     :\r
439                                         Object<div class="mdesc"><div class="short">Returns an object describing the current sort state of this Store.</div><div class="long">Returns an object describing the current sort state of this Store.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">The sort state of the Store. An object with two properties:&lt;ul&gt;\r
440 &lt;li&gt;&lt;b&gt;field : String&lt;p class="sub-desc"&gt;The name of the field by which the Records are sorted.&lt;/p&gt;&lt;/li&gt;\r
441 &lt;li&gt;&lt;b&gt;direction : String&lt;p class="sub-desc"&gt;The sort order, 'ASC' or 'DESC' (case-sensitive).&lt;/p&gt;&lt;/li&gt;\r
442 &lt;/ul&gt;\r
443 See &lt;tt&gt;{@link #sortInfo}&lt;/tt&gt; for additional details.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#getSortState" ext:member="#getSortState" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-getTotalCount"></a><b><a href="source/Store.html#method-Ext.data.Store-getTotalCount">getTotalCount</a></b>()\r
444     :\r
445                                         Number<div class="mdesc"><div class="short">Gets the total number of records in the dataset as returned by the server.\r
446 If using paging, for this to be accurate, ...</div><div class="long">Gets the total number of records in the dataset as returned by the server.
447 <p>If using paging, for this to be accurate, the data object used by the <a href="output/Ext.data.Store.html#Ext.data.Store-reader" ext:member="reader" ext:cls="Ext.data.Store">Reader</a>
448 must contain the dataset size. For remote data sources, the value for this property
449 (<tt>totalProperty</tt> for <a href="output/Ext.data.JsonReader.html" ext:cls="Ext.data.JsonReader">JsonReader</a>,
450 <tt>totalRecords</tt> for <a href="output/Ext.data.XmlReader.html" ext:cls="Ext.data.XmlReader">XmlReader</a>) shall be returned by a query on the server.
451 <b>Note</b>: see the Important note in <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The number of Records as specified in the data object passed to the Reader\r
452 by the Proxy.\r
453 &lt;p&gt;&lt;b&gt;Note&lt;/b&gt;: this value is not updated when changing the contents of the Store locally.&lt;/p&gt;</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#getTotalCount" ext:member="#getTotalCount" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>&nbsp;)\r
454     :\r
455                                         Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-indexOf"></a><b><a href="source/Store.html#method-Ext.data.Store-indexOf">indexOf</a></b>(&nbsp;<code>Ext.data.Record&nbsp;record</code>&nbsp;)\r
456     :\r
457                                         Number<div class="mdesc"><div class="short">Get the index within the cache of the passed Record.</div><div class="long">Get the index within the cache of the passed Record.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>record</code> : Ext.data.Record<div class="sub-desc">The Ext.data.Record object to find.</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The index of the passed Record. Returns -1 if not found.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#indexOf" ext:member="#indexOf" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-indexOfId"></a><b><a href="source/Store.html#method-Ext.data.Store-indexOfId">indexOfId</a></b>(&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
458     :\r
459                                         Number<div class="mdesc"><div class="short">Get the index within the cache of the Record with the passed id.</div><div class="long">Get the index within the cache of the Record with the passed id.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc">The id of the Record to find.</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The index of the Record. Returns -1 if not found.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#indexOfId" ext:member="#indexOfId" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-insert"></a><b><a href="source/Store.html#method-Ext.data.Store-insert">insert</a></b>(&nbsp;<code>Number&nbsp;index</code>,&nbsp;<code>Ext.data.Record[]&nbsp;records</code>&nbsp;)\r
460     :\r
461                                         void<div class="mdesc"><div class="short">Inserts Records into the Store at the given index and fires the add event.\r
462 See also add and addSorted.</div><div class="long">Inserts Records into the Store at the given index and fires the <a href="output/Ext.data.Store.html#Ext.data.Store-add" ext:member="add" ext:cls="Ext.data.Store">add</a> event.
463 See also <code><a href="output/Ext.data.Store.html#Ext.data.Store-add" ext:member="add" ext:cls="Ext.data.Store">add</a></code> and <code><a href="output/Ext.data.Store.html#Ext.data.Store-addSorted" ext:member="addSorted" ext:cls="Ext.data.Store">addSorted</a></code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>index</code> : Number<div class="sub-desc">The start index at which to insert the passed Records.</div></li><li><code>records</code> : Ext.data.Record[]<div class="sub-desc">An Array of Ext.data.Record objects to add to the cache.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#insert" ext:member="#insert" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-isFiltered"></a><b><a href="source/Store.html#method-Ext.data.Store-isFiltered">isFiltered</a></b>()\r
464     :\r
465                                         Boolean<div class="mdesc"><div class="short">Returns true if this store is currently filtered</div><div class="long">Returns true if this store is currently filtered<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#isFiltered" ext:member="#isFiltered" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-load"></a><b><a href="source/Store.html#method-Ext.data.Store-load">load</a></b>(&nbsp;<code>Object&nbsp;options</code>&nbsp;)\r
466     :\r
467                                         Boolean<div class="mdesc"><div class="short">Loads the Record cache from the configured proxy using the configured reader.\r
468 Notes:&lt;div class="mdetail-params"&gt;\r
469 Impo...</div><div class="long"><p>Loads the Record cache from the configured <tt><a href="output/Ext.data.Store.html#Ext.data.Store-proxy" ext:member="proxy" ext:cls="Ext.data.Store">proxy</a></tt> using the configured <tt><a href="output/Ext.data.Store.html#Ext.data.Store-reader" ext:member="reader" ext:cls="Ext.data.Store">reader</a></tt>.</p>
470 <br><p>Notes:</p><div class="mdetail-params"><ul>
471 <li><b><u>Important</u></b>: loading is asynchronous! This call will return before the new data has been
472 loaded. To perform any post-processing where information from the load call is required, specify
473 the <tt>callback</tt> function to be called, or use a <a href="output/Ext.util.Observable.html#Ext.util.Observable-listeners" ext:member="listeners" ext:cls="Ext.util.Observable">a 'load' event handler</a>.</li>
474 <li>If using <a href="output/Ext.PagingToolbar.html" ext:cls="Ext.PagingToolbar">remote paging</a>, the first load call must specify the <tt>start</tt> and <tt>limit</tt>
475 properties in the <code>options.params</code> property to establish the initial position within the
476 dataset, and the number of Records to cache on each read from the Proxy.</li>
477 <li>If using <a href="output/Ext.data.Store.html#Ext.data.Store-remoteSort" ext:member="remoteSort" ext:cls="Ext.data.Store">remote sorting</a>, the configured <code><a href="output/Ext.data.Store.html#Ext.data.Store-sortInfo" ext:member="sortInfo" ext:cls="Ext.data.Store">sortInfo</a></code>
478 will be automatically included with the posted parameters according to the specified
479 <code><a href="output/Ext.data.Store.html#Ext.data.Store-paramNames" ext:member="paramNames" ext:cls="Ext.data.Store">paramNames</a></code>.</li>
480 </ul></div><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">An object containing properties which control loading options:<ul>
481 <li><b><tt>params</tt></b> :Object<div class="sub-desc"><p>An object containing properties to pass as HTTP
482 parameters to a remote data source. <b>Note</b>: <code>params</code> will override any
483 <code><a href="output/Ext.data.Store.html#Ext.data.Store-baseParams" ext:member="baseParams" ext:cls="Ext.data.Store">baseParams</a></code> of the same name.</p>
484 <p>Parameters are encoded as standard HTTP parameters using <a href="output/Ext.html#Ext-urlEncode" ext:member="urlEncode" ext:cls="Ext">Ext.urlEncode</a>.</p></div></li>
485 <li><b><tt>callback</tt></b> : Function<div class="sub-desc"><p>A function to be called after the Records
486 have been loaded. The <tt>callback</tt> is called after the load event and is passed the following arguments:<ul>
487 <li><tt>r</tt> : Ext.data.Record[]</li>
488 <li><tt>options</tt>: Options object from the load call</li>
489 <li><tt>success</tt>: Boolean success indicator</li></ul></p></div></li>
490 <li><b><tt>scope</tt></b> : Object<div class="sub-desc"><p>Scope with which to call the callback (defaults
491 to the Store object)</p></div></li>
492 <li><b><tt>add</tt></b> : Boolean<div class="sub-desc"><p>Indicator to append loaded records rather than
493 replace the current cache.  <b>Note</b>: see note for <tt><a href="output/Ext.data.Store.html#Ext.data.Store-loadData" ext:member="loadData" ext:cls="Ext.data.Store">loadData</a></tt></p></div></li>
494 </ul></div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">If the &lt;i&gt;developer&lt;/i&gt; provided &lt;tt&gt;{@link #beforeload}&lt;/tt&gt; event handler returns\r
495 &lt;tt&gt;false&lt;/tt&gt;, the load call will abort and will return &lt;tt&gt;false&lt;/tt&gt;; otherwise will return &lt;tt&gt;true&lt;/tt&gt;.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#load" ext:member="#load" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-loadData"></a><b><a href="source/Store.html#method-Ext.data.Store-loadData">loadData</a></b>(&nbsp;<code>Object&nbsp;data</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;append</code>]</span>&nbsp;)\r
496     :\r
497                                         void<div class="mdesc"><div class="short">Loads data from a passed data block and fires the load event. A Reader\r
498 which understands the format of the data must ...</div><div class="long">Loads data from a passed data block and fires the <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a> event. A <a href="output/Ext.data.Reader.html" ext:cls="Ext.data.Reader">Reader</a>
499 which understands the format of the data must have been configured in the constructor.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>data</code> : Object<div class="sub-desc">The data block from which to read the Records.  The format of the data expected
500 is dependent on the type of <a href="output/Ext.data.Reader.html" ext:cls="Ext.data.Reader">Reader</a> that is configured and should correspond to
501 that <a href="output/Ext.data.Reader.html" ext:cls="Ext.data.Reader">Reader</a>'s <tt><a href="output/Ext.data.Reader.html#Ext.data.Reader-readRecords" ext:member="readRecords" ext:cls="Ext.data.Reader">Ext.data.Reader.readRecords</a></tt> parameter.</div></li><li><code>append</code> : Boolean<div class="sub-desc">(Optional) <tt>true</tt> to append the new Records rather the default to replace
502 the existing cache.
503 <b>Note</b>: that Records in a Store are keyed by their <a href="output/Ext.data.Record.html#Ext.data.Record-id" ext:member="id" ext:cls="Ext.data.Record">id</a>, so added Records
504 with ids which are already present in the Store will <i>replace</i> existing Records. Only Records with
505 new, unique ids will be added.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#loadData" ext:member="#loadData" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
506     :\r
507                                         void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
508 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()\r
509     :\r
510                                         void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-query"></a><b><a href="source/Store.html#method-Ext.data.Store-query">query</a></b>(&nbsp;<code>String&nbsp;field</code>,&nbsp;<code>String/RegExp&nbsp;value</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;anyMatch</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;caseSensitive</code>]</span>&nbsp;)\r
511     :\r
512                                         MixedCollection<div class="mdesc"><div class="short">Query the records by a specified property.</div><div class="long">Query the records by a specified property.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>field</code> : String<div class="sub-desc">A field on your records</div></li><li><code>value</code> : String/RegExp<div class="sub-desc">Either a string that the field
513 should begin with, or a RegExp to test against the field.</div></li><li><code>anyMatch</code> : Boolean<div class="sub-desc">(optional) True to match any part not just the beginning</div></li><li><code>caseSensitive</code> : Boolean<div class="sub-desc">(optional) True for case sensitive comparison</div></li></ul><strong>Returns:</strong><ul><li><code>MixedCollection</code><div class="sub-desc">Returns an Ext.util.MixedCollection of the matched records</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#query" ext:member="#query" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-queryBy"></a><b><a href="source/Store.html#method-Ext.data.Store-queryBy">queryBy</a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
514     :\r
515                                         MixedCollection<div class="mdesc"><div class="short">Query the cached records in this Store using a filtering function. The specified function\r
516 will be called with each re...</div><div class="long">Query the cached records in this Store using a filtering function. The specified function
517 will be called with each record in this Store. If the function returns <tt>true</tt> the record is
518 included in the results.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called. It will be passed the following parameters:<ul>
519 <li><b>record</b> : Ext.data.Record<p class="sub-desc">The <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">record</a>
520 to test for filtering. Access field values using <a href="output/Ext.data.Record.html#Ext.data.Record-get" ext:member="get" ext:cls="Ext.data.Record">Ext.data.Record.get</a>.</p></li>
521 <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
522 </ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to this)</div></li></ul><strong>Returns:</strong><ul><li><code>MixedCollection</code><div class="sub-desc">Returns an Ext.util.MixedCollection of the matched records</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#queryBy" ext:member="#queryBy" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-rejectChanges"></a><b><a href="source/Store.html#method-Ext.data.Store-rejectChanges">rejectChanges</a></b>()\r
523     :\r
524                                         void<div class="mdesc"><div class="short">Reject outstanding changes on all modified records.</div><div class="long"><a href="output/Ext.data.Record.html#Ext.data.Record-reject" ext:member="reject" ext:cls="Ext.data.Record">Reject</a> outstanding changes on all <a href="output/Ext.data.Store.html#Ext.data.Store-getModifiedRecords" ext:member="getModifiedRecords" ext:cls="Ext.data.Store">modified records</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#rejectChanges" ext:member="#rejectChanges" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>(&nbsp;<code>Object&nbsp;o</code>,&nbsp;<code>Array&nbsp;events</code>&nbsp;)\r
525     :\r
526                                         void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-reload"></a><b><a href="source/Store.html#method-Ext.data.Store-reload">reload</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
527     :\r
528                                         void<div class="mdesc"><div class="short">Reloads the Record cache from the configured Proxy using the configured Reader and\r
529 the options from the last load ope...</div><div class="long"><p>Reloads the Record cache from the configured Proxy using the configured <a href="output/Ext.data.Reader.html" ext:cls="Ext.data.Reader">Reader</a> and
530 the options from the last load operation performed.</p>
531 <p><b>Note</b>: see the Important note in <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">(optional) An <tt>Object</tt> containing <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">loading options</a> which may
532 override the options used in the last <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a> operation. See <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a> for details (defaults to
533 <tt>null</tt>, in which case the <a href="output/Ext.data.Store.html#Ext.data.Store-lastOptions" ext:member="lastOptions" ext:cls="Ext.data.Store">lastOptions</a> are used).</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#reload" ext:member="#reload" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-remove"></a><b><a href="source/Store.html#method-Ext.data.Store-remove">remove</a></b>(&nbsp;<code>Ext.data.Record&nbsp;record</code>&nbsp;)\r
534     :\r
535                                         void<div class="mdesc"><div class="short">Remove a Record from the Store and fires the remove event.</div><div class="long">Remove a Record from the Store and fires the <a href="output/Ext.data.Store.html#Ext.data.Store-remove" ext:member="remove" ext:cls="Ext.data.Store">remove</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>record</code> : Ext.data.Record<div class="sub-desc">The Ext.data.Record object to remove from the cache.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#remove" ext:member="#remove" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-removeAll"></a><b><a href="source/Store.html#method-Ext.data.Store-removeAll">removeAll</a></b>()\r
536     :\r
537                                         void<div class="mdesc"><div class="short">Remove all Records from the Store and fires the clear event.</div><div class="long">Remove all Records from the Store and fires the <a href="output/Ext.data.Store.html#Ext.data.Store-clear" ext:member="clear" ext:cls="Ext.data.Store">clear</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#removeAll" ext:member="#removeAll" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-removeAt"></a><b><a href="source/Store.html#method-Ext.data.Store-removeAt">removeAt</a></b>(&nbsp;<code>Number&nbsp;index</code>&nbsp;)\r
538     :\r
539                                         void<div class="mdesc"><div class="short">Remove a Record from the Store at the specified index. Fires the remove event.</div><div class="long">Remove a Record from the Store at the specified index. Fires the <a href="output/Ext.data.Store.html#Ext.data.Store-remove" ext:member="remove" ext:cls="Ext.data.Store">remove</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>index</code> : Number<div class="sub-desc">The index of the record to remove.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#removeAt" ext:member="#removeAt" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
540     :\r
541                                         void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()\r
542     :\r
543                                         void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)\r
544 If events were suspended using the queueSuspended parameter, then all\r
545 event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
546 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
547 events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-save"></a><b><a href="source/Store.html#method-Ext.data.Store-save">save</a></b>()\r
548     :\r
549                                         void<div class="mdesc"><div class="short">Saves all pending changes to the store.  If the commensurate Ext.data.Api.actions action is not configured, then\r
550 the ...</div><div class="long">Saves all pending changes to the store.  If the commensurate Ext.data.Api.actions action is not configured, then
551 the configured <code><a href="output/Ext.data.Store.html#Ext.data.Store-url" ext:member="url" ext:cls="Ext.data.Store">url</a></code> will be used.
552 <pre>
553 change            url
554 ---------------   --------------------
555 removed records   Ext.data.Api.actions.destroy
556 phantom records   Ext.data.Api.actions.create
557 <a href="output/Ext.data.Store.html#Ext.data.Store-getModifiedRecords" ext:member="getModifiedRecords" ext:cls="Ext.data.Store">modified records</a>  Ext.data.Api.actions.update
558 </pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#save" ext:member="#save" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-setBaseParam"></a><b><a href="source/Store.html#method-Ext.data.Store-setBaseParam">setBaseParam</a></b>(&nbsp;<code>String&nbsp;name</code>,&nbsp;<code>Mixed&nbsp;value</code>&nbsp;)\r
559     :\r
560                                         void<div class="mdesc"><div class="short">Set the value for a property name in this store's baseParams.  Usage:myStore.setBaseParam('foo', {bar:3});</div><div class="long">Set the value for a property name in this store's <a href="output/Ext.data.Store.html#Ext.data.Store-baseParams" ext:member="baseParams" ext:cls="Ext.data.Store">baseParams</a>.  Usage:</p><pre><code>myStore.setBaseParam(<em>'foo'</em>, {bar:3});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>name</code> : String<div class="sub-desc">Name of the property to assign</div></li><li><code>value</code> : Mixed<div class="sub-desc">Value to assign the <tt>name</tt>d property</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#setBaseParam" ext:member="#setBaseParam" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-setDefaultSort"></a><b><a href="source/Store.html#method-Ext.data.Store-setDefaultSort">setDefaultSort</a></b>(&nbsp;<code>String&nbsp;fieldName</code>,&nbsp;<span title="Optional" class="optional">[<code>String&nbsp;dir</code>]</span>&nbsp;)\r
561     :\r
562                                         void<div class="mdesc"><div class="short">Sets the default sort column and order to be used by the next load operation.</div><div class="long">Sets the default sort column and order to be used by the next <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a> operation.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fieldName</code> : String<div class="sub-desc">The name of the field to sort by.</div></li><li><code>dir</code> : String<div class="sub-desc">(optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to <tt>'ASC'</tt>)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#setDefaultSort" ext:member="#setDefaultSort" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-sort"></a><b><a href="source/Store.html#method-Ext.data.Store-sort">sort</a></b>(&nbsp;<code>String&nbsp;fieldName</code>,&nbsp;<span title="Optional" class="optional">[<code>String&nbsp;dir</code>]</span>&nbsp;)\r
563     :\r
564                                         void<div class="mdesc"><div class="short">Sort the Records.\r
565 If remote sorting is used, the sort is performed on the server, and the cache is reloaded. If local...</div><div class="long">Sort the Records.
566 If remote sorting is used, the sort is performed on the server, and the cache is reloaded. If local
567 sorting is used, the cache is sorted internally. See also <a href="output/Ext.data.Store.html#Ext.data.Store-remoteSort" ext:member="remoteSort" ext:cls="Ext.data.Store">remoteSort</a> and <a href="output/Ext.data.Store.html#Ext.data.Store-paramNames" ext:member="paramNames" ext:cls="Ext.data.Store">paramNames</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fieldName</code> : String<div class="sub-desc">The name of the field to sort by.</div></li><li><code>dir</code> : String<div class="sub-desc">(optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to <tt>'ASC'</tt>)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#sort" ext:member="#sort" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-sum"></a><b><a href="source/Store.html#method-Ext.data.Store-sum">sum</a></b>(&nbsp;<code>String&nbsp;property</code>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;start</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;end</code>]</span>&nbsp;)\r
568     :\r
569                                         Number<div class="mdesc"><div class="short">Sums the value of property for each record between start\r
570 and end and returns the result.</div><div class="long">Sums the value of <tt>property</tt> for each <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">record</a> between <tt>start</tt>
571 and <tt>end</tt> and returns the result.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>property</code> : String<div class="sub-desc">A field in each record</div></li><li><code>start</code> : Number<div class="sub-desc">(optional) The record index to start at (defaults to <tt>0</tt>)</div></li><li><code>end</code> : Number<div class="sub-desc">(optional) The last record index to include (defaults to length - 1)</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The sum</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#sum" ext:member="#sum" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>(&nbsp;<code>Boolean&nbsp;queueSuspended</code>&nbsp;)\r
572     :\r
573                                         void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
574 after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
575     :\r
576                                         void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.data.XmlStore-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-add"></a><b><a href="source/Store.html#event-Ext.data.Store-add">add</a></b> :\r
577                                       (&nbsp;<code>Store&nbsp;this</code>,&nbsp;<code>Ext.data.Record[]&nbsp;records</code>,&nbsp;<code>Number&nbsp;index</code>&nbsp;)\r
578     <div class="mdesc"><div class="short">Fires when Records have been added to the Store</div><div class="long">Fires when Records have been <a href="output/Ext.data.Store.html#Ext.data.Store-add" ext:member="add" ext:cls="Ext.data.Store">add</a>ed to the Store<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>records</code> : Ext.data.Record[]<div class="sub-desc">The array of Records added</div></li><li><code>index</code> : Number<div class="sub-desc">The index at which the record(s) were added</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#add" ext:member="#add" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-beforeload"></a><b><a href="source/Store.html#event-Ext.data.Store-beforeload">beforeload</a></b> :\r
579                                       (&nbsp;<code>Store&nbsp;this</code>,&nbsp;<code>Object&nbsp;options</code>&nbsp;)\r
580     <div class="mdesc"><div class="short">Fires before a request is made for a new data object.  If the beforeload handler returns\r
581 false the load action will b...</div><div class="long">Fires before a request is made for a new data object.  If the beforeload handler returns
582 <tt>false</tt> the <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a> action will be canceled.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>options</code> : Object<div class="sub-desc">The loading options that were specified (see <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a> for details)</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#beforeload" ext:member="#beforeload" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-beforewrite"></a><b><a href="source/Store.html#event-Ext.data.Store-beforewrite">beforewrite</a></b> :\r
583                                       (&nbsp;<code>Ext.data.Store&nbsp;store</code>,&nbsp;<code>String&nbsp;action</code>,&nbsp;<code>Record/Array[Record]&nbsp;rs</code>,&nbsp;<code>Object&nbsp;options</code>,&nbsp;<code>Object&nbsp;arg</code>&nbsp;)\r
584     <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>store</code> : Ext.data.Store<div class="sub-desc"></div></li><li><code>action</code> : String<div class="sub-desc">[Ext.data.Api.actions.create|update|destroy]</div></li><li><code>rs</code> : Record/Array[Record]<div class="sub-desc"></div></li><li><code>options</code> : Object<div class="sub-desc">The loading options that were specified. Edit <code>options.params</code> to add Http parameters to the request.  (see <a href="output/Ext.data.Store.html#Ext.data.Store-save" ext:member="save" ext:cls="Ext.data.Store">save</a> for details)</div></li><li><code>arg</code> : Object<div class="sub-desc">The callback's arg object passed to the <a href="output/Ext.data.Store.html#Ext.data.Store-request" ext:member="request" ext:cls="Ext.data.Store">request</a> function</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#beforewrite" ext:member="#beforewrite" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-clear"></a><b><a href="source/Store.html#event-Ext.data.Store-clear">clear</a></b> :\r
585                                       (&nbsp;<code>Store&nbsp;this</code>,&nbsp;<code>Record[]&nbsp;The</code>&nbsp;)\r
586     <div class="mdesc"><div class="short">Fires when the data cache has been cleared.</div><div class="long">Fires when the data cache has been cleared.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>The</code> : Record[]<div class="sub-desc">records that were cleared.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#clear" ext:member="#clear" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-datachanged"></a><b><a href="source/Store.html#event-Ext.data.Store-datachanged">datachanged</a></b> :\r
587                                       (&nbsp;<code>Store&nbsp;this</code>&nbsp;)\r
588     <div class="mdesc"><div class="short">Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a\r
589 widget that i...</div><div class="long">Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a
590 widget that is using this Store as a Record cache should refresh its view.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Store<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#datachanged" ext:member="#datachanged" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-exception"></a><b><a href="source/Store.html#event-Ext.data.Store-exception">exception</a></b> :\r
591                                       (&nbsp;<code>misc&nbsp;misc</code>&nbsp;)\r
592     <div class="mdesc"><div class="short">Fires if an exception occurs in the Proxy during a remote request.\r
593 This event is relayed through the corresponding Ex...</div><div class="long"><p>Fires if an exception occurs in the Proxy during a remote request.
594 This event is relayed through the corresponding <a href="output/Ext.data.DataProxy.html" ext:cls="Ext.data.DataProxy">Ext.data.DataProxy</a>.
595 See <a href="output/Ext.data.DataProxy.html" ext:cls="Ext.data.DataProxy">Ext.data.DataProxy</a>.<a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-exception" ext:member="exception" ext:cls="Ext.data.DataProxy">exception</a>
596 for additional details.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>misc</code> : misc<div class="sub-desc">See <a href="output/Ext.data.DataProxy.html" ext:cls="Ext.data.DataProxy">Ext.data.DataProxy</a>.<a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-exception" ext:member="exception" ext:cls="Ext.data.DataProxy">exception</a>
597 for description.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#exception" ext:member="#exception" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-load"></a><b><a href="source/Store.html#event-Ext.data.Store-load">load</a></b> :\r
598                                       (&nbsp;<code>Store&nbsp;this</code>,&nbsp;<code>Ext.data.Record[]&nbsp;records</code>,&nbsp;<code>Object&nbsp;options</code>&nbsp;)\r
599     <div class="mdesc"><div class="short">Fires after a new set of Records has been loaded.</div><div class="long">Fires after a new set of Records has been loaded.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>records</code> : Ext.data.Record[]<div class="sub-desc">The Records that were loaded</div></li><li><code>options</code> : Object<div class="sub-desc">The loading options that were specified (see <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">load</a> for details)</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#load" ext:member="#load" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-loadexception"></a><b><a href="source/Store.html#event-Ext.data.Store-loadexception">loadexception</a></b> :\r
600                                       (&nbsp;<code>misc&nbsp;misc</code>&nbsp;)\r
601     <div class="mdesc"><div class="short">This event is deprecated in favor of the catch-all exception\r
602 event instead.\r
603 This event is relayed through the corresp...</div><div class="long"><p>This event is <b>deprecated</b> in favor of the catch-all <b><code><a href="output/Ext.data.Store.html#Ext.data.Store-exception" ext:member="exception" ext:cls="Ext.data.Store">exception</a></code></b>
604 event instead.</p>
605 <p>This event is relayed through the corresponding <a href="output/Ext.data.DataProxy.html" ext:cls="Ext.data.DataProxy">Ext.data.DataProxy</a>.
606 See <a href="output/Ext.data.DataProxy.html" ext:cls="Ext.data.DataProxy">Ext.data.DataProxy</a>.<a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-loadexception" ext:member="loadexception" ext:cls="Ext.data.DataProxy">loadexception</a>
607 for additional details.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>misc</code> : misc<div class="sub-desc">See <a href="output/Ext.data.DataProxy.html" ext:cls="Ext.data.DataProxy">Ext.data.DataProxy</a>.<a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-loadexception" ext:member="loadexception" ext:cls="Ext.data.DataProxy">loadexception</a>
608 for description.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#loadexception" ext:member="#loadexception" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-metachange"></a><b><a href="source/Store.html#event-Ext.data.Store-metachange">metachange</a></b> :\r
609                                       (&nbsp;<code>Store&nbsp;this</code>,&nbsp;<code>Object&nbsp;meta</code>&nbsp;)\r
610     <div class="mdesc"><div class="short">Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders.</div><div class="long">Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>meta</code> : Object<div class="sub-desc">The JSON metadata</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#metachange" ext:member="#metachange" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-remove"></a><b><a href="source/Store.html#event-Ext.data.Store-remove">remove</a></b> :\r
611                                       (&nbsp;<code>Store&nbsp;this</code>,&nbsp;<code>Ext.data.Record&nbsp;record</code>,&nbsp;<code>Number&nbsp;index</code>&nbsp;)\r
612     <div class="mdesc"><div class="short">Fires when a Record has been removed from the Store</div><div class="long">Fires when a Record has been <a href="output/Ext.data.Store.html#Ext.data.Store-remove" ext:member="remove" ext:cls="Ext.data.Store">remove</a>d from the Store<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>record</code> : Ext.data.Record<div class="sub-desc">The Record that was removed</div></li><li><code>index</code> : Number<div class="sub-desc">The index at which the record was removed</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#remove" ext:member="#remove" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-update"></a><b><a href="source/Store.html#event-Ext.data.Store-update">update</a></b> :\r
613                                       (&nbsp;<code>Store&nbsp;this</code>,&nbsp;<code>Ext.data.Record&nbsp;record</code>,&nbsp;<code>String&nbsp;operation</code>&nbsp;)\r
614     <div class="mdesc"><div class="short">Fires when a Record has been updated</div><div class="long">Fires when a Record has been updated<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>record</code> : Ext.data.Record<div class="sub-desc">The Record that was updated</div></li><li><code>operation</code> : String<div class="sub-desc">The update operation being performed.  Value may be one of:
615 <pre><code>Ext.data.Record.EDIT
616  Ext.data.Record.REJECT
617  Ext.data.Record.COMMIT</code></pre></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#update" ext:member="#update" ext:cls="Ext.data.Store">Store</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Store-write"></a><b><a href="source/Store.html#event-Ext.data.Store-write">write</a></b> :\r
618                                       (&nbsp;<code>Ext.data.Store&nbsp;store</code>,&nbsp;<code>String&nbsp;action</code>,&nbsp;<code>Object&nbsp;result</code>,&nbsp;<code>Ext.Direct.Transaction&nbsp;res</code>,&nbsp;<code>Record/Record[]&nbsp;rs</code>&nbsp;)\r
619     <div class="mdesc"><div class="short">Fires if the server returns 200 after an Ext.data.Api.actions CRUD action.\r
620 Success of the action is determined in the...</div><div class="long">Fires if the server returns 200 after an Ext.data.Api.actions CRUD action.
621 Success of the action is determined in the <code>result[<em>'successProperty'</em>]</code>property (<b>NOTE</b> for RESTful stores,
622 a simple 20x response is sufficient for the actions "destroy" and "update".  The "create" action should should return 200 along with a database pk).<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>store</code> : Ext.data.Store<div class="sub-desc"></div></li><li><code>action</code> : String<div class="sub-desc">[Ext.data.Api.actions.create|update|destroy]</div></li><li><code>result</code> : Object<div class="sub-desc">The 'data' picked-out out of the response for convenience.</div></li><li><code>res</code> : Ext.Direct.Transaction<div class="sub-desc"></div></li><li><code>rs</code> : Record/Record[]<div class="sub-desc">Store's records, the subject(s) of the write-action</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Store.html#write" ext:member="#write" ext:cls="Ext.data.Store">Store</a></td></tr></tbody></table></div>