view release on metacpan or  search on metacpan

share/docs/source/Store.html  view on Meta::CPAN

<span id='Ext-data-Store-cfg-remoteSort'>    /**
</span>     * @cfg {boolean} remoteSort &lt;tt&gt;true&lt;/tt&gt; if sorting is to be handled by requesting the &lt;tt&gt;{@link #proxy Proxy}&lt;/tt&gt;
     * to provide a refreshed version of the data object in sorted order, as opposed to sorting the Record cache
     * in place (defaults to &lt;tt&gt;false&lt;/tt&gt;).
     * &lt;p&gt;If &lt;tt&gt;remoteSort&lt;/tt&gt; is &lt;tt&gt;true&lt;/tt&gt;, then clicking on a {@link Ext.grid.Column Grid Column}'s
     * {@link Ext.grid.Column#header header} causes the current page to be requested from the server appending
     * the following two parameters to the &lt;b&gt;&lt;tt&gt;{@link #load params}&lt;/tt&gt;&lt;/b&gt;:&lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
     * &lt;li&gt;&lt;b&gt;&lt;tt&gt;sort&lt;/tt&gt;&lt;/b&gt; : String&lt;p class=&quot;sub-desc&quot;&gt;The &lt;tt&gt;name&lt;/tt&gt; (as specified in the Record's
     * {@link Ext.data.Field Field definition}) of the field to sort on.&lt;/p&gt;&lt;/li&gt;
     * &lt;li&gt;&lt;b&gt;&lt;tt&gt;dir&lt;/tt&gt;&lt;/b&gt; : String&lt;p class=&quot;sub-desc&quot;&gt;The direction of the sort, 'ASC' or 'DESC' (case-sensitive).&lt;/p&gt;&lt;/li&gt;
     * &lt;/ul&gt;&lt;/div&gt;&lt;/p&gt;
     */
    remoteSort : false,

<span id='Ext-data-Store-cfg-autoDestroy'>    /**
</span>     * @cfg {Boolean} autoDestroy &lt;tt&gt;true&lt;/tt&gt; to destroy the store when the component the store is bound
     * to is destroyed (defaults to &lt;tt&gt;false&lt;/tt&gt;).
     * &lt;p&gt;&lt;b&gt;Note&lt;/b&gt;: this should be set to true when using stores that are bound to only 1 component.&lt;/p&gt;
     */
    autoDestroy : false,

<span id='Ext-data-Store-cfg-pruneModifiedRecords'>    /**
</span>     * @cfg {Boolean} pruneModifiedRecords &lt;tt&gt;true&lt;/tt&gt; to clear all modified record information each time
     * the store is loaded or when a record is removed (defaults to &lt;tt&gt;false&lt;/tt&gt;). See {@link #getModifiedRecords}
     * for the accessor method to retrieve the modified records.
     */
    pruneModifiedRecords : false,

<span id='Ext-data-Store-property-lastOptions'>    /**
</span>     * Contains the last options object used as the parameter to the {@link #load} method. See {@link #load}
     * for the details of what this may contain. This may be useful for accessing any params which were used
     * to load the current Record cache.
     * @property
     */
    lastOptions : null,

<span id='Ext-data-Store-cfg-autoSave'>    /**
</span>     * @cfg {Boolean} autoSave
     * &lt;p&gt;Defaults to &lt;tt&gt;true&lt;/tt&gt; causing the store to automatically {@link #save} records to
     * the server when a record is modified (ie: becomes 'dirty'). Specify &lt;tt&gt;false&lt;/tt&gt; to manually call {@link #save}
     * to send all modifiedRecords to the server.&lt;/p&gt;
     * &lt;br&gt;&lt;p&gt;&lt;b&gt;Note&lt;/b&gt;: each CRUD action will be sent as a separate request.&lt;/p&gt;
     */
    autoSave : true,

<span id='Ext-data-Store-cfg-batch'>    /**
</span>     * @cfg {Boolean} batch
     * &lt;p&gt;Defaults to &lt;tt&gt;true&lt;/tt&gt; (unless &lt;code&gt;{@link #restful}:true&lt;/code&gt;). Multiple
     * requests for each CRUD action (CREATE, READ, UPDATE and DESTROY) will be combined
     * and sent as one transaction. Only applies when &lt;code&gt;{@link #autoSave}&lt;/code&gt; is set
     * to &lt;tt&gt;false&lt;/tt&gt;.&lt;/p&gt;
     * &lt;br&gt;&lt;p&gt;If Store is RESTful, the DataProxy is also RESTful, and a unique transaction is
     * generated for each record.&lt;/p&gt;
     */
    batch : true,

<span id='Ext-data-Store-cfg-restful'>    /**
</span>     * @cfg {Boolean} restful
     * Defaults to &lt;tt&gt;false&lt;/tt&gt;.  Set to &lt;tt&gt;true&lt;/tt&gt; to have the Store and the set
     * Proxy operate in a RESTful manner. The store will automatically generate GET, POST,
     * PUT and DELETE requests to the server. The HTTP method used for any given CRUD
     * action is described in {@link Ext.data.Api#restActions}.  For additional information
     * see {@link Ext.data.DataProxy#restful}.
     * &lt;p&gt;&lt;b&gt;Note&lt;/b&gt;: if &lt;code&gt;{@link #restful}:true&lt;/code&gt; &lt;code&gt;batch&lt;/code&gt; will
     * internally be set to &lt;tt&gt;false&lt;/tt&gt;.&lt;/p&gt;
     */
    restful: false,

<span id='Ext-data-Store-cfg-paramNames'>    /**
</span>     * @cfg {Object} paramNames
     * &lt;p&gt;An object containing properties which specify the names of the paging and
     * sorting parameters passed to remote servers when loading blocks of data. By default, this
     * object takes the following form:&lt;/p&gt;&lt;pre&gt;&lt;code&gt;
{
    start : 'start',  // The parameter name which specifies the start row
    limit : 'limit',  // The parameter name which specifies number of rows to return
    sort : 'sort',    // The parameter name which specifies the column to sort on
    dir : 'dir'       // The parameter name which specifies the sort direction
}
&lt;/code&gt;&lt;/pre&gt;
     * &lt;p&gt;The server must produce the requested data block upon receipt of these parameter names.
     * If different parameter names are required, this property can be overriden using a configuration
     * property.&lt;/p&gt;
     * &lt;p&gt;A {@link Ext.PagingToolbar PagingToolbar} bound to this Store uses this property to determine
     * the parameter names to use in its {@link #load requests}.
     */
    paramNames : undefined,

<span id='Ext-data-Store-cfg-defaultParamNames'>    /**
</span>     * @cfg {Object} defaultParamNames
     * Provides the default values for the {@link #paramNames} property. To globally modify the parameters
     * for all stores, this object should be changed on the store prototype.
     */
    defaultParamNames : {
        start : 'start',
        limit : 'limit',
        sort : 'sort',
        dir : 'dir'
    },

<span id='Ext-data-Store-property-isDestroyed'>    isDestroyed: false,
</span><span id='Ext-data-Store-property-hasMultiSort'>    hasMultiSort: false,
</span>
<span id='Ext-data-Store-property-batchKey'>    // private
</span>    batchKey : '_ext_batch_',

    constructor : function(config){
<span id='Ext-data-Store-property-hasMultiSort'>        /**
</span>         * @property hasMultiSort
         * @type Boolean
         * True if this store is currently sorted by more than one field/direction combination.
         */

<span id='Ext-data-Store-property-isDestroyed'>        /**
</span>         * @property isDestroyed
         * @type Boolean
         * True if the store has been destroyed already. Read only
         */

        this.data = new Ext.util.MixedCollection(false);
        this.data.getKey = function(o){