docs/source/Store.html

   1 <html>
   2 <head>
   3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   4   <title>The source code</title>
   5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   7 </head>
   8 <body  onload="prettyPrint();">
   9     <pre class="prettyprint lang-js">/*!
  10  * Ext JS Library 3.2.1
  11  * Copyright(c) 2006-2010 Ext JS, Inc.
  12  * licensing@extjs.com
  13  * http://www.extjs.com/license
  14  */
  15 <div id="cls-Ext.data.Store"></div>/**
  16  * @class Ext.data.Store
  17  * @extends Ext.util.Observable
  18  * <p>The Store class encapsulates a client side cache of {@link Ext.data.Record Record}
  19  * objects which provide input data for Components such as the {@link Ext.grid.GridPanel GridPanel},
  20  * the {@link Ext.form.ComboBox ComboBox}, or the {@link Ext.DataView DataView}.</p>
  21  * <p><u>Retrieving Data</u></p>
  22  * <p>A Store object may access a data object using:<div class="mdetail-params"><ul>
  23  * <li>{@link #proxy configured implementation} of {@link Ext.data.DataProxy DataProxy}</li>
  24  * <li>{@link #data} to automatically pass in data</li>
  25  * <li>{@link #loadData} to manually pass in data</li>
  26  * </ul></div></p>
  27  * <p><u>Reading Data</u></p>
  28  * <p>A Store object has no inherent knowledge of the format of the data object (it could be
  29  * an Array, XML, or JSON). A Store object uses an appropriate {@link #reader configured implementation}
  30  * of a {@link Ext.data.DataReader DataReader} to create {@link Ext.data.Record Record} instances from the data
  31  * object.</p>
  32  * <p><u>Store Types</u></p>
  33  * <p>There are several implementations of Store available which are customized for use with
  34  * a specific DataReader implementation.  Here is an example using an ArrayStore which implicitly
  35  * creates a reader commensurate to an Array data object.</p>
  36  * <pre><code>
  37 var myStore = new Ext.data.ArrayStore({
  38     fields: ['fullname', 'first'],
  39     idIndex: 0 // id for each record will be the first element
  40 });
  41  * </code></pre>
  42  * <p>For custom implementations create a basic {@link Ext.data.Store} configured as needed:</p>
  43  * <pre><code>
  44 // create a {@link Ext.data.Record Record} constructor:
  45 var rt = Ext.data.Record.create([
  46     {name: 'fullname'},
  47     {name: 'first'}
  48 ]);
  49 var myStore = new Ext.data.Store({
  50     // explicitly create reader
  51     reader: new Ext.data.ArrayReader(
  52         {
  53             idIndex: 0  // id for each record will be the first element
  54         },
  55         rt // recordType
  56     )
  57 });
  58  * </code></pre>
  59  * <p>Load some data into store (note the data object is an array which corresponds to the reader):</p>
  60  * <pre><code>
  61 var myData = [
  62     [1, 'Fred Flintstone', 'Fred'],  // note that id for the record is the first element
  63     [2, 'Barney Rubble', 'Barney']
  64 ];
  65 myStore.loadData(myData);
  66  * </code></pre>
  67  * <p>Records are cached and made available through accessor functions.  An example of adding
  68  * a record to the store:</p>
  69  * <pre><code>
  70 var defaultData = {
  71     fullname: 'Full Name',
  72     first: 'First Name'
  73 };
  74 var recId = 100; // provide unique id for the record
  75 var r = new myStore.recordType(defaultData, ++recId); // create new record
  76 myStore.{@link #insert}(0, r); // insert a new record into the store (also see {@link #add})
  77  * </code></pre>
  78  * <p><u>Writing Data</u></p>
  79  * <p>And <b>new in Ext version 3</b>, use the new {@link Ext.data.DataWriter DataWriter} to create an automated, <a href="http://extjs.com/deploy/dev/examples/writer/writer.html">Writable Store</a>
  80  * along with <a href="http://extjs.com/deploy/dev/examples/restful/restful.html">RESTful features.</a>
  81  * @constructor
  82  * Creates a new Store.
  83  * @param {Object} config A config object containing the objects needed for the Store to access data,
  84  * and read the data into Records.
  85  * @xtype store
  86  */
  87 Ext.data.Store = Ext.extend(Ext.util.Observable, {
  88     <div id="cfg-Ext.data.Store-storeId"></div>/**
  89      * @cfg {String} storeId If passed, the id to use to register with the <b>{@link Ext.StoreMgr StoreMgr}</b>.
  90      * <p><b>Note</b>: if a (deprecated) <tt>{@link #id}</tt> is specified it will supersede the <tt>storeId</tt>
  91      * assignment.</p>
  92      */
  93     <div id="cfg-Ext.data.Store-url"></div>/**
  94      * @cfg {String} url If a <tt>{@link #proxy}</tt> is not specified the <tt>url</tt> will be used to
  95      * implicitly configure a {@link Ext.data.HttpProxy HttpProxy} if an <tt>url</tt> is specified.
  96      * Typically this option, or the <code>{@link #data}</code> option will be specified.
  97      */
  98     <div id="cfg-Ext.data.Store-autoLoad"></div>/**
  99      * @cfg {Boolean/Object} autoLoad If <tt>{@link #data}</tt> is not specified, and if <tt>autoLoad</tt>
 100      * is <tt>true</tt> or an <tt>Object</tt>, this store's {@link #load} method is automatically called
 101      * after creation. If the value of <tt>autoLoad</tt> is an <tt>Object</tt>, this <tt>Object</tt> will
 102      * be passed to the store's {@link #load} method.
 103      */
 104     <div id="cfg-Ext.data.Store-proxy"></div>/**
 105      * @cfg {Ext.data.DataProxy} proxy The {@link Ext.data.DataProxy DataProxy} object which provides
 106      * access to a data object.  See <code>{@link #url}</code>.
 107      */
 108     <div id="cfg-Ext.data.Store-data"></div>/**
 109      * @cfg {Array} data An inline data object readable by the <code>{@link #reader}</code>.
 110      * Typically this option, or the <code>{@link #url}</code> option will be specified.
 111      */
 112     <div id="cfg-Ext.data.Store-reader"></div>/**
 113      * @cfg {Ext.data.DataReader} reader The {@link Ext.data.DataReader Reader} object which processes the
 114      * data object and returns an Array of {@link Ext.data.Record} objects which are cached keyed by their
 115      * <b><tt>{@link Ext.data.Record#id id}</tt></b> property.
 116      */
 117     <div id="cfg-Ext.data.Store-writer"></div>/**
 118      * @cfg {Ext.data.DataWriter} writer
 119      * <p>The {@link Ext.data.DataWriter Writer} object which processes a record object for being written
 120      * to the server-side database.</p>
 121      * <br><p>When a writer is installed into a Store the {@link #add}, {@link #remove}, and {@link #update}
 122      * events on the store are monitored in order to remotely {@link #createRecords create records},
 123      * {@link #destroyRecord destroy records}, or {@link #updateRecord update records}.</p>
 124      * <br><p>The proxy for this store will relay any {@link #writexception} events to this store.</p>
 125      * <br><p>Sample implementation:
 126      * <pre><code>
 127 var writer = new {@link Ext.data.JsonWriter}({
 128     encode: true,
 129     writeAllFields: true // write all fields, not just those that changed
 130 });
 131
 132 // Typical Store collecting the Proxy, Reader and Writer together.
 133 var store = new Ext.data.Store({
 134     storeId: 'user',
 135     root: 'records',
 136     proxy: proxy,
 137     reader: reader,
 138     writer: writer,     // <-- plug a DataWriter into the store just as you would a Reader
 139     paramsAsHash: true,
 140     autoSave: false    // <-- false to delay executing create, update, destroy requests
 141                         //     until specifically told to do so.
 142 });
 143      * </code></pre></p>
 144      */
 145     writer : undefined,
 146     <div id="cfg-Ext.data.Store-baseParams"></div>/**
 147      * @cfg {Object} baseParams
 148      * <p>An object containing properties which are to be sent as parameters
 149      * for <i>every</i> HTTP request.</p>
 150      * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p>
 151      * <p><b>Note</b>: <code>baseParams</code> may be superseded by any <code>params</code>
 152      * specified in a <code>{@link #load}</code> request, see <code>{@link #load}</code>
 153      * for more details.</p>
 154      * This property may be modified after creation using the <code>{@link #setBaseParam}</code>
 155      * method.
 156      * @property
 157      */
 158     <div id="cfg-Ext.data.Store-sortInfo"></div>/**
 159      * @cfg {Object} sortInfo A config object to specify the sort order in the request of a Store's
 160      * {@link #load} operation.  Note that for local sorting, the <tt>direction</tt> property is
 161      * case-sensitive. See also {@link #remoteSort} and {@link #paramNames}.
 162      * For example:<pre><code>
 163 sortInfo: {
 164     field: 'fieldName',
 165     direction: 'ASC' // or 'DESC' (case sensitive for local sorting)
 166 }
 167 </code></pre>
 168      */
 169     <div id="cfg-Ext.data.Store-remoteSort"></div>/**
 170      * @cfg {boolean} remoteSort <tt>true</tt> if sorting is to be handled by requesting the <tt>{@link #proxy Proxy}</tt>
 171      * to provide a refreshed version of the data object in sorted order, as opposed to sorting the Record cache
 172      * in place (defaults to <tt>false</tt>).
 173      * <p>If <tt>remoteSort</tt> is <tt>true</tt>, then clicking on a {@link Ext.grid.Column Grid Column}'s
 174      * {@link Ext.grid.Column#header header} causes the current page to be requested from the server appending
 175      * the following two parameters to the <b><tt>{@link #load params}</tt></b>:<div class="mdetail-params"><ul>
 176      * <li><b><tt>sort</tt></b> : String<p class="sub-desc">The <tt>name</tt> (as specified in the Record's
 177      * {@link Ext.data.Field Field definition}) of the field to sort on.</p></li>
 178      * <li><b><tt>dir</tt></b> : String<p class="sub-desc">The direction of the sort, 'ASC' or 'DESC' (case-sensitive).</p></li>
 179      * </ul></div></p>
 180      */
 181     remoteSort : false,
 182
 183     <div id="cfg-Ext.data.Store-autoDestroy"></div>/**
 184      * @cfg {Boolean} autoDestroy <tt>true</tt> to destroy the store when the component the store is bound
 185      * to is destroyed (defaults to <tt>false</tt>).
 186      * <p><b>Note</b>: this should be set to true when using stores that are bound to only 1 component.</p>
 187      */
 188     autoDestroy : false,
 189
 190     <div id="cfg-Ext.data.Store-pruneModifiedRecords"></div>/**
 191      * @cfg {Boolean} pruneModifiedRecords <tt>true</tt> to clear all modified record information each time
 192      * the store is loaded or when a record is removed (defaults to <tt>false</tt>). See {@link #getModifiedRecords}
 193      * for the accessor method to retrieve the modified records.
 194      */
 195     pruneModifiedRecords : false,
 196
 197     <div id="prop-Ext.data.Store-lastOptions"></div>/**
 198      * Contains the last options object used as the parameter to the {@link #load} method. See {@link #load}
 199      * for the details of what this may contain. This may be useful for accessing any params which were used
 200      * to load the current Record cache.
 201      * @property
 202      */
 203     lastOptions : null,
 204
 205     <div id="cfg-Ext.data.Store-autoSave"></div>/**
 206      * @cfg {Boolean} autoSave
 207      * <p>Defaults to <tt>true</tt> causing the store to automatically {@link #save} records to
 208      * the server when a record is modified (ie: becomes 'dirty'). Specify <tt>false</tt> to manually call {@link #save}
 209      * to send all modifiedRecords to the server.</p>
 210      * <br><p><b>Note</b>: each CRUD action will be sent as a separate request.</p>
 211      */
 212     autoSave : true,
 213
 214     <div id="cfg-Ext.data.Store-batch"></div>/**
 215      * @cfg {Boolean} batch
 216      * <p>Defaults to <tt>true</tt> (unless <code>{@link #restful}:true</code>). Multiple
 217      * requests for each CRUD action (CREATE, READ, UPDATE and DESTROY) will be combined
 218      * and sent as one transaction. Only applies when <code>{@link #autoSave}</code> is set
 219      * to <tt>false</tt>.</p>
 220      * <br><p>If Store is RESTful, the DataProxy is also RESTful, and a unique transaction is
 221      * generated for each record.</p>
 222      */
 223     batch : true,
 224
 225     <div id="cfg-Ext.data.Store-restful"></div>/**
 226      * @cfg {Boolean} restful
 227      * Defaults to <tt>false</tt>.  Set to <tt>true</tt> to have the Store and the set
 228      * Proxy operate in a RESTful manner. The store will automatically generate GET, POST,
 229      * PUT and DELETE requests to the server. The HTTP method used for any given CRUD
 230      * action is described in {@link Ext.data.Api#restActions}.  For additional information
 231      * see {@link Ext.data.DataProxy#restful}.
 232      * <p><b>Note</b>: if <code>{@link #restful}:true</code> <code>batch</code> will
 233      * internally be set to <tt>false</tt>.</p>
 234      */
 235     restful: false,
 236
 237     <div id="cfg-Ext.data.Store-paramNames"></div>/**
 238      * @cfg {Object} paramNames
 239      * <p>An object containing properties which specify the names of the paging and
 240      * sorting parameters passed to remote servers when loading blocks of data. By default, this
 241      * object takes the following form:</p><pre><code>
 242 {
 243     start : 'start',  // The parameter name which specifies the start row
 244     limit : 'limit',  // The parameter name which specifies number of rows to return
 245     sort : 'sort',    // The parameter name which specifies the column to sort on
 246     dir : 'dir'       // The parameter name which specifies the sort direction
 247 }
 248 </code></pre>
 249      * <p>The server must produce the requested data block upon receipt of these parameter names.
 250      * If different parameter names are required, this property can be overriden using a configuration
 251      * property.</p>
 252      * <p>A {@link Ext.PagingToolbar PagingToolbar} bound to this Store uses this property to determine
 253      * the parameter names to use in its {@link #load requests}.
 254      */
 255     paramNames : undefined,
 256
 257     <div id="cfg-Ext.data.Store-defaultParamNames"></div>/**
 258      * @cfg {Object} defaultParamNames
 259      * Provides the default values for the {@link #paramNames} property. To globally modify the parameters
 260      * for all stores, this object should be changed on the store prototype.
 261      */
 262     defaultParamNames : {
 263         start : 'start',
 264         limit : 'limit',
 265         sort : 'sort',
 266         dir : 'dir'
 267     },
 268
 269     <div id="prop-Ext.data.Store-isDestroyed"></div>/**
 270      * @property isDestroyed
 271      * @type Boolean
 272      * True if the store has been destroyed already. Read only
 273      */
 274     isDestroyed: false,
 275
 276     <div id="prop-Ext.data.Store-hasMultiSort"></div>/**
 277      * @property hasMultiSort
 278      * @type Boolean
 279      * True if this store is currently sorted by more than one field/direction combination.
 280      */
 281     hasMultiSort: false,
 282
 283     // private
 284     batchKey : '_ext_batch_',
 285
 286     constructor : function(config){
 287         this.data = new Ext.util.MixedCollection(false);
 288         this.data.getKey = function(o){
 289             return o.id;
 290         };
 291
 292
 293         // temporary removed-records cache
 294         this.removed = [];
 295
 296         if(config && config.data){
 297             this.inlineData = config.data;
 298             delete config.data;
 299         }
 300
 301         Ext.apply(this, config);
 302
 303         <div id="prop-Ext.data.Store-baseParams"></div>/**
 304          * See the <code>{@link #baseParams corresponding configuration option}</code>
 305          * for a description of this property.
 306          * To modify this property see <code>{@link #setBaseParam}</code>.
 307          * @property
 308          */
 309         this.baseParams = Ext.isObject(this.baseParams) ? this.baseParams : {};
 310
 311         this.paramNames = Ext.applyIf(this.paramNames || {}, this.defaultParamNames);
 312
 313         if((this.url || this.api) && !this.proxy){
 314             this.proxy = new Ext.data.HttpProxy({url: this.url, api: this.api});
 315         }
 316         // If Store is RESTful, so too is the DataProxy
 317         if (this.restful === true && this.proxy) {
 318             // When operating RESTfully, a unique transaction is generated for each record.
 319             // TODO might want to allow implemention of faux REST where batch is possible using RESTful routes only.
 320             this.batch = false;
 321             Ext.data.Api.restify(this.proxy);
 322         }
 323
 324         if(this.reader){ // reader passed
 325             if(!this.recordType){
 326                 this.recordType = this.reader.recordType;
 327             }
 328             if(this.reader.onMetaChange){
 329                 this.reader.onMetaChange = this.reader.onMetaChange.createSequence(this.onMetaChange, this);
 330             }
 331             if (this.writer) { // writer passed
 332                 if (this.writer instanceof(Ext.data.DataWriter) === false) {    // <-- config-object instead of instance.
 333                     this.writer = this.buildWriter(this.writer);
 334                 }
 335                 this.writer.meta = this.reader.meta;
 336                 this.pruneModifiedRecords = true;
 337             }
 338         }
 339
 340         <div id="prop-Ext.data.Store-recordType"></div>/**
 341          * The {@link Ext.data.Record Record} constructor as supplied to (or created by) the
 342          * {@link Ext.data.DataReader Reader}. Read-only.
 343          * <p>If the Reader was constructed by passing in an Array of {@link Ext.data.Field} definition objects,
 344          * instead of a Record constructor, it will implicitly create a Record constructor from that Array (see
 345          * {@link Ext.data.Record}.{@link Ext.data.Record#create create} for additional details).</p>
 346          * <p>This property may be used to create new Records of the type held in this Store, for example:</p><pre><code>
 347     // create the data store
 348     var store = new Ext.data.ArrayStore({
 349         autoDestroy: true,
 350         fields: [
 351            {name: 'company'},
 352            {name: 'price', type: 'float'},
 353            {name: 'change', type: 'float'},
 354            {name: 'pctChange', type: 'float'},
 355            {name: 'lastChange', type: 'date', dateFormat: 'n/j h:ia'}
 356         ]
 357     });
 358     store.loadData(myData);
 359
 360     // create the Grid
 361     var grid = new Ext.grid.EditorGridPanel({
 362         store: store,
 363         colModel: new Ext.grid.ColumnModel({
 364             columns: [
 365                 {id:'company', header: 'Company', width: 160, dataIndex: 'company'},
 366                 {header: 'Price', renderer: 'usMoney', dataIndex: 'price'},
 367                 {header: 'Change', renderer: change, dataIndex: 'change'},
 368                 {header: '% Change', renderer: pctChange, dataIndex: 'pctChange'},
 369                 {header: 'Last Updated', width: 85,
 370                     renderer: Ext.util.Format.dateRenderer('m/d/Y'),
 371                     dataIndex: 'lastChange'}
 372             ],
 373             defaults: {
 374                 sortable: true,
 375                 width: 75
 376             }
 377         }),
 378         autoExpandColumn: 'company', // match the id specified in the column model
 379         height:350,
 380         width:600,
 381         title:'Array Grid',
 382         tbar: [{
 383             text: 'Add Record',
 384             handler : function(){
 385                 var defaultData = {
 386                     change: 0,
 387                     company: 'New Company',
 388                     lastChange: (new Date()).clearTime(),
 389                     pctChange: 0,
 390                     price: 10
 391                 };
 392                 var recId = 3; // provide unique id
 393                 var p = new store.recordType(defaultData, recId); // create new record
 394                 grid.stopEditing();
 395                 store.{@link #insert}(0, p); // insert a new record into the store (also see {@link #add})
 396                 grid.startEditing(0, 0);
 397             }
 398         }]
 399     });
 400          * </code></pre>
 401          * @property recordType
 402          * @type Function
 403          */
 404
 405         if(this.recordType){
 406             <div id="prop-Ext.data.Store-fields"></div>/**
 407              * A {@link Ext.util.MixedCollection MixedCollection} containing the defined {@link Ext.data.Field Field}s
 408              * for the {@link Ext.data.Record Records} stored in this Store. Read-only.
 409              * @property fields
 410              * @type Ext.util.MixedCollection
 411              */
 412             this.fields = this.recordType.prototype.fields;
 413         }
 414         this.modified = [];
 415
 416         this.addEvents(
 417             <div id="event-Ext.data.Store-datachanged"></div>/**
 418              * @event datachanged
 419              * Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a
 420              * widget that is using this Store as a Record cache should refresh its view.
 421              * @param {Store} this
 422              */
 423             'datachanged',
 424             <div id="event-Ext.data.Store-metachange"></div>/**
 425              * @event metachange
 426              * Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders.
 427              * @param {Store} this
 428              * @param {Object} meta The JSON metadata
 429              */
 430             'metachange',
 431             <div id="event-Ext.data.Store-add"></div>/**
 432              * @event add
 433              * Fires when Records have been {@link #add}ed to the Store
 434              * @param {Store} this
 435              * @param {Ext.data.Record[]} records The array of Records added
 436              * @param {Number} index The index at which the record(s) were added
 437              */
 438             'add',
 439             <div id="event-Ext.data.Store-remove"></div>/**
 440              * @event remove
 441              * Fires when a Record has been {@link #remove}d from the Store
 442              * @param {Store} this
 443              * @param {Ext.data.Record} record The Record that was removed
 444              * @param {Number} index The index at which the record was removed
 445              */
 446             'remove',
 447             <div id="event-Ext.data.Store-update"></div>/**
 448              * @event update
 449              * Fires when a Record has been updated
 450              * @param {Store} this
 451              * @param {Ext.data.Record} record The Record that was updated
 452              * @param {String} operation The update operation being performed.  Value may be one of:
 453              * <pre><code>
 454      Ext.data.Record.EDIT
 455      Ext.data.Record.REJECT
 456      Ext.data.Record.COMMIT
 457              * </code></pre>
 458              */
 459             'update',
 460             <div id="event-Ext.data.Store-clear"></div>/**
 461              * @event clear
 462              * Fires when the data cache has been cleared.
 463              * @param {Store} this
 464              * @param {Record[]} The records that were cleared.
 465              */
 466             'clear',
 467             <div id="event-Ext.data.Store-exception"></div>/**
 468              * @event exception
 469              * <p>Fires if an exception occurs in the Proxy during a remote request.
 470              * This event is relayed through the corresponding {@link Ext.data.DataProxy}.
 471              * See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#exception exception}
 472              * for additional details.
 473              * @param {misc} misc See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#exception exception}
 474              * for description.
 475              */
 476             'exception',
 477             <div id="event-Ext.data.Store-beforeload"></div>/**
 478              * @event beforeload
 479              * Fires before a request is made for a new data object.  If the beforeload handler returns
 480              * <tt>false</tt> the {@link #load} action will be canceled.
 481              * @param {Store} this
 482              * @param {Object} options The loading options that were specified (see {@link #load} for details)
 483              */
 484             'beforeload',
 485             <div id="event-Ext.data.Store-load"></div>/**
 486              * @event load
 487              * Fires after a new set of Records has been loaded.
 488              * @param {Store} this
 489              * @param {Ext.data.Record[]} records The Records that were loaded
 490              * @param {Object} options The loading options that were specified (see {@link #load} for details)
 491              */
 492             'load',
 493             <div id="event-Ext.data.Store-loadexception"></div>/**
 494              * @event loadexception
 495              * <p>This event is <b>deprecated</b> in favor of the catch-all <b><code>{@link #exception}</code></b>
 496              * event instead.</p>
 497              * <p>This event is relayed through the corresponding {@link Ext.data.DataProxy}.
 498              * See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#loadexception loadexception}
 499              * for additional details.
 500              * @param {misc} misc See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#loadexception loadexception}
 501              * for description.
 502              */
 503             'loadexception',
 504             <div id="event-Ext.data.Store-beforewrite"></div>/**
 505              * @event beforewrite
 506              * @param {Ext.data.Store} store
 507              * @param {String} action [Ext.data.Api.actions.create|update|destroy]
 508              * @param {Record/Record[]} rs The Record(s) being written.
 509              * @param {Object} options The loading options that were specified. Edit <code>options.params</code> to add Http parameters to the request.  (see {@link #save} for details)
 510              * @param {Object} arg The callback's arg object passed to the {@link #request} function
 511              */
 512             'beforewrite',
 513             <div id="event-Ext.data.Store-write"></div>/**
 514              * @event write
 515              * Fires if the server returns 200 after an Ext.data.Api.actions CRUD action.
 516              * Success of the action is determined in the <code>result['successProperty']</code>property (<b>NOTE</b> for RESTful stores,
 517              * a simple 20x response is sufficient for the actions "destroy" and "update".  The "create" action should should return 200 along with a database pk).
 518              * @param {Ext.data.Store} store
 519              * @param {String} action [Ext.data.Api.actions.create|update|destroy]
 520              * @param {Object} result The 'data' picked-out out of the response for convenience.
 521              * @param {Ext.Direct.Transaction} res
 522              * @param {Record/Record[]} rs Store's records, the subject(s) of the write-action
 523              */
 524             'write',
 525             <div id="event-Ext.data.Store-beforesave"></div>/**
 526              * @event beforesave
 527              * Fires before a save action is called. A save encompasses destroying records, updating records and creating records.
 528              * @param {Ext.data.Store} store
 529              * @param {Object} data An object containing the data that is to be saved. The object will contain a key for each appropriate action,
 530              * with an array of records for each action.
 531              */
 532             'beforesave',
 533             <div id="event-Ext.data.Store-save"></div>/**
 534              * @event save
 535              * Fires after a save is completed. A save encompasses destroying records, updating records and creating records.
 536              * @param {Ext.data.Store} store
 537              * @param {Number} batch The identifier for the batch that was saved.
 538              * @param {Object} data An object containing the data that is to be saved. The object will contain a key for each appropriate action,
 539              * with an array of records for each action.
 540              */
 541             'save'
 542
 543         );
 544
 545         if(this.proxy){
 546             // TODO remove deprecated loadexception with ext-3.0.1
 547             this.relayEvents(this.proxy,  ['loadexception', 'exception']);
 548         }
 549         // With a writer set for the Store, we want to listen to add/remove events to remotely create/destroy records.
 550         if (this.writer) {
 551             this.on({
 552                 scope: this,
 553                 add: this.createRecords,
 554                 remove: this.destroyRecord,
 555                 update: this.updateRecord,
 556                 clear: this.onClear
 557             });
 558         }
 559
 560         this.sortToggle = {};
 561         if(this.sortField){
 562             this.setDefaultSort(this.sortField, this.sortDir);
 563         }else if(this.sortInfo){
 564             this.setDefaultSort(this.sortInfo.field, this.sortInfo.direction);
 565         }
 566
 567         Ext.data.Store.superclass.constructor.call(this);
 568
 569         if(this.id){
 570             this.storeId = this.id;
 571             delete this.id;
 572         }
 573         if(this.storeId){
 574             Ext.StoreMgr.register(this);
 575         }
 576         if(this.inlineData){
 577             this.loadData(this.inlineData);
 578             delete this.inlineData;
 579         }else if(this.autoLoad){
 580             this.load.defer(10, this, [
 581                 typeof this.autoLoad == 'object' ?
 582                     this.autoLoad : undefined]);
 583         }
 584         // used internally to uniquely identify a batch
 585         this.batchCounter = 0;
 586         this.batches = {};
 587     },
 588
 589     /**
 590      * builds a DataWriter instance when Store constructor is provided with a writer config-object instead of an instace.
 591      * @param {Object} config Writer configuration
 592      * @return {Ext.data.DataWriter}
 593      * @private
 594      */
 595     buildWriter : function(config) {
 596         var klass = undefined,
 597             type = (config.format || 'json').toLowerCase();
 598         switch (type) {
 599             case 'json':
 600                 klass = Ext.data.JsonWriter;
 601                 break;
 602             case 'xml':
 603                 klass = Ext.data.XmlWriter;
 604                 break;
 605             default:
 606                 klass = Ext.data.JsonWriter;
 607         }
 608         return new klass(config);
 609     },
 610
 611     <div id="method-Ext.data.Store-destroy"></div>/**
 612      * Destroys the store.
 613      */
 614     destroy : function(){
 615         if(!this.isDestroyed){
 616             if(this.storeId){
 617                 Ext.StoreMgr.unregister(this);
 618             }
 619             this.clearData();
 620             this.data = null;
 621             Ext.destroy(this.proxy);
 622             this.reader = this.writer = null;
 623             this.purgeListeners();
 624             this.isDestroyed = true;
 625         }
 626     },
 627
 628     <div id="method-Ext.data.Store-add"></div>/**
 629      * Add Records to the Store and fires the {@link #add} event.  To add Records
 630      * to the store from a remote source use <code>{@link #load}({add:true})</code>.
 631      * See also <code>{@link #recordType}</code> and <code>{@link #insert}</code>.
 632      * @param {Ext.data.Record[]} records An Array of Ext.data.Record objects
 633      * to add to the cache. See {@link #recordType}.
 634      */
 635     add : function(records){
 636         records = [].concat(records);
 637         if(records.length < 1){
 638             return;
 639         }
 640         for(var i = 0, len = records.length; i < len; i++){
 641             records[i].join(this);
 642         }
 643         var index = this.data.length;
 644         this.data.addAll(records);
 645         if(this.snapshot){
 646             this.snapshot.addAll(records);
 647         }
 648         this.fireEvent('add', this, records, index);
 649     },
 650
 651     <div id="method-Ext.data.Store-addSorted"></div>/**
 652      * (Local sort only) Inserts the passed Record into the Store at the index where it
 653      * should go based on the current sort information.
 654      * @param {Ext.data.Record} record
 655      */
 656     addSorted : function(record){
 657         var index = this.findInsertIndex(record);
 658         this.insert(index, record);
 659     },
 660
 661     <div id="method-Ext.data.Store-remove"></div>/**
 662      * Remove Records from the Store and fires the {@link #remove} event.
 663      * @param {Ext.data.Record/Ext.data.Record[]} record The record object or array of records to remove from the cache.
 664      */
 665     remove : function(record){
 666         if(Ext.isArray(record)){
 667             Ext.each(record, function(r){
 668                 this.remove(r);
 669             }, this);
 670             return;
 671         }
 672         var index = this.data.indexOf(record);
 673         if(index > -1){
 674             record.join(null);
 675             this.data.removeAt(index);
 676         }
 677         if(this.pruneModifiedRecords){
 678             this.modified.remove(record);
 679         }
 680         if(this.snapshot){
 681             this.snapshot.remove(record);
 682         }
 683         if(index > -1){
 684             this.fireEvent('remove', this, record, index);
 685         }
 686     },
 687
 688     <div id="method-Ext.data.Store-removeAt"></div>/**
 689      * Remove a Record from the Store at the specified index. Fires the {@link #remove} event.
 690      * @param {Number} index The index of the record to remove.
 691      */
 692     removeAt : function(index){
 693         this.remove(this.getAt(index));
 694     },
 695
 696     <div id="method-Ext.data.Store-removeAll"></div>/**
 697      * Remove all Records from the Store and fires the {@link #clear} event.
 698      * @param {Boolean} silent [false] Defaults to <tt>false</tt>.  Set <tt>true</tt> to not fire clear event.
 699      */
 700     removeAll : function(silent){
 701         var items = [];
 702         this.each(function(rec){
 703             items.push(rec);
 704         });
 705         this.clearData();
 706         if(this.snapshot){
 707             this.snapshot.clear();
 708         }
 709         if(this.pruneModifiedRecords){
 710             this.modified = [];
 711         }
 712         if (silent !== true) {  // <-- prevents write-actions when we just want to clear a store.
 713             this.fireEvent('clear', this, items);
 714         }
 715     },
 716
 717     // private
 718     onClear: function(store, records){
 719         Ext.each(records, function(rec, index){
 720             this.destroyRecord(this, rec, index);
 721         }, this);
 722     },
 723
 724     <div id="method-Ext.data.Store-insert"></div>/**
 725      * Inserts Records into the Store at the given index and fires the {@link #add} event.
 726      * See also <code>{@link #add}</code> and <code>{@link #addSorted}</code>.
 727      * @param {Number} index The start index at which to insert the passed Records.
 728      * @param {Ext.data.Record[]} records An Array of Ext.data.Record objects to add to the cache.
 729      */
 730     insert : function(index, records){
 731         records = [].concat(records);
 732         for(var i = 0, len = records.length; i < len; i++){
 733             this.data.insert(index, records[i]);
 734             records[i].join(this);
 735         }
 736         if(this.snapshot){
 737             this.snapshot.addAll(records);
 738         }
 739         this.fireEvent('add', this, records, index);
 740     },
 741
 742     <div id="method-Ext.data.Store-indexOf"></div>/**
 743      * Get the index within the cache of the passed Record.
 744      * @param {Ext.data.Record} record The Ext.data.Record object to find.
 745      * @return {Number} The index of the passed Record. Returns -1 if not found.
 746      */
 747     indexOf : function(record){
 748         return this.data.indexOf(record);
 749     },
 750
 751     <div id="method-Ext.data.Store-indexOfId"></div>/**
 752      * Get the index within the cache of the Record with the passed id.
 753      * @param {String} id The id of the Record to find.
 754      * @return {Number} The index of the Record. Returns -1 if not found.
 755      */
 756     indexOfId : function(id){
 757         return this.data.indexOfKey(id);
 758     },
 759
 760     <div id="method-Ext.data.Store-getById"></div>/**
 761      * Get the Record with the specified id.
 762      * @param {String} id The id of the Record to find.
 763      * @return {Ext.data.Record} The Record with the passed id. Returns undefined if not found.
 764      */
 765     getById : function(id){
 766         return (this.snapshot || this.data).key(id);
 767     },
 768
 769     <div id="method-Ext.data.Store-getAt"></div>/**
 770      * Get the Record at the specified index.
 771      * @param {Number} index The index of the Record to find.
 772      * @return {Ext.data.Record} The Record at the passed index. Returns undefined if not found.
 773      */
 774     getAt : function(index){
 775         return this.data.itemAt(index);
 776     },
 777
 778     <div id="method-Ext.data.Store-getRange"></div>/**
 779      * Returns a range of Records between specified indices.
 780      * @param {Number} startIndex (optional) The starting index (defaults to 0)
 781      * @param {Number} endIndex (optional) The ending index (defaults to the last Record in the Store)
 782      * @return {Ext.data.Record[]} An array of Records
 783      */
 784     getRange : function(start, end){
 785         return this.data.getRange(start, end);
 786     },
 787
 788     // private
 789     storeOptions : function(o){
 790         o = Ext.apply({}, o);
 791         delete o.callback;
 792         delete o.scope;
 793         this.lastOptions = o;
 794     },
 795
 796     // private
 797     clearData: function(){
 798         this.data.each(function(rec) {
 799             rec.join(null);
 800         });
 801         this.data.clear();
 802     },
 803
 804     <div id="method-Ext.data.Store-load"></div>/**
 805      * <p>Loads the Record cache from the configured <tt>{@link #proxy}</tt> using the configured <tt>{@link #reader}</tt>.</p>
 806      * <br><p>Notes:</p><div class="mdetail-params"><ul>
 807      * <li><b><u>Important</u></b>: loading is asynchronous! This call will return before the new data has been
 808      * loaded. To perform any post-processing where information from the load call is required, specify
 809      * the <tt>callback</tt> function to be called, or use a {@link Ext.util.Observable#listeners a 'load' event handler}.</li>
 810      * <li>If using {@link Ext.PagingToolbar remote paging}, the first load call must specify the <tt>start</tt> and <tt>limit</tt>
 811      * properties in the <code>options.params</code> property to establish the initial position within the
 812      * dataset, and the number of Records to cache on each read from the Proxy.</li>
 813      * <li>If using {@link #remoteSort remote sorting}, the configured <code>{@link #sortInfo}</code>
 814      * will be automatically included with the posted parameters according to the specified
 815      * <code>{@link #paramNames}</code>.</li>
 816      * </ul></div>
 817      * @param {Object} options An object containing properties which control loading options:<ul>
 818      * <li><b><tt>params</tt></b> :Object<div class="sub-desc"><p>An object containing properties to pass as HTTP
 819      * parameters to a remote data source. <b>Note</b>: <code>params</code> will override any
 820      * <code>{@link #baseParams}</code> of the same name.</p>
 821      * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p></div></li>
 822      * <li><b>callback</b> : Function<div class="sub-desc"><p>A function to be called after the Records
 823      * have been loaded. The callback is called after the load event is fired, and is passed the following arguments:<ul>
 824      * <li>r : Ext.data.Record[] An Array of Records loaded.</li>
 825      * <li>options : Options object from the load call.</li>
 826      * <li>success : Boolean success indicator.</li></ul></p></div></li>
 827      * <li><b>scope</b> : Object<div class="sub-desc"><p>Scope with which to call the callback (defaults
 828      * to the Store object)</p></div></li>
 829      * <li><b>add</b> : Boolean<div class="sub-desc"><p>Indicator to append loaded records rather than
 830      * replace the current cache.  <b>Note</b>: see note for <tt>{@link #loadData}</tt></p></div></li>
 831      * </ul>
 832      * @return {Boolean} If the <i>developer</i> provided <tt>{@link #beforeload}</tt> event handler returns
 833      * <tt>false</tt>, the load call will abort and will return <tt>false</tt>; otherwise will return <tt>true</tt>.
 834      */
 835     load : function(options) {
 836         options = Ext.apply({}, options);
 837         this.storeOptions(options);
 838         if(this.sortInfo && this.remoteSort){
 839             var pn = this.paramNames;
 840             options.params = Ext.apply({}, options.params);
 841             options.params[pn.sort] = this.sortInfo.field;
 842             options.params[pn.dir] = this.sortInfo.direction;
 843         }
 844         try {
 845             return this.execute('read', null, options); // <-- null represents rs.  No rs for load actions.
 846         } catch(e) {
 847             this.handleException(e);
 848             return false;
 849         }
 850     },
 851
 852     /**
 853      * updateRecord  Should not be used directly.  This method will be called automatically if a Writer is set.
 854      * Listens to 'update' event.
 855      * @param {Object} store
 856      * @param {Object} record
 857      * @param {Object} action
 858      * @private
 859      */
 860     updateRecord : function(store, record, action) {
 861         if (action == Ext.data.Record.EDIT && this.autoSave === true && (!record.phantom || (record.phantom && record.isValid()))) {
 862             this.save();
 863         }
 864     },
 865
 866     /**
 867      * Should not be used directly.  Store#add will call this automatically if a Writer is set
 868      * @param {Object} store
 869      * @param {Object} rs
 870      * @param {Object} index
 871      * @private
 872      */
 873     createRecords : function(store, rs, index) {
 874         for (var i = 0, len = rs.length; i < len; i++) {
 875             if (rs[i].phantom && rs[i].isValid()) {
 876                 rs[i].markDirty();  // <-- Mark new records dirty
 877                 this.modified.push(rs[i]);  // <-- add to modified
 878             }
 879         }
 880         if (this.autoSave === true) {
 881             this.save();
 882         }
 883     },
 884
 885     /**
 886      * Destroys a Record.  Should not be used directly.  It's called by Store#remove if a Writer is set.
 887      * @param {Store} store this
 888      * @param {Ext.data.Record} record
 889      * @param {Number} index
 890      * @private
 891      */
 892     destroyRecord : function(store, record, index) {
 893         if (this.modified.indexOf(record) != -1) {  // <-- handled already if @cfg pruneModifiedRecords == true
 894             this.modified.remove(record);
 895         }
 896         if (!record.phantom) {
 897             this.removed.push(record);
 898
 899             // since the record has already been removed from the store but the server request has not yet been executed,
 900             // must keep track of the last known index this record existed.  If a server error occurs, the record can be
 901             // put back into the store.  @see Store#createCallback where the record is returned when response status === false
 902             record.lastIndex = index;
 903
 904             if (this.autoSave === true) {
 905                 this.save();
 906             }
 907         }
 908     },
 909
 910     /**
 911      * This method should generally not be used directly.  This method is called internally
 912      * by {@link #load}, or if a Writer is set will be called automatically when {@link #add},
 913      * {@link #remove}, or {@link #update} events fire.
 914      * @param {String} action Action name ('read', 'create', 'update', or 'destroy')
 915      * @param {Record/Record[]} rs
 916      * @param {Object} options
 917      * @throws Error
 918      * @private
 919      */
 920     execute : function(action, rs, options, /* private */ batch) {
 921         // blow up if action not Ext.data.CREATE, READ, UPDATE, DESTROY
 922         if (!Ext.data.Api.isAction(action)) {
 923             throw new Ext.data.Api.Error('execute', action);
 924         }
 925         // make sure options has a fresh, new params hash
 926         options = Ext.applyIf(options||{}, {
 927             params: {}
 928         });
 929         if(batch !== undefined){
 930             this.addToBatch(batch);
 931         }
 932         // have to separate before-events since load has a different signature than create,destroy and save events since load does not
 933         // include the rs (record resultset) parameter.  Capture return values from the beforeaction into doRequest flag.
 934         var doRequest = true;
 935
 936         if (action === 'read') {
 937             doRequest = this.fireEvent('beforeload', this, options);
 938             Ext.applyIf(options.params, this.baseParams);
 939         }
 940         else {
 941             // if Writer is configured as listful, force single-record rs to be [{}] instead of {}
 942             // TODO Move listful rendering into DataWriter where the @cfg is defined.  Should be easy now.
 943             if (this.writer.listful === true && this.restful !== true) {
 944                 rs = (Ext.isArray(rs)) ? rs : [rs];
 945             }
 946             // if rs has just a single record, shift it off so that Writer writes data as '{}' rather than '[{}]'
 947             else if (Ext.isArray(rs) && rs.length == 1) {
 948                 rs = rs.shift();
 949             }
 950             // Write the action to options.params
 951             if ((doRequest = this.fireEvent('beforewrite', this, action, rs, options)) !== false) {
 952                 this.writer.apply(options.params, this.baseParams, action, rs);
 953             }
 954         }
 955         if (doRequest !== false) {
 956             // Send request to proxy.
 957             if (this.writer && this.proxy.url && !this.proxy.restful && !Ext.data.Api.hasUniqueUrl(this.proxy, action)) {
 958                 options.params.xaction = action;    // <-- really old, probaby unecessary.
 959             }
 960             // Note:  Up until this point we've been dealing with 'action' as a key from Ext.data.Api.actions.
 961             // We'll flip it now and send the value into DataProxy#request, since it's the value which maps to
 962             // the user's configured DataProxy#api
 963             // TODO Refactor all Proxies to accept an instance of Ext.data.Request (not yet defined) instead of this looooooong list
 964             // of params.  This method is an artifact from Ext2.
 965             this.proxy.request(Ext.data.Api.actions[action], rs, options.params, this.reader, this.createCallback(action, rs, batch), this, options);
 966         }
 967         return doRequest;
 968     },
 969
 970     <div id="method-Ext.data.Store-save"></div>/**
 971      * Saves all pending changes to the store.  If the commensurate Ext.data.Api.actions action is not configured, then
 972      * the configured <code>{@link #url}</code> will be used.
 973      * <pre>
 974      * change            url
 975      * ---------------   --------------------
 976      * removed records   Ext.data.Api.actions.destroy
 977      * phantom records   Ext.data.Api.actions.create
 978      * {@link #getModifiedRecords modified records}  Ext.data.Api.actions.update
 979      * </pre>
 980      * @TODO:  Create extensions of Error class and send associated Record with thrown exceptions.
 981      * e.g.:  Ext.data.DataReader.Error or Ext.data.Error or Ext.data.DataProxy.Error, etc.
 982      * @return {Number} batch Returns a number to uniquely identify the "batch" of saves occurring. -1 will be returned
 983      * if there are no items to save or the save was cancelled.
 984      */
 985     save : function() {
 986         if (!this.writer) {
 987             throw new Ext.data.Store.Error('writer-undefined');
 988         }
 989
 990         var queue = [],
 991             len,
 992             trans,
 993             batch,
 994             data = {};
 995         // DESTROY:  First check for removed records.  Records in this.removed are guaranteed non-phantoms.  @see Store#remove
 996         if(this.removed.length){
 997             queue.push(['destroy', this.removed]);
 998         }
 999
1000         // Check for modified records. Use a copy so Store#rejectChanges will work if server returns error.
1001         var rs = [].concat(this.getModifiedRecords());
1002         if(rs.length){
1003             // CREATE:  Next check for phantoms within rs.  splice-off and execute create.
1004             var phantoms = [];
1005             for(var i = rs.length-1; i >= 0; i--){
1006                 if(rs[i].phantom === true){
1007                     var rec = rs.splice(i, 1).shift();
1008                     if(rec.isValid()){
1009                         phantoms.push(rec);
1010                     }
1011                 }else if(!rs[i].isValid()){ // <-- while we're here, splice-off any !isValid real records
1012                     rs.splice(i,1);
1013                 }
1014             }
1015             // If we have valid phantoms, create them...
1016             if(phantoms.length){
1017                 queue.push(['create', phantoms]);
1018             }
1019
1020             // UPDATE:  And finally, if we're still here after splicing-off phantoms and !isValid real records, update the rest...
1021             if(rs.length){
1022                 queue.push(['update', rs]);
1023             }
1024         }
1025         len = queue.length;
1026         if(len){
1027             batch = ++this.batchCounter;
1028             for(var i = 0; i < len; ++i){
1029                 trans = queue[i];
1030                 data[trans[0]] = trans[1];
1031             }
1032             if(this.fireEvent('beforesave', this, data) !== false){
1033                 for(var i = 0; i < len; ++i){
1034                     trans = queue[i];
1035                     this.doTransaction(trans[0], trans[1], batch);
1036                 }
1037                 return batch;
1038             }
1039         }
1040         return -1;
1041     },
1042
1043     // private.  Simply wraps call to Store#execute in try/catch.  Defers to Store#handleException on error.  Loops if batch: false
1044     doTransaction : function(action, rs, batch) {
1045         function transaction(records) {
1046             try{
1047                 this.execute(action, records, undefined, batch);
1048             }catch (e){
1049                 this.handleException(e);
1050             }
1051         }
1052         if(this.batch === false){
1053             for(var i = 0, len = rs.length; i < len; i++){
1054                 transaction.call(this, rs[i]);
1055             }
1056         }else{
1057             transaction.call(this, rs);
1058         }
1059     },
1060
1061     // private
1062     addToBatch : function(batch){
1063         var b = this.batches,
1064             key = this.batchKey + batch,
1065             o = b[key];
1066
1067         if(!o){
1068             b[key] = o = {
1069                 id: batch,
1070                 count: 0,
1071                 data: {}
1072             };
1073         }
1074         ++o.count;
1075     },
1076
1077     removeFromBatch : function(batch, action, data){
1078         var b = this.batches,
1079             key = this.batchKey + batch,
1080             o = b[key],
1081             data,
1082             arr;
1083
1084
1085         if(o){
1086             arr = o.data[action] || [];
1087             o.data[action] = arr.concat(data);
1088             if(o.count === 1){
1089                 data = o.data;
1090                 delete b[key];
1091                 this.fireEvent('save', this, batch, data);
1092             }else{
1093                 --o.count;
1094             }
1095         }
1096     },
1097
1098     // @private callback-handler for remote CRUD actions
1099     // Do not override -- override loadRecords, onCreateRecords, onDestroyRecords and onUpdateRecords instead.
1100     createCallback : function(action, rs, batch) {
1101         var actions = Ext.data.Api.actions;
1102         return (action == 'read') ? this.loadRecords : function(data, response, success) {
1103             // calls: onCreateRecords | onUpdateRecords | onDestroyRecords
1104             this['on' + Ext.util.Format.capitalize(action) + 'Records'](success, rs, [].concat(data));
1105             // If success === false here, exception will have been called in DataProxy
1106             if (success === true) {
1107                 this.fireEvent('write', this, action, data, response, rs);
1108             }
1109             this.removeFromBatch(batch, action, data);
1110         };
1111     },
1112
1113     // Clears records from modified array after an exception event.
1114     // NOTE:  records are left marked dirty.  Do we want to commit them even though they were not updated/realized?
1115     // TODO remove this method?
1116     clearModified : function(rs) {
1117         if (Ext.isArray(rs)) {
1118             for (var n=rs.length-1;n>=0;n--) {
1119                 this.modified.splice(this.modified.indexOf(rs[n]), 1);
1120             }
1121         } else {
1122             this.modified.splice(this.modified.indexOf(rs), 1);
1123         }
1124     },
1125
1126     // remap record ids in MixedCollection after records have been realized.  @see Store#onCreateRecords, @see DataReader#realize
1127     reMap : function(record) {
1128         if (Ext.isArray(record)) {
1129             for (var i = 0, len = record.length; i < len; i++) {
1130                 this.reMap(record[i]);
1131             }
1132         } else {
1133             delete this.data.map[record._phid];
1134             this.data.map[record.id] = record;
1135             var index = this.data.keys.indexOf(record._phid);
1136             this.data.keys.splice(index, 1, record.id);
1137             delete record._phid;
1138         }
1139     },
1140
1141     // @protected onCreateRecord proxy callback for create action
1142     onCreateRecords : function(success, rs, data) {
1143         if (success === true) {
1144             try {
1145                 this.reader.realize(rs, data);
1146                 this.reMap(rs);
1147             }
1148             catch (e) {
1149                 this.handleException(e);
1150                 if (Ext.isArray(rs)) {
1151                     // Recurse to run back into the try {}.  DataReader#realize splices-off the rs until empty.
1152                     this.onCreateRecords(success, rs, data);
1153                 }
1154             }
1155         }
1156     },
1157
1158     // @protected, onUpdateRecords proxy callback for update action
1159     onUpdateRecords : function(success, rs, data) {
1160         if (success === true) {
1161             try {
1162                 this.reader.update(rs, data);
1163             } catch (e) {
1164                 this.handleException(e);
1165                 if (Ext.isArray(rs)) {
1166                     // Recurse to run back into the try {}.  DataReader#update splices-off the rs until empty.
1167                     this.onUpdateRecords(success, rs, data);
1168                 }
1169             }
1170         }
1171     },
1172
1173     // @protected onDestroyRecords proxy callback for destroy action
1174     onDestroyRecords : function(success, rs, data) {
1175         // splice each rec out of this.removed
1176         rs = (rs instanceof Ext.data.Record) ? [rs] : [].concat(rs);
1177         for (var i=0,len=rs.length;i<len;i++) {
1178             this.removed.splice(this.removed.indexOf(rs[i]), 1);
1179         }
1180         if (success === false) {
1181             // put records back into store if remote destroy fails.
1182             // @TODO: Might want to let developer decide.
1183             for (i=rs.length-1;i>=0;i--) {
1184                 this.insert(rs[i].lastIndex, rs[i]);    // <-- lastIndex set in Store#destroyRecord
1185             }
1186         }
1187     },
1188
1189     // protected handleException.  Possibly temporary until Ext framework has an exception-handler.
1190     handleException : function(e) {
1191         // @see core/Error.js
1192         Ext.handleError(e);
1193     },
1194
1195     <div id="method-Ext.data.Store-reload"></div>/**
1196      * <p>Reloads the Record cache from the configured Proxy using the configured
1197      * {@link Ext.data.Reader Reader} and the options from the last load operation
1198      * performed.</p>
1199      * <p><b>Note</b>: see the Important note in {@link #load}.</p>
1200      * @param {Object} options <p>(optional) An <tt>Object</tt> containing
1201      * {@link #load loading options} which may override the {@link #lastOptions options}
1202      * used in the last {@link #load} operation. See {@link #load} for details
1203      * (defaults to <tt>null</tt>, in which case the {@link #lastOptions} are
1204      * used).</p>
1205      * <br><p>To add new params to the existing params:</p><pre><code>
1206 lastOptions = myStore.lastOptions;
1207 Ext.apply(lastOptions.params, {
1208     myNewParam: true
1209 });
1210 myStore.reload(lastOptions);
1211      * </code></pre>
1212      */
1213     reload : function(options){
1214         this.load(Ext.applyIf(options||{}, this.lastOptions));
1215     },
1216
1217     // private
1218     // Called as a callback by the Reader during a load operation.
1219     loadRecords : function(o, options, success){
1220         if (this.isDestroyed === true) {
1221             return;
1222         }
1223         if(!o || success === false){
1224             if(success !== false){
1225                 this.fireEvent('load', this, [], options);
1226             }
1227             if(options.callback){
1228                 options.callback.call(options.scope || this, [], options, false, o);
1229             }
1230             return;
1231         }
1232         var r = o.records, t = o.totalRecords || r.length;
1233         if(!options || options.add !== true){
1234             if(this.pruneModifiedRecords){
1235                 this.modified = [];
1236             }
1237             for(var i = 0, len = r.length; i < len; i++){
1238                 r[i].join(this);
1239             }
1240             if(this.snapshot){
1241                 this.data = this.snapshot;
1242                 delete this.snapshot;
1243             }
1244             this.clearData();
1245             this.data.addAll(r);
1246             this.totalLength = t;
1247             this.applySort();
1248             this.fireEvent('datachanged', this);
1249         }else{
1250             this.totalLength = Math.max(t, this.data.length+r.length);
1251             this.add(r);
1252         }
1253         this.fireEvent('load', this, r, options);
1254         if(options.callback){
1255             options.callback.call(options.scope || this, r, options, true);
1256         }
1257     },
1258
1259     <div id="method-Ext.data.Store-loadData"></div>/**
1260      * Loads data from a passed data block and fires the {@link #load} event. A {@link Ext.data.Reader Reader}
1261      * which understands the format of the data must have been configured in the constructor.
1262      * @param {Object} data The data block from which to read the Records.  The format of the data expected
1263      * is dependent on the type of {@link Ext.data.Reader Reader} that is configured and should correspond to
1264      * that {@link Ext.data.Reader Reader}'s <tt>{@link Ext.data.Reader#readRecords}</tt> parameter.
1265      * @param {Boolean} append (Optional) <tt>true</tt> to append the new Records rather the default to replace
1266      * the existing cache.
1267      * <b>Note</b>: that Records in a Store are keyed by their {@link Ext.data.Record#id id}, so added Records
1268      * with ids which are already present in the Store will <i>replace</i> existing Records. Only Records with
1269      * new, unique ids will be added.
1270      */
1271     loadData : function(o, append){
1272         var r = this.reader.readRecords(o);
1273         this.loadRecords(r, {add: append}, true);
1274     },
1275
1276     <div id="method-Ext.data.Store-getCount"></div>/**
1277      * Gets the number of cached records.
1278      * <p>If using paging, this may not be the total size of the dataset. If the data object
1279      * used by the Reader contains the dataset size, then the {@link #getTotalCount} function returns
1280      * the dataset size.  <b>Note</b>: see the Important note in {@link #load}.</p>
1281      * @return {Number} The number of Records in the Store's cache.
1282      */
1283     getCount : function(){
1284         return this.data.length || 0;
1285     },
1286
1287     <div id="method-Ext.data.Store-getTotalCount"></div>/**
1288      * Gets the total number of records in the dataset as returned by the server.
1289      * <p>If using paging, for this to be accurate, the data object used by the {@link #reader Reader}
1290      * must contain the dataset size. For remote data sources, the value for this property
1291      * (<tt>totalProperty</tt> for {@link Ext.data.JsonReader JsonReader},
1292      * <tt>totalRecords</tt> for {@link Ext.data.XmlReader XmlReader}) shall be returned by a query on the server.
1293      * <b>Note</b>: see the Important note in {@link #load}.</p>
1294      * @return {Number} The number of Records as specified in the data object passed to the Reader
1295      * by the Proxy.
1296      * <p><b>Note</b>: this value is not updated when changing the contents of the Store locally.</p>
1297      */
1298     getTotalCount : function(){
1299         return this.totalLength || 0;
1300     },
1301
1302     <div id="method-Ext.data.Store-getSortState"></div>/**
1303      * Returns an object describing the current sort state of this Store.
1304      * @return {Object} The sort state of the Store. An object with two properties:<ul>
1305      * <li><b>field : String<p class="sub-desc">The name of the field by which the Records are sorted.</p></li>
1306      * <li><b>direction : String<p class="sub-desc">The sort order, 'ASC' or 'DESC' (case-sensitive).</p></li>
1307      * </ul>
1308      * See <tt>{@link #sortInfo}</tt> for additional details.
1309      */
1310     getSortState : function(){
1311         return this.sortInfo;
1312     },
1313
1314     /**
1315      * @private
1316      * Invokes sortData if we have sortInfo to sort on and are not sorting remotely
1317      */
1318     applySort : function(){
1319         if ((this.sortInfo || this.multiSortInfo) && !this.remoteSort) {
1320             this.sortData();
1321         }
1322     },
1323
1324     /**
1325      * @private
1326      * Performs the actual sorting of data. This checks to see if we currently have a multi sort or not. It applies
1327      * each sorter field/direction pair in turn by building an OR'ed master sorting function and running it against
1328      * the full dataset
1329      */
1330     sortData : function() {
1331         var sortInfo  = this.hasMultiSort ? this.multiSortInfo : this.sortInfo,
1332             direction = sortInfo.direction || "ASC",
1333             sorters   = sortInfo.sorters,
1334             sortFns   = [];
1335
1336         //if we just have a single sorter, pretend it's the first in an array
1337         if (!this.hasMultiSort) {
1338             sorters = [{direction: direction, field: sortInfo.field}];
1339         }
1340
1341         //create a sorter function for each sorter field/direction combo
1342         for (var i=0, j = sorters.length; i < j; i++) {
1343             sortFns.push(this.createSortFunction(sorters[i].field, sorters[i].direction));
1344         }
1345
1346         if (sortFns.length == 0) {
1347             return;
1348         }
1349
1350         //the direction modifier is multiplied with the result of the sorting functions to provide overall sort direction
1351         //(as opposed to direction per field)
1352         var directionModifier = direction.toUpperCase() == "DESC" ? -1 : 1;
1353
1354         //create a function which ORs each sorter together to enable multi-sort
1355         var fn = function(r1, r2) {
1356           var result = sortFns[0].call(this, r1, r2);
1357
1358           //if we have more than one sorter, OR any additional sorter functions together
1359           if (sortFns.length > 1) {
1360               for (var i=1, j = sortFns.length; i < j; i++) {
1361                   result = result || sortFns[i].call(this, r1, r2);
1362               }
1363           }
1364
1365           return directionModifier * result;
1366         };
1367
1368         //sort the data
1369         this.data.sort(direction, fn);
1370         if (this.snapshot && this.snapshot != this.data) {
1371             this.snapshot.sort(direction, fn);
1372         }
1373     },
1374
1375     /**
1376      * @private
1377      * Creates and returns a function which sorts an array by the given field and direction
1378      * @param {String} field The field to create the sorter for
1379      * @param {String} direction The direction to sort by (defaults to "ASC")
1380      * @return {Function} A function which sorts by the field/direction combination provided
1381      */
1382     createSortFunction: function(field, direction) {
1383         direction = direction || "ASC";
1384         var directionModifier = direction.toUpperCase() == "DESC" ? -1 : 1;
1385
1386         var sortType = this.fields.get(field).sortType;
1387
1388         //create a comparison function. Takes 2 records, returns 1 if record 1 is greater,
1389         //-1 if record 2 is greater or 0 if they are equal
1390         return function(r1, r2) {
1391             var v1 = sortType(r1.data[field]),
1392                 v2 = sortType(r2.data[field]);
1393
1394             return directionModifier * (v1 > v2 ? 1 : (v1 < v2 ? -1 : 0));
1395         };
1396     },
1397
1398     <div id="method-Ext.data.Store-setDefaultSort"></div>/**
1399      * Sets the default sort column and order to be used by the next {@link #load} operation.
1400      * @param {String} fieldName The name of the field to sort by.
1401      * @param {String} dir (optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to <tt>'ASC'</tt>)
1402      */
1403     setDefaultSort : function(field, dir) {
1404         dir = dir ? dir.toUpperCase() : 'ASC';
1405         this.sortInfo = {field: field, direction: dir};
1406         this.sortToggle[field] = dir;
1407     },
1408
1409     <div id="method-Ext.data.Store-sort"></div>/**
1410      * Sort the Records.
1411      * If remote sorting is used, the sort is performed on the server, and the cache is reloaded. If local
1412      * sorting is used, the cache is sorted internally. See also {@link #remoteSort} and {@link #paramNames}.
1413      * This function accepts two call signatures - pass in a field name as the first argument to sort on a single
1414      * field, or pass in an array of sort configuration objects to sort by multiple fields.
1415      * Single sort example:
1416      * store.sort('name', 'ASC');
1417      * Multi sort example:
1418      * store.sort([
1419      *   {
1420      *     field    : 'name',
1421      *     direction: 'ASC'
1422      *   },
1423      *   {
1424      *     field    : 'salary',
1425      *     direction: 'DESC'
1426      *   }
1427      * ], 'ASC');
1428      * In this second form, the sort configs are applied in order, with later sorters sorting within earlier sorters' results.
1429      * For example, if two records with the same name are present they will also be sorted by salary if given the sort configs
1430      * above. Any number of sort configs can be added.
1431      * @param {String/Array} fieldName The name of the field to sort by, or an array of ordered sort configs
1432      * @param {String} dir (optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to <tt>'ASC'</tt>)
1433      */
1434     sort : function(fieldName, dir) {
1435         if (Ext.isArray(arguments[0])) {
1436             return this.multiSort.call(this, fieldName, dir);
1437         } else {
1438             return this.singleSort(fieldName, dir);
1439         }
1440     },
1441
1442     <div id="method-Ext.data.Store-singleSort"></div>/**
1443      * Sorts the store contents by a single field and direction. This is called internally by {@link sort} and would
1444      * not usually be called manually
1445      * @param {String} fieldName The name of the field to sort by.
1446      * @param {String} dir (optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to <tt>'ASC'</tt>)
1447      */
1448     singleSort: function(fieldName, dir) {
1449         var field = this.fields.get(fieldName);
1450         if (!field) return false;
1451
1452         var name       = field.name,
1453             sortInfo   = this.sortInfo || null,
1454             sortToggle = this.sortToggle ? this.sortToggle[name] : null;
1455
1456         if (!dir) {
1457             if (sortInfo && sortInfo.field == name) { // toggle sort dir
1458                 dir = (this.sortToggle[name] || 'ASC').toggle('ASC', 'DESC');
1459             } else {
1460                 dir = field.sortDir;
1461             }
1462         }
1463
1464         this.sortToggle[name] = dir;
1465         this.sortInfo = {field: name, direction: dir};
1466         this.hasMultiSort = false;
1467
1468         if (this.remoteSort) {
1469             if (!this.load(this.lastOptions)) {
1470                 if (sortToggle) {
1471                     this.sortToggle[name] = sortToggle;
1472                 }
1473                 if (sortInfo) {
1474                     this.sortInfo = sortInfo;
1475                 }
1476             }
1477         } else {
1478             this.applySort();
1479             this.fireEvent('datachanged', this);
1480         }
1481     },
1482
1483     <div id="method-Ext.data.Store-multiSort"></div>/**
1484      * Sorts the contents of this store by multiple field/direction sorters. This is called internally by {@link sort}
1485      * and would not usually be called manually.
1486      * Multi sorting only currently applies to local datasets - multiple sort data is not currently sent to a proxy
1487      * if remoteSort is used.
1488      * @param {Array} sorters Array of sorter objects (field and direction)
1489      * @param {String} direction Overall direction to sort the ordered results by (defaults to "ASC")
1490      */
1491     multiSort: function(sorters, direction) {
1492         this.hasMultiSort = true;
1493         direction = direction || "ASC";
1494
1495         //toggle sort direction
1496         if (this.multiSortInfo && direction == this.multiSortInfo.direction) {
1497             direction = direction.toggle("ASC", "DESC");
1498         }
1499
1500         <div id="prop-Ext.data.Store-multiSortInfo"></div>/**
1501          * @property multiSortInfo
1502          * @type Object
1503          * Object containing overall sort direction and an ordered array of sorter configs used when sorting on multiple fields
1504          */
1505         this.multiSortInfo = {
1506             sorters  : sorters,
1507             direction: direction
1508         };
1509
1510         if (this.remoteSort) {
1511             this.singleSort(sorters[0].field, sorters[0].direction);
1512
1513         } else {
1514             this.applySort();
1515             this.fireEvent('datachanged', this);
1516         }
1517     },
1518
1519     <div id="method-Ext.data.Store-each"></div>/**
1520      * Calls the specified function for each of the {@link Ext.data.Record Records} in the cache.
1521      * @param {Function} fn The function to call. The {@link Ext.data.Record Record} is passed as the first parameter.
1522      * Returning <tt>false</tt> aborts and exits the iteration.
1523      * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed.
1524      * Defaults to the current {@link Ext.data.Record Record} in the iteration.
1525      */
1526     each : function(fn, scope){
1527         this.data.each(fn, scope);
1528     },
1529
1530     <div id="method-Ext.data.Store-getModifiedRecords"></div>/**
1531      * Gets all {@link Ext.data.Record records} modified since the last commit.  Modified records are
1532      * persisted across load operations (e.g., during paging). <b>Note</b>: deleted records are not
1533      * included.  See also <tt>{@link #pruneModifiedRecords}</tt> and
1534      * {@link Ext.data.Record}<tt>{@link Ext.data.Record#markDirty markDirty}.</tt>.
1535      * @return {Ext.data.Record[]} An array of {@link Ext.data.Record Records} containing outstanding
1536      * modifications.  To obtain modified fields within a modified record see
1537      *{@link Ext.data.Record}<tt>{@link Ext.data.Record#modified modified}.</tt>.
1538      */
1539     getModifiedRecords : function(){
1540         return this.modified;
1541     },
1542
1543     <div id="method-Ext.data.Store-sum"></div>/**
1544      * Sums the value of <tt>property</tt> for each {@link Ext.data.Record record} between <tt>start</tt>
1545      * and <tt>end</tt> and returns the result.
1546      * @param {String} property A field in each record
1547      * @param {Number} start (optional) The record index to start at (defaults to <tt>0</tt>)
1548      * @param {Number} end (optional) The last record index to include (defaults to length - 1)
1549      * @return {Number} The sum
1550      */
1551     sum : function(property, start, end){
1552         var rs = this.data.items, v = 0;
1553         start = start || 0;
1554         end = (end || end === 0) ? end : rs.length-1;
1555
1556         for(var i = start; i <= end; i++){
1557             v += (rs[i].data[property] || 0);
1558         }
1559         return v;
1560     },
1561
1562     /**
1563      * @private
1564      * Returns a filter function used to test a the given property's value. Defers most of the work to
1565      * Ext.util.MixedCollection's createValueMatcher function
1566      * @param {String} property The property to create the filter function for
1567      * @param {String/RegExp} value The string/regex to compare the property value to
1568      * @param {Boolean} anyMatch True if we don't care if the filter value is not the full value (defaults to false)
1569      * @param {Boolean} caseSensitive True to create a case-sensitive regex (defaults to false)
1570      * @param {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true.
1571      */
1572     createFilterFn : function(property, value, anyMatch, caseSensitive, exactMatch){
1573         if(Ext.isEmpty(value, false)){
1574             return false;
1575         }
1576         value = this.data.createValueMatcher(value, anyMatch, caseSensitive, exactMatch);
1577         return function(r) {
1578             return value.test(r.data[property]);
1579         };
1580     },
1581
1582     /**
1583      * @private
1584      * Given an array of filter functions (each with optional scope), constructs and returns a single function that returns
1585      * the result of all of the filters ANDed together
1586      * @param {Array} filters The array of filter objects (each object should contain an 'fn' and optional scope)
1587      * @return {Function} The multiple filter function
1588      */
1589     createMultipleFilterFn: function(filters) {
1590         return function(record) {
1591             var isMatch = true;
1592
1593             for (var i=0, j = filters.length; i < j; i++) {
1594                 var filter = filters[i],
1595                     fn     = filter.fn,
1596                     scope  = filter.scope;
1597
1598                 isMatch = isMatch && fn.call(scope, record);
1599             }
1600
1601             return isMatch;
1602         };
1603     },
1604
1605     <div id="method-Ext.data.Store-filter"></div>/**
1606      * Filter the {@link Ext.data.Record records} by a specified property. Alternatively, pass an array of filter
1607      * options to filter by more than one property.
1608      * Single filter example:
1609      * store.filter('name', 'Ed', true, true); //finds all records containing the substring 'Ed'
1610      * Multiple filter example:
1611      * <pre><code>
1612      * store.filter([
1613      *   {
1614      *     property     : 'name',
1615      *     value        : 'Ed',
1616      *     anyMatch     : true, //optional, defaults to true
1617      *     caseSensitive: true  //optional, defaults to true
1618      *   },
1619      *
1620      *   //filter functions can also be passed
1621      *   {
1622      *     fn   : function(record) {
1623      *       return record.get('age') == 24
1624      *     },
1625      *     scope: this
1626      *   }
1627      * ]);
1628      * </code></pre>
1629      * @param {String|Array} field A field on your records, or an array containing multiple filter options
1630      * @param {String/RegExp} value Either a string that the field should begin with, or a RegExp to test
1631      * against the field.
1632      * @param {Boolean} anyMatch (optional) <tt>true</tt> to match any part not just the beginning
1633      * @param {Boolean} caseSensitive (optional) <tt>true</tt> for case sensitive comparison
1634      * @param {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true.
1635      */
1636     filter : function(property, value, anyMatch, caseSensitive, exactMatch){
1637         //we can accept an array of filter objects, or a single filter object - normalize them here
1638         if (Ext.isObject(property)) {
1639             property = [property];
1640         }
1641
1642         if (Ext.isArray(property)) {
1643             var filters = [];
1644
1645             //normalize the filters passed into an array of filter functions
1646             for (var i=0, j = property.length; i < j; i++) {
1647                 var filter = property[i],
1648                     func   = filter.fn,
1649                     scope  = filter.scope || this;
1650
1651                 //if we weren't given a filter function, construct one now
1652                 if (!Ext.isFunction(func)) {
1653                     func = this.createFilterFn(filter.property, filter.value, filter.anyMatch, filter.caseSensitive, filter.exactMatch);
1654                 }
1655
1656                 filters.push({fn: func, scope: scope});
1657             }
1658
1659             var fn = this.createMultipleFilterFn(filters);
1660         } else {
1661             //classic single property filter
1662             var fn = this.createFilterFn(property, value, anyMatch, caseSensitive, exactMatch);
1663         }
1664
1665         return fn ? this.filterBy(fn) : this.clearFilter();
1666     },
1667
1668     <div id="method-Ext.data.Store-filterBy"></div>/**
1669      * Filter by a function. The specified function will be called for each
1670      * Record in this Store. If the function returns <tt>true</tt> the Record is included,
1671      * otherwise it is filtered out.
1672      * @param {Function} fn The function to be called. It will be passed the following parameters:<ul>
1673      * <li><b>record</b> : Ext.data.Record<p class="sub-desc">The {@link Ext.data.Record record}
1674      * to test for filtering. Access field values using {@link Ext.data.Record#get}.</p></li>
1675      * <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
1676      * </ul>
1677      * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.
1678      */
1679     filterBy : function(fn, scope){
1680         this.snapshot = this.snapshot || this.data;
1681         this.data = this.queryBy(fn, scope||this);
1682         this.fireEvent('datachanged', this);
1683     },
1684
1685     <div id="method-Ext.data.Store-clearFilter"></div>/**
1686      * Revert to a view of the Record cache with no filtering applied.
1687      * @param {Boolean} suppressEvent If <tt>true</tt> the filter is cleared silently without firing the
1688      * {@link #datachanged} event.
1689      */
1690     clearFilter : function(suppressEvent){
1691         if(this.isFiltered()){
1692             this.data = this.snapshot;
1693             delete this.snapshot;
1694             if(suppressEvent !== true){
1695                 this.fireEvent('datachanged', this);
1696             }
1697         }
1698     },
1699
1700     <div id="method-Ext.data.Store-isFiltered"></div>/**
1701      * Returns true if this store is currently filtered
1702      * @return {Boolean}
1703      */
1704     isFiltered : function(){
1705         return !!this.snapshot && this.snapshot != this.data;
1706     },
1707
1708     <div id="method-Ext.data.Store-query"></div>/**
1709      * Query the records by a specified property.
1710      * @param {String} field A field on your records
1711      * @param {String/RegExp} value Either a string that the field
1712      * should begin with, or a RegExp to test against the field.
1713      * @param {Boolean} anyMatch (optional) True to match any part not just the beginning
1714      * @param {Boolean} caseSensitive (optional) True for case sensitive comparison
1715      * @return {MixedCollection} Returns an Ext.util.MixedCollection of the matched records
1716      */
1717     query : function(property, value, anyMatch, caseSensitive){
1718         var fn = this.createFilterFn(property, value, anyMatch, caseSensitive);
1719         return fn ? this.queryBy(fn) : this.data.clone();
1720     },
1721
1722     <div id="method-Ext.data.Store-queryBy"></div>/**
1723      * Query the cached records in this Store using a filtering function. The specified function
1724      * will be called with each record in this Store. If the function returns <tt>true</tt> the record is
1725      * included in the results.
1726      * @param {Function} fn The function to be called. It will be passed the following parameters:<ul>
1727      * <li><b>record</b> : Ext.data.Record<p class="sub-desc">The {@link Ext.data.Record record}
1728      * to test for filtering. Access field values using {@link Ext.data.Record#get}.</p></li>
1729      * <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
1730      * </ul>
1731      * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.
1732      * @return {MixedCollection} Returns an Ext.util.MixedCollection of the matched records
1733      **/
1734     queryBy : function(fn, scope){
1735         var data = this.snapshot || this.data;
1736         return data.filterBy(fn, scope||this);
1737     },
1738
1739     <div id="method-Ext.data.Store-find"></div>/**
1740      * Finds the index of the first matching Record in this store by a specific field value.
1741      * @param {String} fieldName The name of the Record field to test.
1742      * @param {String/RegExp} value Either a string that the field value
1743      * should begin with, or a RegExp to test against the field.
1744      * @param {Number} startIndex (optional) The index to start searching at
1745      * @param {Boolean} anyMatch (optional) True to match any part of the string, not just the beginning
1746      * @param {Boolean} caseSensitive (optional) True for case sensitive comparison
1747      * @return {Number} The matched index or -1
1748      */
1749     find : function(property, value, start, anyMatch, caseSensitive){
1750         var fn = this.createFilterFn(property, value, anyMatch, caseSensitive);
1751         return fn ? this.data.findIndexBy(fn, null, start) : -1;
1752     },
1753
1754     <div id="method-Ext.data.Store-findExact"></div>/**
1755      * Finds the index of the first matching Record in this store by a specific field value.
1756      * @param {String} fieldName The name of the Record field to test.
1757      * @param {Mixed} value The value to match the field against.
1758      * @param {Number} startIndex (optional) The index to start searching at
1759      * @return {Number} The matched index or -1
1760      */
1761     findExact: function(property, value, start){
1762         return this.data.findIndexBy(function(rec){
1763             return rec.get(property) === value;
1764         }, this, start);
1765     },
1766
1767     <div id="method-Ext.data.Store-findBy"></div>/**
1768      * Find the index of the first matching Record in this Store by a function.
1769      * If the function returns <tt>true</tt> it is considered a match.
1770      * @param {Function} fn The function to be called. It will be passed the following parameters:<ul>
1771      * <li><b>record</b> : Ext.data.Record<p class="sub-desc">The {@link Ext.data.Record record}
1772      * to test for filtering. Access field values using {@link Ext.data.Record#get}.</p></li>
1773      * <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
1774      * </ul>
1775      * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.
1776      * @param {Number} startIndex (optional) The index to start searching at
1777      * @return {Number} The matched index or -1
1778      */
1779     findBy : function(fn, scope, start){
1780         return this.data.findIndexBy(fn, scope, start);
1781     },
1782
1783     <div id="method-Ext.data.Store-collect"></div>/**
1784      * Collects unique values for a particular dataIndex from this store.
1785      * @param {String} dataIndex The property to collect
1786      * @param {Boolean} allowNull (optional) Pass true to allow null, undefined or empty string values
1787      * @param {Boolean} bypassFilter (optional) Pass true to collect from all records, even ones which are filtered
1788      * @return {Array} An array of the unique values
1789      **/
1790     collect : function(dataIndex, allowNull, bypassFilter){
1791         var d = (bypassFilter === true && this.snapshot) ?
1792                 this.snapshot.items : this.data.items;
1793         var v, sv, r = [], l = {};
1794         for(var i = 0, len = d.length; i < len; i++){
1795             v = d[i].data[dataIndex];
1796             sv = String(v);
1797             if((allowNull || !Ext.isEmpty(v)) && !l[sv]){
1798                 l[sv] = true;
1799                 r[r.length] = v;
1800             }
1801         }
1802         return r;
1803     },
1804
1805     // private
1806     afterEdit : function(record){
1807         if(this.modified.indexOf(record) == -1){
1808             this.modified.push(record);
1809         }
1810         this.fireEvent('update', this, record, Ext.data.Record.EDIT);
1811     },
1812
1813     // private
1814     afterReject : function(record){
1815         this.modified.remove(record);
1816         this.fireEvent('update', this, record, Ext.data.Record.REJECT);
1817     },
1818
1819     // private
1820     afterCommit : function(record){
1821         this.modified.remove(record);
1822         this.fireEvent('update', this, record, Ext.data.Record.COMMIT);
1823     },
1824
1825     <div id="method-Ext.data.Store-commitChanges"></div>/**
1826      * Commit all Records with {@link #getModifiedRecords outstanding changes}. To handle updates for changes,
1827      * subscribe to the Store's {@link #update update event}, and perform updating when the third parameter is
1828      * Ext.data.Record.COMMIT.
1829      */
1830     commitChanges : function(){
1831         var m = this.modified.slice(0);
1832         this.modified = [];
1833         for(var i = 0, len = m.length; i < len; i++){
1834             m[i].commit();
1835         }
1836     },
1837
1838     <div id="method-Ext.data.Store-rejectChanges"></div>/**
1839      * {@link Ext.data.Record#reject Reject} outstanding changes on all {@link #getModifiedRecords modified records}.
1840      */
1841     rejectChanges : function(){
1842         var m = this.modified.slice(0);
1843         this.modified = [];
1844         for(var i = 0, len = m.length; i < len; i++){
1845             m[i].reject();
1846         }
1847         var m = this.removed.slice(0).reverse();
1848         this.removed = [];
1849         for(var i = 0, len = m.length; i < len; i++){
1850             this.insert(m[i].lastIndex||0, m[i]);
1851             m[i].reject();
1852         }
1853     },
1854
1855     // private
1856     onMetaChange : function(meta){
1857         this.recordType = this.reader.recordType;
1858         this.fields = this.recordType.prototype.fields;
1859         delete this.snapshot;
1860         if(this.reader.meta.sortInfo){
1861             this.sortInfo = this.reader.meta.sortInfo;
1862         }else if(this.sortInfo  && !this.fields.get(this.sortInfo.field)){
1863             delete this.sortInfo;
1864         }
1865         if(this.writer){
1866             this.writer.meta = this.reader.meta;
1867         }
1868         this.modified = [];
1869         this.fireEvent('metachange', this, this.reader.meta);
1870     },
1871
1872     // private
1873     findInsertIndex : function(record){
1874         this.suspendEvents();
1875         var data = this.data.clone();
1876         this.data.add(record);
1877         this.applySort();
1878         var index = this.data.indexOf(record);
1879         this.data = data;
1880         this.resumeEvents();
1881         return index;
1882     },
1883
1884     <div id="method-Ext.data.Store-setBaseParam"></div>/**
1885      * Set the value for a property name in this store's {@link #baseParams}.  Usage:</p><pre><code>
1886 myStore.setBaseParam('foo', {bar:3});
1887 </code></pre>
1888      * @param {String} name Name of the property to assign
1889      * @param {Mixed} value Value to assign the <tt>name</tt>d property
1890      **/
1891     setBaseParam : function (name, value){
1892         this.baseParams = this.baseParams || {};
1893         this.baseParams[name] = value;
1894     }
1895 });
1896
1897 Ext.reg('store', Ext.data.Store);
1898
1899 <div id="cls-Ext.data.Store.Error"></div>/**
1900  * @class Ext.data.Store.Error
1901  * @extends Ext.Error
1902  * Store Error extension.
1903  * @param {String} name
1904  */
1905 Ext.data.Store.Error = Ext.extend(Ext.Error, {
1906     name: 'Ext.data.Store'
1907 });
1908 Ext.apply(Ext.data.Store.Error.prototype, {
1909     lang: {
1910         'writer-undefined' : 'Attempted to execute a write-action without a DataWriter installed.'
1911     }
1912 });
1913 </pre>
1914 </body>
1915 </html>