AbstractStore is a superclass of {@link Ext.data.Store} and {@link Ext.data.TreeStore}. It's never used directly, - * but offers a set of methods used by both of those subclasses.
+ * AbstractStore is a superclass of {@link Ext.data.Store} and {@link Ext.data.TreeStore}. It's never used directly, + * but offers a set of methods used by both of those subclasses. * - *We've left it here in the docs for reference purposes, but unless you need to make a whole new type of Store, what + * We've left it here in the docs for reference purposes, but unless you need to make a whole new type of Store, what * you're probably looking for is {@link Ext.data.Store}. If you're still interested, here's a brief description of what - * AbstractStore is and is not.
+ * AbstractStore is and is not. * - *AbstractStore provides the basic configuration for anything that can be considered a Store. It expects to be + * AbstractStore provides the basic configuration for anything that can be considered a Store. It expects to be * given a {@link Ext.data.Model Model} that represents the type of data in the Store. It also expects to be given a - * {@link Ext.data.proxy.Proxy Proxy} that handles the loading of data into the Store.
+ * {@link Ext.data.proxy.Proxy Proxy} that handles the loading of data into the Store. * - *AbstractStore provides a few helpful methods such as {@link #load} and {@link #sync}, which load and save data + * AbstractStore provides a few helpful methods such as {@link #load} and {@link #sync}, which load and save data * respectively, passing the requests through the configured {@link #proxy}. Both built-in Store subclasses add extra * behavior to each of these functions. Note also that each AbstractStore subclass has its own way of storing data - * in {@link Ext.data.Store} the data is saved as a flat {@link Ext.util.MixedCollection MixedCollection}, whereas in - * {@link Ext.data.TreeStore TreeStore} we use a {@link Ext.data.Tree} to maintain the data's hierarchy.
+ * {@link Ext.data.TreeStore TreeStore} we use a {@link Ext.data.Tree} to maintain the data's hierarchy. * * The store provides filtering and sorting support. This sorting/filtering can happen on the client side - * or can be completed on the server. This is controlled by the {@link #remoteSort} and (@link #remoteFilter{ config - * options. For more information see the {@link #sort} and {@link #filter} methods. + * or can be completed on the server. This is controlled by the {@link Ext.data.Store#remoteSort remoteSort} and + * {@link Ext.data.Store#remoteFilter remoteFilter} config options. For more information see the {@link #sort} and + * {@link Ext.data.Store#filter filter} methods. */ Ext.define('Ext.data.AbstractStore', { requires: ['Ext.util.MixedCollection', 'Ext.data.Operation', 'Ext.util.Filter'], @@ -61,87 +61,92 @@ Ext.define('Ext.data.AbstractStore', { remoteFilter: false, /** - * @cfg {String/Ext.data.proxy.Proxy/Object} proxy The Proxy to use for this Store. This can be either a string, a config - * object or a Proxy instance - see {@link #setProxy} for details. + * @cfg {String/Ext.data.proxy.Proxy/Object} proxy + * The Proxy to use for this Store. This can be either a string, a config object or a Proxy instance - + * see {@link #setProxy} for details. */ /** - * @cfg {Boolean/Object} autoLoad If data is not specified, and if autoLoad is true or an Object, this store's load method - * is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's - * load method. Defaults to false. + * @cfg {Boolean/Object} autoLoad + * If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called + * after creation. If the value of autoLoad is an Object, this Object will be passed to the store's load method. + * Defaults to false. */ autoLoad: false, /** - * @cfg {Boolean} autoSync True to automatically sync the Store with its Proxy after every edit to one of its Records. - * Defaults to false. + * @cfg {Boolean} autoSync + * True to automatically sync the Store with its Proxy after every edit to one of its Records. Defaults to false. */ autoSync: false, /** + * @property {String} batchUpdateMode * Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's * internal representation of the data after each operation of the batch has completed, 'complete' will wait until * the entire batch has been completed before updating the Store's data. 'complete' is a good choice for local * storage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency. - * @property batchUpdateMode - * @type String */ batchUpdateMode: 'operation', /** + * @property {Boolean} filterOnLoad * If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. - * Defaults to true, ignored if {@link #remoteFilter} is true - * @property filterOnLoad - * @type Boolean + * Defaults to true, ignored if {@link Ext.data.Store#remoteFilter remoteFilter} is true */ filterOnLoad: true, /** + * @property {Boolean} sortOnLoad * If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. - * Defaults to true, igored if {@link #remoteSort} is true - * @property sortOnLoad - * @type Boolean + * Defaults to true, igored if {@link Ext.data.Store#remoteSort remoteSort} is true */ sortOnLoad: true, /** - * True if a model was created implicitly for this Store. This happens if a fields array is passed to the Store's constructor - * instead of a model constructor or name. - * @property implicitModel - * @type Boolean + * @property {Boolean} implicitModel + * True if a model was created implicitly for this Store. This happens if a fields array is passed to the Store's + * constructor instead of a model constructor or name. * @private */ implicitModel: false, /** - * The string type of the Proxy to create if none is specified. This defaults to creating a {@link Ext.data.proxy.Memory memory proxy}. - * @property defaultProxyType - * @type String + * @property {String} defaultProxyType + * The string type of the Proxy to create if none is specified. This defaults to creating a + * {@link Ext.data.proxy.Memory memory proxy}. */ defaultProxyType: 'memory', /** - * True if the Store has already been destroyed via {@link #destroyStore}. If this is true, the reference to Store should be deleted + * @property {Boolean} isDestroyed + * True if the Store has already been destroyed. If this is true, the reference to Store should be deleted * as it will not function correctly any more. - * @property isDestroyed - * @type Boolean */ isDestroyed: false, isStore: true, /** - * @cfg {String} storeId Optional unique identifier for this store. If present, this Store will be registered with - * the {@link Ext.data.StoreManager}, making it easy to reuse elsewhere. Defaults to undefined. + * @cfg {String} storeId + * Unique identifier for this store. If present, this Store will be registered with the {@link Ext.data.StoreManager}, + * making it easy to reuse elsewhere. Defaults to undefined. */ /** - * @cfg {Array} fields + * @cfg {Object[]} fields * This may be used in place of specifying a {@link #model} configuration. The fields should be a * set of {@link Ext.data.Field} configuration objects. The store will automatically create a {@link Ext.data.Model} * with these fields. In general this configuration option should be avoided, it exists for the purposes of * backwards compatibility. For anything more complicated, such as specifying a particular id property or - * assocations, a {@link Ext.data.Model} should be defined and specified for the {@link #model} config. + * assocations, a {@link Ext.data.Model} should be defined and specified for the {@link #model} + * config. + */ + + /** + * @cfg {String} model + * Name of the {@link Ext.data.Model Model} associated with this store. + * The string is used as an argument for {@link Ext.ModelManager#getModel}. */ sortRoot: 'data', @@ -156,7 +161,7 @@ Ext.define('Ext.data.AbstractStore', { * @event add * Fired when a Model instance has been added to this Store * @param {Ext.data.Store} store The store - * @param {Array} records The Model instances that were added + * @param {Ext.data.Model[]} records The Model instances that were added * @param {Number} index The index at which the instances were inserted */ 'add', @@ -172,31 +177,32 @@ Ext.define('Ext.data.AbstractStore', { /** * @event update - * Fires when a Record has been updated - * @param {Store} this + * Fires when a Model instance has been updated + * @param {Ext.data.Store} this * @param {Ext.data.Model} record The Model instance that was updated * @param {String} operation The update operation being performed. Value may be one of: - *
- Ext.data.Model.EDIT
- Ext.data.Model.REJECT
- Ext.data.Model.COMMIT
- *