commit extjs-2.2.1
[extjs.git] / docs / output / Ext.data.SimpleStore.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.data.SimpleStore-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.data.SimpleStore-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.data.SimpleStore-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                             <a class="inner-link" href="#Ext.data.SimpleStore-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7                         <a class="bookmark" href="../docs/?class=Ext.data.SimpleStore"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8         </div>
9                 <div class="inheritance res-block">
10 <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
11   <img src="resources/elbow-end.gif"/><a ext:cls="Ext.data.Store" ext:member="" href="output/Ext.data.Store.html">Store</a>
12     <img src="resources/elbow-end.gif"/>SimpleStore</pre></div>
13                 <h1>Class Ext.data.SimpleStore</h1>
14         <table cellspacing="0">
15             <tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr>
16             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/SimpleStore.js" target="_blank">SimpleStore.js</a></td></tr>
17             <tr><td class="label">Class:</td><td class="hd-info">SimpleStore</td></tr>
18                                     <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.data.Store" ext:member="" href="output/Ext.data.Store.html">Store</a></td></tr>
19                     </table>
20         <div class="description">
21             *
22 Small helper class to make creating Stores from Array data easier.        </div>
23         
24         <div class="hr"></div>
25                 <a id="Ext.data.SimpleStore-configs"></a>
26         <h2>Config Options</h2>
27         <table cellspacing="0" class="member-table">
28             <tr>
29                 <th class="sig-header" colspan="2">Config Options</th>
30                 <th class="msource-header">Defined By</th>
31             </tr>
32                 <tr class="config-row inherited">\r
33         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
34         <td class="sig">\r
35         <a id="Ext.data.SimpleStore-autoLoad"></a>\r
36             <b>autoLoad</b> : Boolean/Object            <div class="mdesc">\r
37                             If passed, this store's load method is automatically called after creation with the autoLoad object                        </div>\r
38         </td>\r
39         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#autoLoad" href="output/Ext.data.Store.html#autoLoad">Store</a></td>\r
40     </tr>\r
41         <tr class="config-row inherited alt">\r
42         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
43         <td class="sig">\r
44         <a id="Ext.data.SimpleStore-baseParams"></a>\r
45             <b>baseParams</b> : Object            <div class="mdesc">\r
46                             An object containing properties which are to be sent as parameters on any HTTP request                        </div>\r
47         </td>\r
48         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#baseParams" href="output/Ext.data.Store.html#baseParams">Store</a></td>\r
49     </tr>\r
50         <tr class="config-row">\r
51         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
52         <td class="sig">\r
53         <a id="Ext.data.SimpleStore-data"></a>\r
54             <b>data</b> : Array            <div class="mdesc">\r
55                             The multi-dimensional array of data.                        </div>\r
56         </td>\r
57         <td class="msource">SimpleStore</td>\r
58     </tr>\r
59         <tr class="config-row alt">\r
60         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
61         <td class="sig">\r
62         <a id="Ext.data.SimpleStore-fields"></a>\r
63             <b>fields</b> : Array            <div class="mdesc">\r
64                             An array of field definition objects, or field name string as specified to <a ext:cls="Ext.data.Record" ext:member="create" href="output/Ext.data.Record.html#create">Ext.data.Record.create</a>                        </div>\r
65         </td>\r
66         <td class="msource">SimpleStore</td>\r
67     </tr>\r
68         <tr class="config-row">\r
69         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
70         <td class="sig">\r
71         <a id="Ext.data.SimpleStore-id"></a>\r
72             <b>id</b> : Number            <div class="mdesc">\r
73                             The array index of the record id. Leave blank to auto generate ids.                        </div>\r
74         </td>\r
75         <td class="msource">SimpleStore</td>\r
76     </tr>\r
77         <tr class="config-row inherited alt expandable">\r
78         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
79         <td class="sig">\r
80         <a id="Ext.data.SimpleStore-listeners"></a>\r
81             <b>listeners</b> : Object            <div class="mdesc">\r
82                         <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
83             <div class="long">\r
84                 (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once.            </div>\r
85                         </div>\r
86         </td>\r
87         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
88     </tr>\r
89         <tr class="config-row inherited">\r
90         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
91         <td class="sig">\r
92         <a id="Ext.data.SimpleStore-proxy"></a>\r
93             <b>proxy</b> : Ext.data.DataProxy            <div class="mdesc">\r
94                             The Proxy object which provides access to a data object.                        </div>\r
95         </td>\r
96         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#proxy" href="output/Ext.data.Store.html#proxy">Store</a></td>\r
97     </tr>\r
98         <tr class="config-row inherited alt expandable">\r
99         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
100         <td class="sig">\r
101         <a id="Ext.data.SimpleStore-pruneModifiedRecords"></a>\r
102             <b>pruneModifiedRecords</b> : boolean            <div class="mdesc">\r
103                         <div class="short">True to clear all modified record information each time the store is loaded or when a record is removed. (defaults to...</div>\r
104             <div class="long">\r
105                 True to clear all modified record information each time the store is loaded or when a record is removed. (defaults to false).            </div>\r
106                         </div>\r
107         </td>\r
108         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#pruneModifiedRecords" href="output/Ext.data.Store.html#pruneModifiedRecords">Store</a></td>\r
109     </tr>\r
110         <tr class="config-row inherited expandable">\r
111         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
112         <td class="sig">\r
113         <a id="Ext.data.SimpleStore-reader"></a>\r
114             <b>reader</b> : Ext.data.DataReader            <div class="mdesc">\r
115                         <div class="short">The DataReader object which processes the data object and returns an Array of Ext.data.Record objects which are cache...</div>\r
116             <div class="long">\r
117                 The DataReader object which processes the data object and returns an Array of Ext.data.Record objects which are cached keyed by their <em>id</em> property.            </div>\r
118                         </div>\r
119         </td>\r
120         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#reader" href="output/Ext.data.Store.html#reader">Store</a></td>\r
121     </tr>\r
122         <tr class="config-row inherited alt expandable">\r
123         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
124         <td class="sig">\r
125         <a id="Ext.data.SimpleStore-remoteSort"></a>\r
126             <b>remoteSort</b> : boolean            <div class="mdesc">\r
127                         <div class="short">True if sorting is to be handled by requesting the Proxy to provide a refreshed version of the data object in sorted ...</div>\r
128             <div class="long">\r
129                 True if sorting is to be handled by requesting the Proxy to provide a refreshed version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false). <p>If remote sorting is specified, then clicking on a column header causes the current page to be requested from the server with the addition of the following two parameters: <div class="mdetail-params"><ul> <li><b>sort</b> : String<p class="sub-desc">The name (as specified in the Record's Field definition) of the field to sort on.</p></li> <li><b>dir</b> : String<p class="sub-desc">The direction of the sort, "ASC" or "DESC" (case-sensitive).</p></li> </ul></div></p>            </div>\r
130                         </div>\r
131         </td>\r
132         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#remoteSort" href="output/Ext.data.Store.html#remoteSort">Store</a></td>\r
133     </tr>\r
134         <tr class="config-row inherited expandable">\r
135         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
136         <td class="sig">\r
137         <a id="Ext.data.SimpleStore-sortInfo"></a>\r
138             <b>sortInfo</b> : Object            <div class="mdesc">\r
139                         <div class="short">A config object in the format: {field: "fieldName", direction: "ASC|DESC"} to specify the sort order in the request o...</div>\r
140             <div class="long">\r
141                 A config object in the format: {field: "fieldName", direction: "ASC|DESC"} to specify the sort order in the request of a remote Store's <a ext:cls="Ext.data.Store" ext:member="load" href="output/Ext.data.Store.html#load">load</a> operation. Note that for local sorting, the direction property is case-sensitive.            </div>\r
142                         </div>\r
143         </td>\r
144         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#sortInfo" href="output/Ext.data.Store.html#sortInfo">Store</a></td>\r
145     </tr>\r
146         <tr class="config-row inherited alt">\r
147         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
148         <td class="sig">\r
149         <a id="Ext.data.SimpleStore-storeId"></a>\r
150             <b>storeId</b> : String            <div class="mdesc">\r
151                             If passed, the id to use to register with the StoreMgr                        </div>\r
152         </td>\r
153         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#storeId" href="output/Ext.data.Store.html#storeId">Store</a></td>\r
154     </tr>\r
155         <tr class="config-row inherited">\r
156         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
157         <td class="sig">\r
158         <a id="Ext.data.SimpleStore-url"></a>\r
159             <b>url</b> : String            <div class="mdesc">\r
160                             If passed, an HttpProxy is created for the passed URL                        </div>\r
161         </td>\r
162         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#url" href="output/Ext.data.Store.html#url">Store</a></td>\r
163     </tr>\r
164             </table>
165                 <a id="Ext.data.SimpleStore-props"></a>
166         <h2>Public Properties</h2>
167                 <table cellspacing="0" class="member-table">
168             <tr>
169                 <th class="sig-header" colspan="2">Property</th>
170                 <th class="msource-header">Defined By</th>
171             </tr>
172                 <tr class="property-row inherited expandable">\r
173         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
174         <td class="sig">\r
175         <a id="Ext.data.SimpleStore-baseParams"></a>\r
176             <b>baseParams</b> : Object            <div class="mdesc">\r
177                         <div class="short">An object containing properties which are used as parameters on any HTTP request.
178 This property can be changed after ...</div>\r
179             <div class="long">\r
180                 An object containing properties which are used as parameters on any HTTP request.
181 This property can be changed after creating the Store to send different parameters.            </div>\r
182                         </div>\r
183         </td>\r
184         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#baseParams" href="output/Ext.data.Store.html#baseParams">Store</a></td>\r
185     </tr>\r
186         <tr class="property-row inherited alt">\r
187         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
188         <td class="sig">\r
189         <a id="Ext.data.SimpleStore-fields"></a>\r
190             <b>fields</b> : Ext.util.MixedCollection            <div class="mdesc">\r
191                             A MixedCollection containing the defined <a ext:cls="Ext.data.Field" href="output/Ext.data.Field.html">Field</a>s for the Records stored in this Store.  Read-only.                        </div>\r
192         </td>\r
193         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#fields" href="output/Ext.data.Store.html#fields">Store</a></td>\r
194     </tr>\r
195         <tr class="property-row inherited expandable">\r
196         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
197         <td class="sig">\r
198         <a id="Ext.data.SimpleStore-lastOptions"></a>\r
199             <b>lastOptions</b> : Object            <div class="mdesc">\r
200                         <div class="short">Contains the last options object used as the parameter to the load method. See load
201 for the details of what this may ...</div>\r
202             <div class="long">\r
203                 Contains the last options object used as the parameter to the load method. See <a ext:cls="Ext.data.Store" ext:member="load" href="output/Ext.data.Store.html#load">load</a>
204 for the details of what this may contain. This may be useful for accessing any params which
205 were used to load the current Record cache.            </div>\r
206                         </div>\r
207         </td>\r
208         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#lastOptions" href="output/Ext.data.Store.html#lastOptions">Store</a></td>\r
209     </tr>\r
210         <tr class="property-row inherited alt expandable">\r
211         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
212         <td class="sig">\r
213         <a id="Ext.data.SimpleStore-paramNames"></a>\r
214             <b>paramNames</b> : Object            <div class="mdesc">\r
215                         <div class="short">An object containing properties which specify the names of the paging and
216 sorting parameters passed to remote servers...</div>\r
217             <div class="long">\r
218                 <p>An object containing properties which specify the names of the paging and
219 sorting parameters passed to remote servers when loading blocks of data. By default, this
220 object takes the following form:</p><pre><code>{
221     start : <em>"start"</em>,    <i>// The parameter name which specifies the start row</i>
222     limit : <em>"limit"</em>,    <i>// The parameter name which specifies number of rows to <b>return</b></i>
223     sort : <em>"sort"</em>,      <i>// The parameter name which specifies the column to sort on</i>
224     dir : <em>"dir"</em>         <i>// The parameter name which specifies the sort direction</i>
225 }</code></pre>
226 <p>The server must produce the requested data block upon receipt of these parameter names.
227 If different parameter names are required, this property can be overriden using a configuration
228 property.</p>
229 <p>A <a ext:cls="Ext.PagingToolbar" href="output/Ext.PagingToolbar.html">PagingToolbar</a> bound to this grid uses this property to determine
230 the parameter names to use in its requests.            </div>\r
231                         </div>\r
232         </td>\r
233         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#paramNames" href="output/Ext.data.Store.html#paramNames">Store</a></td>\r
234     </tr>\r
235         <tr class="property-row inherited expandable">\r
236         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
237         <td class="sig">\r
238         <a id="Ext.data.SimpleStore-recordType"></a>\r
239             <b>recordType</b> : Function            <div class="mdesc">\r
240                         <div class="short">The Record constructor as supplied to (or created by) the Reader.  Read-only.
241 If the Reader was constructed by passin...</div>\r
242             <div class="long">\r
243                 The <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Record</a> constructor as supplied to (or created by) the <a ext:cls="Ext.data.Reader" ext:member="Reader" href="output/Ext.data.Reader.html#Reader">Reader</a>.  Read-only.
244 <p>If the Reader was constructed by passing in an Array of field definition objects, instead of an created
245 Record constructor it will have <a ext:cls="Ext.data.Record" ext:member="create" href="output/Ext.data.Record.html#create">created a constructor</a> from that Array.</p>
246 <p>This property may be used to create new Records of the type held in this Store.</p>            </div>\r
247                         </div>\r
248         </td>\r
249         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#recordType" href="output/Ext.data.Store.html#recordType">Store</a></td>\r
250     </tr>\r
251             </table>
252                 <a id="Ext.data.SimpleStore-methods"></a>
253         <h2>Public Methods</h2>
254                 <table cellspacing="0" class="member-table">
255             <tr>
256                 <th class="sig-header" colspan="2">Method</th>
257                 <th class="msource-header">Defined By</th>
258             </tr>
259                 <tr class="method-row expandable">\r
260         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
261         <td class="sig">\r
262         <a id="Ext.data.SimpleStore-SimpleStore"></a>\r
263             <b>SimpleStore</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">\r
264                         <div class="short"></div>\r
265             <div class="long">\r
266                     <div class="mdetail-params">\r
267         <strong>Parameters:</strong>\r
268         <ul><li><code>config</code> : Object<div class="sub-desc"></div></li>        </ul>\r
269         <strong>Returns:</strong>\r
270         <ul>\r
271             <li><code></code></li>\r
272         </ul>\r
273     </div>\r
274                 </div>\r
275                         </div>\r
276         </td>\r
277         <td class="msource">SimpleStore</td>\r
278     </tr>\r
279         <tr class="method-row inherited alt expandable">\r
280         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
281         <td class="sig">\r
282         <a id="Ext.data.SimpleStore-add"></a>\r
283             <b>add</b>(&nbsp;<code>Ext.data.Record[] records</code>&nbsp;) : void            <div class="mdesc">\r
284                         <div class="short">Add Records to the Store and fires the <a ext:cls="Ext.data.Store" ext:member="add" href="output/Ext.data.Store.html#add">add</a> event.</div>\r
285             <div class="long">\r
286                 Add Records to the Store and fires the <a ext:cls="Ext.data.Store" ext:member="add" href="output/Ext.data.Store.html#add">add</a> event.    <div class="mdetail-params">\r
287         <strong>Parameters:</strong>\r
288         <ul><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>\r
289         <strong>Returns:</strong>\r
290         <ul>\r
291             <li><code>void</code></li>\r
292         </ul>\r
293     </div>\r
294                 </div>\r
295                         </div>\r
296         </td>\r
297         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#add" href="output/Ext.data.Store.html#add">Store</a></td>\r
298     </tr>\r
299         <tr class="method-row inherited expandable">\r
300         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
301         <td class="sig">\r
302         <a id="Ext.data.SimpleStore-addEvents"></a>\r
303             <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">\r
304                         <div class="short">Used to define events on this Observable</div>\r
305             <div class="long">\r
306                 Used to define events on this Observable    <div class="mdetail-params">\r
307         <strong>Parameters:</strong>\r
308         <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>\r
309         <strong>Returns:</strong>\r
310         <ul>\r
311             <li><code>void</code></li>\r
312         </ul>\r
313     </div>\r
314                 </div>\r
315                         </div>\r
316         </td>\r
317         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
318     </tr>\r
319         <tr class="method-row inherited alt expandable">\r
320         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
321         <td class="sig">\r
322         <a id="Ext.data.SimpleStore-addListener"></a>\r
323             <b>addListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">\r
324                         <div class="short">Appends an event handler to this component</div>\r
325             <div class="long">\r
326                 Appends an event handler to this component    <div class="mdetail-params">\r
327         <strong>Parameters:</strong>\r
328         <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 in which to execute the handler
329 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
330 properties. This may contain any of the following properties:<ul>
331 <li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
332 <li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
333 <li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
334 <li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
335 by the specified number of milliseconds. If the event fires again within that time, the original
336 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
337 </ul><br>
338 <p>
339 <b>Combining Options</b><br>
340 Using the options argument, it is possible to combine different types of listeners:<br>
341 <br>
342 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
343 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
344     single: true,
345     delay: 100,
346     forumId: 4
347 });</code></pre>
348 <p>
349 <b>Attaching multiple handlers in 1 call</b><br>
350 The method also allows for a single argument to be passed which is a config object containing properties
351 which specify multiple handlers.
352 <p>
353 <pre><code>foo.on({
354     <em>'click'</em> : {
355         fn: <b>this</b>.onClick,
356         scope: <b>this</b>,
357         delay: 100
358     },
359     <em>'mouseover'</em> : {
360         fn: <b>this</b>.onMouseOver,
361         scope: <b>this</b>
362     },
363     <em>'mouseout'</em> : {
364         fn: <b>this</b>.onMouseOut,
365         scope: <b>this</b>
366     }
367 });</code></pre>
368 <p>
369 Or a shorthand syntax:<br>
370 <pre><code>foo.on({
371     <em>'click'</em> : <b>this</b>.onClick,
372     <em>'mouseover'</em> : <b>this</b>.onMouseOver,
373     <em>'mouseout'</em> : <b>this</b>.onMouseOut,
374      scope: <b>this</b>
375 });</code></pre></div></li>        </ul>\r
376         <strong>Returns:</strong>\r
377         <ul>\r
378             <li><code>void</code></li>\r
379         </ul>\r
380     </div>\r
381                 </div>\r
382                         </div>\r
383         </td>\r
384         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
385     </tr>\r
386         <tr class="method-row inherited expandable">\r
387         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
388         <td class="sig">\r
389         <a id="Ext.data.SimpleStore-addSorted"></a>\r
390             <b>addSorted</b>(&nbsp;<code>Ext.data.Record record</code>&nbsp;) : void            <div class="mdesc">\r
391                         <div class="short">(Local sort only) Inserts the passed Record into the Store at the index where it
392 should go based on the current sort ...</div>\r
393             <div class="long">\r
394                 (Local sort only) Inserts the passed Record into the Store at the index where it
395 should go based on the current sort information.    <div class="mdetail-params">\r
396         <strong>Parameters:</strong>\r
397         <ul><li><code>record</code> : Ext.data.Record<div class="sub-desc"></div></li>        </ul>\r
398         <strong>Returns:</strong>\r
399         <ul>\r
400             <li><code>void</code></li>\r
401         </ul>\r
402     </div>\r
403                 </div>\r
404                         </div>\r
405         </td>\r
406         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#addSorted" href="output/Ext.data.Store.html#addSorted">Store</a></td>\r
407     </tr>\r
408         <tr class="method-row inherited alt expandable">\r
409         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
410         <td class="sig">\r
411         <a id="Ext.data.SimpleStore-clearFilter"></a>\r
412             <b>clearFilter</b>(&nbsp;<code>Boolean suppressEvent</code>&nbsp;) : void            <div class="mdesc">\r
413                         <div class="short">Revert to a view of the Record cache with no filtering applied.</div>\r
414             <div class="long">\r
415                 Revert to a view of the Record cache with no filtering applied.    <div class="mdetail-params">\r
416         <strong>Parameters:</strong>\r
417         <ul><li><code>suppressEvent</code> : Boolean<div class="sub-desc">If true the filter is cleared silently without notifying listeners</div></li>        </ul>\r
418         <strong>Returns:</strong>\r
419         <ul>\r
420             <li><code>void</code></li>\r
421         </ul>\r
422     </div>\r
423                 </div>\r
424                         </div>\r
425         </td>\r
426         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#clearFilter" href="output/Ext.data.Store.html#clearFilter">Store</a></td>\r
427     </tr>\r
428         <tr class="method-row inherited expandable">\r
429         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
430         <td class="sig">\r
431         <a id="Ext.data.SimpleStore-collect"></a>\r
432             <b>collect</b>(&nbsp;<code>String dataIndex</code>, <span class="optional" title="Optional">[<code>Boolean allowNull</code>]</span>, <span class="optional" title="Optional">[<code>Boolean bypassFilter</code>]</span>&nbsp;) : Array            <div class="mdesc">\r
433                         <div class="short">Collects unique values for a particular dataIndex from this store.</div>\r
434             <div class="long">\r
435                 Collects unique values for a particular dataIndex from this store.    <div class="mdetail-params">\r
436         <strong>Parameters:</strong>\r
437         <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>\r
438         <strong>Returns:</strong>\r
439         <ul>\r
440             <li><code>Array</code><div class="sub-desc">An array of the unique values</div></li>\r
441         </ul>\r
442     </div>\r
443                 </div>\r
444                         </div>\r
445         </td>\r
446         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#collect" href="output/Ext.data.Store.html#collect">Store</a></td>\r
447     </tr>\r
448         <tr class="method-row inherited alt expandable">\r
449         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
450         <td class="sig">\r
451         <a id="Ext.data.SimpleStore-commitChanges"></a>\r
452             <b>commitChanges</b>() : void            <div class="mdesc">\r
453                         <div class="short">Commit all Records with outstanding changes. To handle updates for changes, subscribe to the
454 Store's "update" event, ...</div>\r
455             <div class="long">\r
456                 Commit all Records with outstanding changes. To handle updates for changes, subscribe to the
457 Store's "update" event, and perform updating when the third parameter is Ext.data.Record.COMMIT.    <div class="mdetail-params">\r
458         <strong>Parameters:</strong>\r
459         <ul><li>None.</li>        </ul>\r
460         <strong>Returns:</strong>\r
461         <ul>\r
462             <li><code>void</code></li>\r
463         </ul>\r
464     </div>\r
465                 </div>\r
466                         </div>\r
467         </td>\r
468         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#commitChanges" href="output/Ext.data.Store.html#commitChanges">Store</a></td>\r
469     </tr>\r
470         <tr class="method-row inherited expandable">\r
471         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
472         <td class="sig">\r
473         <a id="Ext.data.SimpleStore-each"></a>\r
474             <b>each</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
475                         <div class="short">Calls the specified function for each of the Records in the cache.</div>\r
476             <div class="long">\r
477                 Calls the specified function for each of the Records in the cache.    <div class="mdetail-params">\r
478         <strong>Parameters:</strong>\r
479         <ul><li><code>fn</code> : Function<div class="sub-desc">The function to call. The Record is passed as the first parameter.
480 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 Record).</div></li>        </ul>\r
481         <strong>Returns:</strong>\r
482         <ul>\r
483             <li><code>void</code></li>\r
484         </ul>\r
485     </div>\r
486                 </div>\r
487                         </div>\r
488         </td>\r
489         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#each" href="output/Ext.data.Store.html#each">Store</a></td>\r
490     </tr>\r
491         <tr class="method-row inherited alt expandable">\r
492         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
493         <td class="sig">\r
494         <a id="Ext.data.SimpleStore-filter"></a>\r
495             <b>filter</b>(&nbsp;<code>String field</code>, <code>String/RegExp value</code>, <span class="optional" title="Optional">[<code>Boolean anyMatch</code>]</span>, <span class="optional" title="Optional">[<code>Boolean caseSensitive</code>]</span>&nbsp;) : void            <div class="mdesc">\r
496                         <div class="short">Filter the records by a specified property.</div>\r
497             <div class="long">\r
498                 Filter the records by a specified property.    <div class="mdetail-params">\r
499         <strong>Parameters:</strong>\r
500         <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
501 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>\r
502         <strong>Returns:</strong>\r
503         <ul>\r
504             <li><code>void</code></li>\r
505         </ul>\r
506     </div>\r
507                 </div>\r
508                         </div>\r
509         </td>\r
510         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#filter" href="output/Ext.data.Store.html#filter">Store</a></td>\r
511     </tr>\r
512         <tr class="method-row inherited expandable">\r
513         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
514         <td class="sig">\r
515         <a id="Ext.data.SimpleStore-filterBy"></a>\r
516             <b>filterBy</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
517                         <div class="short">Filter by a function. The specified function will be called for each
518 Record in this Store. If the function returns tr...</div>\r
519             <div class="long">\r
520                 Filter by a function. The specified function will be called for each
521 Record in this Store. If the function returns <tt>true</tt> the Record is included,
522 otherwise it is filtered out.    <div class="mdetail-params">\r
523         <strong>Parameters:</strong>\r
524         <ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called. It will be passed the following parameters:<ul>
525 <li><b>record</b> : Ext.data.Record<p class="sub-desc">The <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">record</a>
526 to test for filtering. Access field values using <a ext:cls="Ext.data.Record" ext:member="get" href="output/Ext.data.Record.html#get">Ext.data.Record.get</a>.</p></li>
527 <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
528 </ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to this)</div></li>        </ul>\r
529         <strong>Returns:</strong>\r
530         <ul>\r
531             <li><code>void</code></li>\r
532         </ul>\r
533     </div>\r
534                 </div>\r
535                         </div>\r
536         </td>\r
537         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#filterBy" href="output/Ext.data.Store.html#filterBy">Store</a></td>\r
538     </tr>\r
539         <tr class="method-row inherited alt expandable">\r
540         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
541         <td class="sig">\r
542         <a id="Ext.data.SimpleStore-find"></a>\r
543             <b>find</b>(&nbsp;<code>String property</code>, <code>String/RegExp value</code>, <span class="optional" title="Optional">[<code>Number startIndex</code>]</span>, <span class="optional" title="Optional">[<code>Boolean anyMatch</code>]</span>, <span class="optional" title="Optional">[<code>Boolean caseSensitive</code>]</span>&nbsp;) : Number            <div class="mdesc">\r
544                         <div class="short">Finds the index of the first matching record in this store by a specific property/value.</div>\r
545             <div class="long">\r
546                 Finds the index of the first matching record in this store by a specific property/value.    <div class="mdetail-params">\r
547         <strong>Parameters:</strong>\r
548         <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
549 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>\r
550         <strong>Returns:</strong>\r
551         <ul>\r
552             <li><code>Number</code><div class="sub-desc">The matched index or -1</div></li>\r
553         </ul>\r
554     </div>\r
555                 </div>\r
556                         </div>\r
557         </td>\r
558         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#find" href="output/Ext.data.Store.html#find">Store</a></td>\r
559     </tr>\r
560         <tr class="method-row inherited expandable">\r
561         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
562         <td class="sig">\r
563         <a id="Ext.data.SimpleStore-findBy"></a>\r
564             <b>findBy</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Number startIndex</code>]</span>&nbsp;) : Number            <div class="mdesc">\r
565                         <div class="short">Find the index of the first matching Record in this Store by a function.
566 If the function returns true it is considere...</div>\r
567             <div class="long">\r
568                 Find the index of the first matching Record in this Store by a function.
569 If the function returns <tt>true</tt> it is considered a match.    <div class="mdetail-params">\r
570         <strong>Parameters:</strong>\r
571         <ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called. It will be passed the following parameters:<ul>
572 <li><b>record</b> : Ext.data.Record<p class="sub-desc">The <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">record</a>
573 to test for filtering. Access field values using <a ext:cls="Ext.data.Record" ext:member="get" href="output/Ext.data.Record.html#get">Ext.data.Record.get</a>.</p></li>
574 <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
575 </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>\r
576         <strong>Returns:</strong>\r
577         <ul>\r
578             <li><code>Number</code><div class="sub-desc">The matched index or -1</div></li>\r
579         </ul>\r
580     </div>\r
581                 </div>\r
582                         </div>\r
583         </td>\r
584         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#findBy" href="output/Ext.data.Store.html#findBy">Store</a></td>\r
585     </tr>\r
586         <tr class="method-row inherited alt expandable">\r
587         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
588         <td class="sig">\r
589         <a id="Ext.data.SimpleStore-fireEvent"></a>\r
590             <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">\r
591                         <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
592             <div class="long">\r
593                 Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">\r
594         <strong>Parameters:</strong>\r
595         <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li>        </ul>\r
596         <strong>Returns:</strong>\r
597         <ul>\r
598             <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
599         </ul>\r
600     </div>\r
601                 </div>\r
602                         </div>\r
603         </td>\r
604         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
605     </tr>\r
606         <tr class="method-row inherited expandable">\r
607         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
608         <td class="sig">\r
609         <a id="Ext.data.SimpleStore-getAt"></a>\r
610             <b>getAt</b>(&nbsp;<code>Number index</code>&nbsp;) : Ext.data.Record            <div class="mdesc">\r
611                         <div class="short">Get the Record at the specified index.</div>\r
612             <div class="long">\r
613                 Get the Record at the specified index.    <div class="mdetail-params">\r
614         <strong>Parameters:</strong>\r
615         <ul><li><code>index</code> : Number<div class="sub-desc">The index of the Record to find.</div></li>        </ul>\r
616         <strong>Returns:</strong>\r
617         <ul>\r
618             <li><code>Ext.data.Record</code><div class="sub-desc">The Record at the passed index. Returns undefined if not found.</div></li>\r
619         </ul>\r
620     </div>\r
621                 </div>\r
622                         </div>\r
623         </td>\r
624         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getAt" href="output/Ext.data.Store.html#getAt">Store</a></td>\r
625     </tr>\r
626         <tr class="method-row inherited alt expandable">\r
627         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
628         <td class="sig">\r
629         <a id="Ext.data.SimpleStore-getById"></a>\r
630             <b>getById</b>(&nbsp;<code>String id</code>&nbsp;) : Ext.data.Record            <div class="mdesc">\r
631                         <div class="short">Get the Record with the specified id.</div>\r
632             <div class="long">\r
633                 Get the Record with the specified id.    <div class="mdetail-params">\r
634         <strong>Parameters:</strong>\r
635         <ul><li><code>id</code> : String<div class="sub-desc">The id of the Record to find.</div></li>        </ul>\r
636         <strong>Returns:</strong>\r
637         <ul>\r
638             <li><code>Ext.data.Record</code><div class="sub-desc">The Record with the passed id. Returns undefined if not found.</div></li>\r
639         </ul>\r
640     </div>\r
641                 </div>\r
642                         </div>\r
643         </td>\r
644         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getById" href="output/Ext.data.Store.html#getById">Store</a></td>\r
645     </tr>\r
646         <tr class="method-row inherited expandable">\r
647         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
648         <td class="sig">\r
649         <a id="Ext.data.SimpleStore-getCount"></a>\r
650             <b>getCount</b>() : Number            <div class="mdesc">\r
651                         <div class="short">Gets the number of cached records.
652 If using paging, this may not be the total size of the dataset. If the data object...</div>\r
653             <div class="long">\r
654                 Gets the number of cached records.
655 <p>If using paging, this may not be the total size of the dataset. If the data object
656 used by the Reader contains the dataset size, then the <a ext:cls="Ext.data.Store" ext:member="getTotalCount" href="output/Ext.data.Store.html#getTotalCount">getTotalCount</a> function returns
657 the dataset size.</p>    <div class="mdetail-params">\r
658         <strong>Parameters:</strong>\r
659         <ul><li>None.</li>        </ul>\r
660         <strong>Returns:</strong>\r
661         <ul>\r
662             <li><code>Number</code><div class="sub-desc">The number of Records in the Store's cache.</div></li>\r
663         </ul>\r
664     </div>\r
665                 </div>\r
666                         </div>\r
667         </td>\r
668         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getCount" href="output/Ext.data.Store.html#getCount">Store</a></td>\r
669     </tr>\r
670         <tr class="method-row inherited alt expandable">\r
671         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
672         <td class="sig">\r
673         <a id="Ext.data.SimpleStore-getModifiedRecords"></a>\r
674             <b>getModifiedRecords</b>() : Ext.data.Record[]            <div class="mdesc">\r
675                         <div class="short">Gets all records modified since the last commit.  Modified records are persisted across load operations
676 (e.g., during...</div>\r
677             <div class="long">\r
678                 Gets all records modified since the last commit.  Modified records are persisted across load operations
679 (e.g., during paging).    <div class="mdetail-params">\r
680         <strong>Parameters:</strong>\r
681         <ul><li>None.</li>        </ul>\r
682         <strong>Returns:</strong>\r
683         <ul>\r
684             <li><code>Ext.data.Record[]</code><div class="sub-desc">An array of Records containing outstanding modifications.</div></li>\r
685         </ul>\r
686     </div>\r
687                 </div>\r
688                         </div>\r
689         </td>\r
690         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getModifiedRecords" href="output/Ext.data.Store.html#getModifiedRecords">Store</a></td>\r
691     </tr>\r
692         <tr class="method-row inherited expandable">\r
693         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
694         <td class="sig">\r
695         <a id="Ext.data.SimpleStore-getRange"></a>\r
696             <b>getRange</b>(&nbsp;<span class="optional" title="Optional">[<code>Number startIndex</code>]</span>, <span class="optional" title="Optional">[<code>Number endIndex</code>]</span>&nbsp;) : Ext.data.Record[]            <div class="mdesc">\r
697                         <div class="short">Returns a range of Records between specified indices.</div>\r
698             <div class="long">\r
699                 Returns a range of Records between specified indices.    <div class="mdetail-params">\r
700         <strong>Parameters:</strong>\r
701         <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>\r
702         <strong>Returns:</strong>\r
703         <ul>\r
704             <li><code>Ext.data.Record[]</code><div class="sub-desc">An array of Records</div></li>\r
705         </ul>\r
706     </div>\r
707                 </div>\r
708                         </div>\r
709         </td>\r
710         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getRange" href="output/Ext.data.Store.html#getRange">Store</a></td>\r
711     </tr>\r
712         <tr class="method-row inherited alt expandable">\r
713         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
714         <td class="sig">\r
715         <a id="Ext.data.SimpleStore-getSortState"></a>\r
716             <b>getSortState</b>() : Object            <div class="mdesc">\r
717                         <div class="short">Returns an object describing the current sort state of this Store.</div>\r
718             <div class="long">\r
719                 Returns an object describing the current sort state of this Store.    <div class="mdetail-params">\r
720         <strong>Parameters:</strong>\r
721         <ul><li>None.</li>        </ul>\r
722         <strong>Returns:</strong>\r
723         <ul>\r
724             <li><code>Object</code><div class="sub-desc">The sort state of the Store. An object with two properties:<ul> <li><b>field : String<p class="sub-desc">The name of the field by which the Records are sorted.</p></li> <li><b>direction : String<p class="sub-desc">The sort order, "ASC" or "DESC" (case-sensitive).</p></li> </ul></div></li>\r
725         </ul>\r
726     </div>\r
727                 </div>\r
728                         </div>\r
729         </td>\r
730         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getSortState" href="output/Ext.data.Store.html#getSortState">Store</a></td>\r
731     </tr>\r
732         <tr class="method-row inherited expandable">\r
733         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
734         <td class="sig">\r
735         <a id="Ext.data.SimpleStore-getTotalCount"></a>\r
736             <b>getTotalCount</b>() : Number            <div class="mdesc">\r
737                         <div class="short">Gets the total number of records in the dataset as returned by the server.
738 If using paging, for this to be accurate, ...</div>\r
739             <div class="long">\r
740                 Gets the total number of records in the dataset as returned by the server.
741 <p>If using paging, for this to be accurate, the data object used by the Reader must contain
742 the dataset size. For remote data sources, this is provided by a query on the server.</p>    <div class="mdetail-params">\r
743         <strong>Parameters:</strong>\r
744         <ul><li>None.</li>        </ul>\r
745         <strong>Returns:</strong>\r
746         <ul>\r
747             <li><code>Number</code><div class="sub-desc">The number of Records as specified in the data object passed to the Reader by the Proxy <p><b>This value is not updated when changing the contents of the Store locally.</b></p></div></li>\r
748         </ul>\r
749     </div>\r
750                 </div>\r
751                         </div>\r
752         </td>\r
753         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getTotalCount" href="output/Ext.data.Store.html#getTotalCount">Store</a></td>\r
754     </tr>\r
755         <tr class="method-row inherited alt expandable">\r
756         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
757         <td class="sig">\r
758         <a id="Ext.data.SimpleStore-hasListener"></a>\r
759             <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">\r
760                         <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
761             <div class="long">\r
762                 Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">\r
763         <strong>Parameters:</strong>\r
764         <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>\r
765         <strong>Returns:</strong>\r
766         <ul>\r
767             <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
768         </ul>\r
769     </div>\r
770                 </div>\r
771                         </div>\r
772         </td>\r
773         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
774     </tr>\r
775         <tr class="method-row inherited expandable">\r
776         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
777         <td class="sig">\r
778         <a id="Ext.data.SimpleStore-indexOf"></a>\r
779             <b>indexOf</b>(&nbsp;<code>Ext.data.Record record</code>&nbsp;) : Number            <div class="mdesc">\r
780                         <div class="short">Get the index within the cache of the passed Record.</div>\r
781             <div class="long">\r
782                 Get the index within the cache of the passed Record.    <div class="mdetail-params">\r
783         <strong>Parameters:</strong>\r
784         <ul><li><code>record</code> : Ext.data.Record<div class="sub-desc">The Ext.data.Record object to find.</div></li>        </ul>\r
785         <strong>Returns:</strong>\r
786         <ul>\r
787             <li><code>Number</code><div class="sub-desc">The index of the passed Record. Returns -1 if not found.</div></li>\r
788         </ul>\r
789     </div>\r
790                 </div>\r
791                         </div>\r
792         </td>\r
793         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#indexOf" href="output/Ext.data.Store.html#indexOf">Store</a></td>\r
794     </tr>\r
795         <tr class="method-row inherited alt expandable">\r
796         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
797         <td class="sig">\r
798         <a id="Ext.data.SimpleStore-indexOfId"></a>\r
799             <b>indexOfId</b>(&nbsp;<code>String id</code>&nbsp;) : Number            <div class="mdesc">\r
800                         <div class="short">Get the index within the cache of the Record with the passed id.</div>\r
801             <div class="long">\r
802                 Get the index within the cache of the Record with the passed id.    <div class="mdetail-params">\r
803         <strong>Parameters:</strong>\r
804         <ul><li><code>id</code> : String<div class="sub-desc">The id of the Record to find.</div></li>        </ul>\r
805         <strong>Returns:</strong>\r
806         <ul>\r
807             <li><code>Number</code><div class="sub-desc">The index of the Record. Returns -1 if not found.</div></li>\r
808         </ul>\r
809     </div>\r
810                 </div>\r
811                         </div>\r
812         </td>\r
813         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#indexOfId" href="output/Ext.data.Store.html#indexOfId">Store</a></td>\r
814     </tr>\r
815         <tr class="method-row inherited expandable">\r
816         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
817         <td class="sig">\r
818         <a id="Ext.data.SimpleStore-insert"></a>\r
819             <b>insert</b>(&nbsp;<code>Number index</code>, <code>Ext.data.Record[] records</code>&nbsp;) : void            <div class="mdesc">\r
820                         <div class="short">Inserts Records into the Store at the given index and fires the <a ext:cls="Ext.data.Store" ext:member="add" href="output/Ext.data.Store.html#add">add</a> event.</div>\r
821             <div class="long">\r
822                 Inserts Records into the Store at the given index and fires the <a ext:cls="Ext.data.Store" ext:member="add" href="output/Ext.data.Store.html#add">add</a> event.    <div class="mdetail-params">\r
823         <strong>Parameters:</strong>\r
824         <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>\r
825         <strong>Returns:</strong>\r
826         <ul>\r
827             <li><code>void</code></li>\r
828         </ul>\r
829     </div>\r
830                 </div>\r
831                         </div>\r
832         </td>\r
833         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#insert" href="output/Ext.data.Store.html#insert">Store</a></td>\r
834     </tr>\r
835         <tr class="method-row inherited alt expandable">\r
836         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
837         <td class="sig">\r
838         <a id="Ext.data.SimpleStore-isFiltered"></a>\r
839             <b>isFiltered</b>() : Boolean            <div class="mdesc">\r
840                         <div class="short">Returns true if this store is currently filtered</div>\r
841             <div class="long">\r
842                 Returns true if this store is currently filtered    <div class="mdetail-params">\r
843         <strong>Parameters:</strong>\r
844         <ul><li>None.</li>        </ul>\r
845         <strong>Returns:</strong>\r
846         <ul>\r
847             <li><code>Boolean</code></li>\r
848         </ul>\r
849     </div>\r
850                 </div>\r
851                         </div>\r
852         </td>\r
853         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#isFiltered" href="output/Ext.data.Store.html#isFiltered">Store</a></td>\r
854     </tr>\r
855         <tr class="method-row inherited expandable">\r
856         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
857         <td class="sig">\r
858         <a id="Ext.data.SimpleStore-load"></a>\r
859             <b>load</b>(&nbsp;<code>Object options</code>&nbsp;) : Boolean            <div class="mdesc">\r
860                         <div class="short">Loads the Record cache from the configured Proxy using the configured Reader.
861 If using remote paging, then the first ...</div>\r
862             <div class="long">\r
863                 Loads the Record cache from the configured Proxy using the configured Reader.
864 <p>If using remote paging, then the first load call must specify the <tt>start</tt>
865 and <tt>limit</tt> properties in the options.params property to establish the initial
866 position within the dataset, and the number of Records to cache on each read from the Proxy.</p>
867 <p><b>It is important to note that for remote data sources, loading is asynchronous,
868 and this call will return before the new data has been loaded. Perform any post-processing
869 in a callback function, or in a "load" event handler.</b></p>    <div class="mdetail-params">\r
870         <strong>Parameters:</strong>\r
871         <ul><li><code>options</code> : Object<div class="sub-desc">An object containing properties which control loading options:<ul>
872 <li><b>params</b> :Object<p class="sub-desc">An object containing properties to pass as HTTP parameters to a remote data source.</p></li>
873 <li><b>callback</b> : Function<p class="sub-desc">A function to be called after the Records have been loaded. The callback is
874 passed the following arguments:<ul>
875 <li>r : Ext.data.Record[]</li>
876 <li>options: Options object from the load call</li>
877 <li>success: Boolean success indicator</li></ul></p></li>
878 <li><b>scope</b> : Object<p class="sub-desc">Scope with which to call the callback (defaults to the Store object)</p></li>
879 <li><b>add</b> : Boolean<p class="sub-desc">Indicator to append loaded records rather than replace the current cache.</p></li>
880 </ul></div></li>        </ul>\r
881         <strong>Returns:</strong>\r
882         <ul>\r
883             <li><code>Boolean</code><div class="sub-desc">Whether the load fired (if beforeload failed).</div></li>\r
884         </ul>\r
885     </div>\r
886                 </div>\r
887                         </div>\r
888         </td>\r
889         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#load" href="output/Ext.data.Store.html#load">Store</a></td>\r
890     </tr>\r
891         <tr class="method-row inherited alt expandable">\r
892         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
893         <td class="sig">\r
894         <a id="Ext.data.SimpleStore-loadData"></a>\r
895             <b>loadData</b>(&nbsp;<code>Object data</code>, <span class="optional" title="Optional">[<code>Boolean add</code>]</span>&nbsp;) : void            <div class="mdesc">\r
896                         <div class="short">Loads data from a passed data block and fires the load event. A Reader which understands the format of the data
897 must ...</div>\r
898             <div class="long">\r
899                 Loads data from a passed data block and fires the <a ext:cls="Ext.data.Store" ext:member="load" href="output/Ext.data.Store.html#load">load</a> event. A Reader which understands the format of the data
900 must have been configured in the constructor.    <div class="mdetail-params">\r
901         <strong>Parameters:</strong>\r
902         <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
903 is dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.</div></li><li><code>add</code> : Boolean<div class="sub-desc">(Optional) True to add the new Records rather than replace the existing cache. <b>Remember that
904 Records in a Store are keyed by their <a ext:cls="Ext.data.Record" ext:member="id" href="output/Ext.data.Record.html#id">id</a>, so added Records with ids which are already present in
905 the Store will <i>replace</i> existing Records. Records with new, unique ids will be added.</b></div></li>        </ul>\r
906         <strong>Returns:</strong>\r
907         <ul>\r
908             <li><code>void</code></li>\r
909         </ul>\r
910     </div>\r
911                 </div>\r
912                         </div>\r
913         </td>\r
914         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#loadData" href="output/Ext.data.Store.html#loadData">Store</a></td>\r
915     </tr>\r
916         <tr class="method-row inherited expandable">\r
917         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
918         <td class="sig">\r
919         <a id="Ext.data.SimpleStore-on"></a>\r
920             <b>on</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">\r
921                         <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
922             <div class="long">\r
923                 Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">\r
924         <strong>Parameters:</strong>\r
925         <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 in which to execute the handler
926 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>\r
927         <strong>Returns:</strong>\r
928         <ul>\r
929             <li><code>void</code></li>\r
930         </ul>\r
931     </div>\r
932                 </div>\r
933                         </div>\r
934         </td>\r
935         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
936     </tr>\r
937         <tr class="method-row inherited alt expandable">\r
938         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
939         <td class="sig">\r
940         <a id="Ext.data.SimpleStore-purgeListeners"></a>\r
941             <b>purgeListeners</b>() : void            <div class="mdesc">\r
942                         <div class="short">Removes all listeners for this object</div>\r
943             <div class="long">\r
944                 Removes all listeners for this object    <div class="mdetail-params">\r
945         <strong>Parameters:</strong>\r
946         <ul><li>None.</li>        </ul>\r
947         <strong>Returns:</strong>\r
948         <ul>\r
949             <li><code>void</code></li>\r
950         </ul>\r
951     </div>\r
952                 </div>\r
953                         </div>\r
954         </td>\r
955         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
956     </tr>\r
957         <tr class="method-row inherited expandable">\r
958         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
959         <td class="sig">\r
960         <a id="Ext.data.SimpleStore-query"></a>\r
961             <b>query</b>(&nbsp;<code>String field</code>, <code>String/RegExp value</code>, <span class="optional" title="Optional">[<code>Boolean anyMatch</code>]</span>, <span class="optional" title="Optional">[<code>Boolean caseSensitive</code>]</span>&nbsp;) : MixedCollection            <div class="mdesc">\r
962                         <div class="short">Query the records by a specified property.</div>\r
963             <div class="long">\r
964                 Query the records by a specified property.    <div class="mdetail-params">\r
965         <strong>Parameters:</strong>\r
966         <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
967 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>\r
968         <strong>Returns:</strong>\r
969         <ul>\r
970             <li><code>MixedCollection</code><div class="sub-desc">Returns an Ext.util.MixedCollection of the matched records</div></li>\r
971         </ul>\r
972     </div>\r
973                 </div>\r
974                         </div>\r
975         </td>\r
976         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#query" href="output/Ext.data.Store.html#query">Store</a></td>\r
977     </tr>\r
978         <tr class="method-row inherited alt expandable">\r
979         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
980         <td class="sig">\r
981         <a id="Ext.data.SimpleStore-queryBy"></a>\r
982             <b>queryBy</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : MixedCollection            <div class="mdesc">\r
983                         <div class="short">Query the cached records in this Store using a filtering function. The specified function
984 will be called with each re...</div>\r
985             <div class="long">\r
986                 Query the cached records in this Store using a filtering function. The specified function
987 will be called with each record in this Store. If the function returns <tt>true</tt> the record is
988 included in the results.    <div class="mdetail-params">\r
989         <strong>Parameters:</strong>\r
990         <ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called. It will be passed the following parameters:<ul>
991 <li><b>record</b> : Ext.data.Record<p class="sub-desc">The <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">record</a>
992 to test for filtering. Access field values using <a ext:cls="Ext.data.Record" ext:member="get" href="output/Ext.data.Record.html#get">Ext.data.Record.get</a>.</p></li>
993 <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
994 </ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to this)</div></li>        </ul>\r
995         <strong>Returns:</strong>\r
996         <ul>\r
997             <li><code>MixedCollection</code><div class="sub-desc">Returns an Ext.util.MixedCollection of the matched records</div></li>\r
998         </ul>\r
999     </div>\r
1000                 </div>\r
1001                         </div>\r
1002         </td>\r
1003         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#queryBy" href="output/Ext.data.Store.html#queryBy">Store</a></td>\r
1004     </tr>\r
1005         <tr class="method-row inherited expandable">\r
1006         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1007         <td class="sig">\r
1008         <a id="Ext.data.SimpleStore-rejectChanges"></a>\r
1009             <b>rejectChanges</b>() : void            <div class="mdesc">\r
1010                         <div class="short">Cancel outstanding changes on all changed records.</div>\r
1011             <div class="long">\r
1012                 Cancel outstanding changes on all changed records.    <div class="mdetail-params">\r
1013         <strong>Parameters:</strong>\r
1014         <ul><li>None.</li>        </ul>\r
1015         <strong>Returns:</strong>\r
1016         <ul>\r
1017             <li><code>void</code></li>\r
1018         </ul>\r
1019     </div>\r
1020                 </div>\r
1021                         </div>\r
1022         </td>\r
1023         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#rejectChanges" href="output/Ext.data.Store.html#rejectChanges">Store</a></td>\r
1024     </tr>\r
1025         <tr class="method-row inherited alt expandable">\r
1026         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1027         <td class="sig">\r
1028         <a id="Ext.data.SimpleStore-relayEvents"></a>\r
1029             <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">\r
1030                         <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
1031             <div class="long">\r
1032                 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">\r
1033         <strong>Parameters:</strong>\r
1034         <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>\r
1035         <strong>Returns:</strong>\r
1036         <ul>\r
1037             <li><code>void</code></li>\r
1038         </ul>\r
1039     </div>\r
1040                 </div>\r
1041                         </div>\r
1042         </td>\r
1043         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
1044     </tr>\r
1045         <tr class="method-row inherited expandable">\r
1046         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1047         <td class="sig">\r
1048         <a id="Ext.data.SimpleStore-reload"></a>\r
1049             <b>reload</b>(&nbsp;<span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">\r
1050                         <div class="short">Reloads the Record cache from the configured Proxy using the configured Reader and
1051 the options from the last load ope...</div>\r
1052             <div class="long">\r
1053                 <p>Reloads the Record cache from the configured Proxy using the configured Reader and
1054 the options from the last load operation performed.</p>
1055 <p><b>It is important to note that for remote data sources, loading is asynchronous,
1056 and this call will return before the new data has been loaded. Perform any post-processing
1057 in a callback function, or in a "load" event handler.</b></p>    <div class="mdetail-params">\r
1058         <strong>Parameters:</strong>\r
1059         <ul><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing loading options which may override the options
1060 used in the last load operation. See <a ext:cls="Ext.data.Store" ext:member="load" href="output/Ext.data.Store.html#load">load</a> for details (defaults to null, in which case
1061 the most recently used options are reused).</div></li>        </ul>\r
1062         <strong>Returns:</strong>\r
1063         <ul>\r
1064             <li><code>void</code></li>\r
1065         </ul>\r
1066     </div>\r
1067                 </div>\r
1068                         </div>\r
1069         </td>\r
1070         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#reload" href="output/Ext.data.Store.html#reload">Store</a></td>\r
1071     </tr>\r
1072         <tr class="method-row inherited alt expandable">\r
1073         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1074         <td class="sig">\r
1075         <a id="Ext.data.SimpleStore-remove"></a>\r
1076             <b>remove</b>(&nbsp;<code>Ext.data.Record record</code>&nbsp;) : void            <div class="mdesc">\r
1077                         <div class="short">Remove a Record from the Store and fires the <a ext:cls="Ext.data.Store" ext:member="remove" href="output/Ext.data.Store.html#remove">remove</a> event.</div>\r
1078             <div class="long">\r
1079                 Remove a Record from the Store and fires the <a ext:cls="Ext.data.Store" ext:member="remove" href="output/Ext.data.Store.html#remove">remove</a> event.    <div class="mdetail-params">\r
1080         <strong>Parameters:</strong>\r
1081         <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>\r
1082         <strong>Returns:</strong>\r
1083         <ul>\r
1084             <li><code>void</code></li>\r
1085         </ul>\r
1086     </div>\r
1087                 </div>\r
1088                         </div>\r
1089         </td>\r
1090         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#remove" href="output/Ext.data.Store.html#remove">Store</a></td>\r
1091     </tr>\r
1092         <tr class="method-row inherited expandable">\r
1093         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1094         <td class="sig">\r
1095         <a id="Ext.data.SimpleStore-removeAll"></a>\r
1096             <b>removeAll</b>() : void            <div class="mdesc">\r
1097                         <div class="short">Remove all Records from the Store and fires the <a ext:cls="Ext.data.Store" ext:member="clear" href="output/Ext.data.Store.html#clear">clear</a> event.</div>\r
1098             <div class="long">\r
1099                 Remove all Records from the Store and fires the <a ext:cls="Ext.data.Store" ext:member="clear" href="output/Ext.data.Store.html#clear">clear</a> event.    <div class="mdetail-params">\r
1100         <strong>Parameters:</strong>\r
1101         <ul><li>None.</li>        </ul>\r
1102         <strong>Returns:</strong>\r
1103         <ul>\r
1104             <li><code>void</code></li>\r
1105         </ul>\r
1106     </div>\r
1107                 </div>\r
1108                         </div>\r
1109         </td>\r
1110         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#removeAll" href="output/Ext.data.Store.html#removeAll">Store</a></td>\r
1111     </tr>\r
1112         <tr class="method-row inherited alt expandable">\r
1113         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1114         <td class="sig">\r
1115         <a id="Ext.data.SimpleStore-removeAt"></a>\r
1116             <b>removeAt</b>(&nbsp;<code>Number index</code>&nbsp;) : void            <div class="mdesc">\r
1117                         <div class="short">Remove a Record from the Store at the specified index. Fires the <a ext:cls="Ext.data.Store" ext:member="remove" href="output/Ext.data.Store.html#remove">remove</a> event.</div>\r
1118             <div class="long">\r
1119                 Remove a Record from the Store at the specified index. Fires the <a ext:cls="Ext.data.Store" ext:member="remove" href="output/Ext.data.Store.html#remove">remove</a> event.    <div class="mdetail-params">\r
1120         <strong>Parameters:</strong>\r
1121         <ul><li><code>index</code> : Number<div class="sub-desc">The index of the record to remove.</div></li>        </ul>\r
1122         <strong>Returns:</strong>\r
1123         <ul>\r
1124             <li><code>void</code></li>\r
1125         </ul>\r
1126     </div>\r
1127                 </div>\r
1128                         </div>\r
1129         </td>\r
1130         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#removeAt" href="output/Ext.data.Store.html#removeAt">Store</a></td>\r
1131     </tr>\r
1132         <tr class="method-row inherited expandable">\r
1133         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1134         <td class="sig">\r
1135         <a id="Ext.data.SimpleStore-removeListener"></a>\r
1136             <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
1137                         <div class="short">Removes a listener</div>\r
1138             <div class="long">\r
1139                 Removes a listener    <div class="mdetail-params">\r
1140         <strong>Parameters:</strong>\r
1141         <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 handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>\r
1142         <strong>Returns:</strong>\r
1143         <ul>\r
1144             <li><code>void</code></li>\r
1145         </ul>\r
1146     </div>\r
1147                 </div>\r
1148                         </div>\r
1149         </td>\r
1150         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
1151     </tr>\r
1152         <tr class="method-row inherited alt expandable">\r
1153         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1154         <td class="sig">\r
1155         <a id="Ext.data.SimpleStore-resumeEvents"></a>\r
1156             <b>resumeEvents</b>() : void            <div class="mdesc">\r
1157                         <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>\r
1158             <div class="long">\r
1159                 Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)    <div class="mdetail-params">\r
1160         <strong>Parameters:</strong>\r
1161         <ul><li>None.</li>        </ul>\r
1162         <strong>Returns:</strong>\r
1163         <ul>\r
1164             <li><code>void</code></li>\r
1165         </ul>\r
1166     </div>\r
1167                 </div>\r
1168                         </div>\r
1169         </td>\r
1170         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
1171     </tr>\r
1172         <tr class="method-row inherited expandable">\r
1173         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1174         <td class="sig">\r
1175         <a id="Ext.data.SimpleStore-setDefaultSort"></a>\r
1176             <b>setDefaultSort</b>(&nbsp;<code>String fieldName</code>, <span class="optional" title="Optional">[<code>String dir</code>]</span>&nbsp;) : void            <div class="mdesc">\r
1177                         <div class="short">Sets the default sort column and order to be used by the next load operation.</div>\r
1178             <div class="long">\r
1179                 Sets the default sort column and order to be used by the next load operation.    <div class="mdetail-params">\r
1180         <strong>Parameters:</strong>\r
1181         <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 "ASC")</div></li>        </ul>\r
1182         <strong>Returns:</strong>\r
1183         <ul>\r
1184             <li><code>void</code></li>\r
1185         </ul>\r
1186     </div>\r
1187                 </div>\r
1188                         </div>\r
1189         </td>\r
1190         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#setDefaultSort" href="output/Ext.data.Store.html#setDefaultSort">Store</a></td>\r
1191     </tr>\r
1192         <tr class="method-row inherited alt expandable">\r
1193         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1194         <td class="sig">\r
1195         <a id="Ext.data.SimpleStore-sort"></a>\r
1196             <b>sort</b>(&nbsp;<code>String fieldName</code>, <span class="optional" title="Optional">[<code>String dir</code>]</span>&nbsp;) : void            <div class="mdesc">\r
1197                         <div class="short">Sort the Records.
1198 If remote sorting is used, the sort is performed on the server, and the cache is
1199 reloaded. If local...</div>\r
1200             <div class="long">\r
1201                 Sort the Records.
1202 If remote sorting is used, the sort is performed on the server, and the cache is
1203 reloaded. If local sorting is used, the cache is sorted internally.    <div class="mdetail-params">\r
1204         <strong>Parameters:</strong>\r
1205         <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 "ASC")</div></li>        </ul>\r
1206         <strong>Returns:</strong>\r
1207         <ul>\r
1208             <li><code>void</code></li>\r
1209         </ul>\r
1210     </div>\r
1211                 </div>\r
1212                         </div>\r
1213         </td>\r
1214         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#sort" href="output/Ext.data.Store.html#sort">Store</a></td>\r
1215     </tr>\r
1216         <tr class="method-row inherited expandable">\r
1217         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1218         <td class="sig">\r
1219         <a id="Ext.data.SimpleStore-sum"></a>\r
1220             <b>sum</b>(&nbsp;<code>String property</code>, <code>Number start</code>, <code>Number end</code>&nbsp;) : Number            <div class="mdesc">\r
1221                         <div class="short">Sums the value of <i>property</i> for each record between start and end and returns the result.</div>\r
1222             <div class="long">\r
1223                 Sums the value of <i>property</i> for each record between start and end and returns the result.    <div class="mdetail-params">\r
1224         <strong>Parameters:</strong>\r
1225         <ul><li><code>property</code> : String<div class="sub-desc">A field on your records</div></li><li><code>start</code> : Number<div class="sub-desc">The record index to start at (defaults to 0)</div></li><li><code>end</code> : Number<div class="sub-desc">The last record index to include (defaults to length - 1)</div></li>        </ul>\r
1226         <strong>Returns:</strong>\r
1227         <ul>\r
1228             <li><code>Number</code><div class="sub-desc">The sum</div></li>\r
1229         </ul>\r
1230     </div>\r
1231                 </div>\r
1232                         </div>\r
1233         </td>\r
1234         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#sum" href="output/Ext.data.Store.html#sum">Store</a></td>\r
1235     </tr>\r
1236         <tr class="method-row inherited alt expandable">\r
1237         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1238         <td class="sig">\r
1239         <a id="Ext.data.SimpleStore-suspendEvents"></a>\r
1240             <b>suspendEvents</b>() : void            <div class="mdesc">\r
1241                         <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>\r
1242             <div class="long">\r
1243                 Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)    <div class="mdetail-params">\r
1244         <strong>Parameters:</strong>\r
1245         <ul><li>None.</li>        </ul>\r
1246         <strong>Returns:</strong>\r
1247         <ul>\r
1248             <li><code>void</code></li>\r
1249         </ul>\r
1250     </div>\r
1251                 </div>\r
1252                         </div>\r
1253         </td>\r
1254         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
1255     </tr>\r
1256         <tr class="method-row inherited expandable">\r
1257         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1258         <td class="sig">\r
1259         <a id="Ext.data.SimpleStore-un"></a>\r
1260             <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
1261                         <div class="short">Removes a listener (shorthand for removeListener)</div>\r
1262             <div class="long">\r
1263                 Removes a listener (shorthand for removeListener)    <div class="mdetail-params">\r
1264         <strong>Parameters:</strong>\r
1265         <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 handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>\r
1266         <strong>Returns:</strong>\r
1267         <ul>\r
1268             <li><code>void</code></li>\r
1269         </ul>\r
1270     </div>\r
1271                 </div>\r
1272                         </div>\r
1273         </td>\r
1274         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
1275     </tr>\r
1276             </table>
1277                 <a id="Ext.data.SimpleStore-events"></a>
1278         <h2>Public Events</h2>
1279                 <table cellspacing="0" class="member-table">
1280             <tr>
1281                 <th class="sig-header" colspan="2">Event</th>
1282                 <th class="msource-header">Defined By</th>
1283             </tr>
1284                 <tr class="event-row inherited expandable">\r
1285         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1286         <td class="sig">\r
1287         <a id="Ext.data.SimpleStore-add"></a>\r
1288             <b>add</b> : (&nbsp;<code>Store this</code>, <code>Ext.data.Record[] records</code>, <code>Number index</code>&nbsp;)            <div class="mdesc">\r
1289                         <div class="short">Fires when Records have been added to the Store</div>\r
1290             <div class="long">\r
1291                 Fires when Records have been added to the Store    <div class="mdetail-params">\r
1292         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1293         <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>\r
1294     </div>\r
1295                 </div>\r
1296                         </div>\r
1297         </td>\r
1298         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-add" href="output/Ext.data.Store.html#event-add">Store</a></td>\r
1299     </tr>\r
1300         <tr class="event-row inherited alt expandable">\r
1301         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1302         <td class="sig">\r
1303         <a id="Ext.data.SimpleStore-beforeload"></a>\r
1304             <b>beforeload</b> : (&nbsp;<code>Store this</code>, <code>Object options</code>&nbsp;)            <div class="mdesc">\r
1305                         <div class="short">Fires before a request is made for a new data object.  If the beforeload handler returns false
1306 the load action will b...</div>\r
1307             <div class="long">\r
1308                 Fires before a request is made for a new data object.  If the beforeload handler returns false
1309 the load action will be canceled.    <div class="mdetail-params">\r
1310         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1311         <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 ext:cls="Ext.data.Store" ext:member="load" href="output/Ext.data.Store.html#load">load</a> for details)</div></li>        </ul>\r
1312     </div>\r
1313                 </div>\r
1314                         </div>\r
1315         </td>\r
1316         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-beforeload" href="output/Ext.data.Store.html#event-beforeload">Store</a></td>\r
1317     </tr>\r
1318         <tr class="event-row inherited expandable">\r
1319         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1320         <td class="sig">\r
1321         <a id="Ext.data.SimpleStore-clear"></a>\r
1322             <b>clear</b> : (&nbsp;<code>Store this</code>&nbsp;)            <div class="mdesc">\r
1323                         <div class="short">Fires when the data cache has been cleared.</div>\r
1324             <div class="long">\r
1325                 Fires when the data cache has been cleared.    <div class="mdetail-params">\r
1326         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1327         <ul><li><code>this</code> : Store<div class="sub-desc"></div></li>        </ul>\r
1328     </div>\r
1329                 </div>\r
1330                         </div>\r
1331         </td>\r
1332         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-clear" href="output/Ext.data.Store.html#event-clear">Store</a></td>\r
1333     </tr>\r
1334         <tr class="event-row inherited alt expandable">\r
1335         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1336         <td class="sig">\r
1337         <a id="Ext.data.SimpleStore-datachanged"></a>\r
1338             <b>datachanged</b> : (&nbsp;<code>Store this</code>&nbsp;)            <div class="mdesc">\r
1339                         <div class="short">Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a 
1340 widget that ...</div>\r
1341             <div class="long">\r
1342                 Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a 
1343 widget that is using this Store as a Record cache should refresh its view.    <div class="mdetail-params">\r
1344         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1345         <ul><li><code>this</code> : Store<div class="sub-desc"></div></li>        </ul>\r
1346     </div>\r
1347                 </div>\r
1348                         </div>\r
1349         </td>\r
1350         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-datachanged" href="output/Ext.data.Store.html#event-datachanged">Store</a></td>\r
1351     </tr>\r
1352         <tr class="event-row inherited expandable">\r
1353         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1354         <td class="sig">\r
1355         <a id="Ext.data.SimpleStore-load"></a>\r
1356             <b>load</b> : (&nbsp;<code>Store this</code>, <code>Ext.data.Record[] records</code>, <code>Object options</code>&nbsp;)            <div class="mdesc">\r
1357                         <div class="short">Fires after a new set of Records has been loaded.</div>\r
1358             <div class="long">\r
1359                 Fires after a new set of Records has been loaded.    <div class="mdetail-params">\r
1360         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1361         <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 ext:cls="Ext.data.Store" ext:member="load" href="output/Ext.data.Store.html#load">load</a> for details)</div></li>        </ul>\r
1362     </div>\r
1363                 </div>\r
1364                         </div>\r
1365         </td>\r
1366         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-load" href="output/Ext.data.Store.html#event-load">Store</a></td>\r
1367     </tr>\r
1368         <tr class="event-row inherited alt expandable">\r
1369         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1370         <td class="sig">\r
1371         <a id="Ext.data.SimpleStore-loadexception"></a>\r
1372             <b>loadexception</b> : ()            <div class="mdesc">\r
1373                         <div class="short">Fires if an exception occurs in the Proxy during loading.
1374 Called with the signature of the Proxy's "loadexception" ev...</div>\r
1375             <div class="long">\r
1376                 Fires if an exception occurs in the Proxy during loading.
1377 Called with the signature of the Proxy's "loadexception" event.    <div class="mdetail-params">\r
1378         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1379         <ul><li>None.</li>        </ul>\r
1380     </div>\r
1381                 </div>\r
1382                         </div>\r
1383         </td>\r
1384         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-loadexception" href="output/Ext.data.Store.html#event-loadexception">Store</a></td>\r
1385     </tr>\r
1386         <tr class="event-row inherited expandable">\r
1387         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1388         <td class="sig">\r
1389         <a id="Ext.data.SimpleStore-metachange"></a>\r
1390             <b>metachange</b> : (&nbsp;<code>Store this</code>, <code>Object meta</code>&nbsp;)            <div class="mdesc">\r
1391                         <div class="short">Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders.</div>\r
1392             <div class="long">\r
1393                 Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders.    <div class="mdetail-params">\r
1394         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1395         <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>\r
1396     </div>\r
1397                 </div>\r
1398                         </div>\r
1399         </td>\r
1400         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-metachange" href="output/Ext.data.Store.html#event-metachange">Store</a></td>\r
1401     </tr>\r
1402         <tr class="event-row inherited alt expandable">\r
1403         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1404         <td class="sig">\r
1405         <a id="Ext.data.SimpleStore-remove"></a>\r
1406             <b>remove</b> : (&nbsp;<code>Store this</code>, <code>Ext.data.Record record</code>, <code>Number index</code>&nbsp;)            <div class="mdesc">\r
1407                         <div class="short">Fires when a Record has been removed from the Store</div>\r
1408             <div class="long">\r
1409                 Fires when a Record has been removed from the Store    <div class="mdetail-params">\r
1410         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1411         <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>\r
1412     </div>\r
1413                 </div>\r
1414                         </div>\r
1415         </td>\r
1416         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-remove" href="output/Ext.data.Store.html#event-remove">Store</a></td>\r
1417     </tr>\r
1418         <tr class="event-row inherited expandable">\r
1419         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1420         <td class="sig">\r
1421         <a id="Ext.data.SimpleStore-update"></a>\r
1422             <b>update</b> : (&nbsp;<code>Store this</code>, <code>Ext.data.Record record</code>, <code>String operation</code>&nbsp;)            <div class="mdesc">\r
1423                         <div class="short">Fires when a Record has been updated</div>\r
1424             <div class="long">\r
1425                 Fires when a Record has been updated    <div class="mdetail-params">\r
1426         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1427         <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:
1428 <pre><code>Ext.data.Record.EDIT
1429  Ext.data.Record.REJECT
1430  Ext.data.Record.COMMIT</code></pre></div></li>        </ul>\r
1431     </div>\r
1432                 </div>\r
1433                         </div>\r
1434         </td>\r
1435         <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-update" href="output/Ext.data.Store.html#event-update">Store</a></td>\r
1436     </tr>\r
1437             </table>
1438         
1439         </div>