Subversion Repositories eFlore/Applications.cel

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

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