Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / source / DirectStore.html
1 <!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-data.DirectStore-method-constructor'><span id='Ext-data.DirectStore'>/**
2 </span></span> * @class Ext.data.DirectStore
3  * @extends Ext.data.Store
4  * &lt;p&gt;Small helper class to create an {@link Ext.data.Store} configured with an
5  * {@link Ext.data.proxy.Direct} and {@link Ext.data.reader.Json} to make interacting
6  * with an {@link Ext.Direct} Server-side {@link Ext.direct.Provider Provider} easier.
7  * To create a different proxy/reader combination create a basic {@link Ext.data.Store}
8  * configured as needed.&lt;/p&gt;
9  *
10  * &lt;p&gt;&lt;b&gt;*Note:&lt;/b&gt; Although they are not listed, this class inherits all of the config options of:&lt;/p&gt;
11  * &lt;div&gt;&lt;ul class=&quot;mdetail-params&quot;&gt;
12  * &lt;li&gt;&lt;b&gt;{@link Ext.data.Store Store}&lt;/b&gt;&lt;/li&gt;
13  * &lt;div class=&quot;sub-desc&quot;&gt;&lt;ul class=&quot;mdetail-params&quot;&gt;
14  *
15  * &lt;/ul&gt;&lt;/div&gt;
16  * &lt;li&gt;&lt;b&gt;{@link Ext.data.reader.Json JsonReader}&lt;/b&gt;&lt;/li&gt;
17  * &lt;div class=&quot;sub-desc&quot;&gt;&lt;ul class=&quot;mdetail-params&quot;&gt;
18  * &lt;li&gt;&lt;tt&gt;&lt;b&gt;{@link Ext.data.reader.Json#root root}&lt;/b&gt;&lt;/tt&gt;&lt;/li&gt;
19  * &lt;li&gt;&lt;tt&gt;&lt;b&gt;{@link Ext.data.reader.Json#idProperty idProperty}&lt;/b&gt;&lt;/tt&gt;&lt;/li&gt;
20  * &lt;li&gt;&lt;tt&gt;&lt;b&gt;{@link Ext.data.reader.Json#totalProperty totalProperty}&lt;/b&gt;&lt;/tt&gt;&lt;/li&gt;
21  * &lt;/ul&gt;&lt;/div&gt;
22  *
23  * &lt;li&gt;&lt;b&gt;{@link Ext.data.proxy.Direct DirectProxy}&lt;/b&gt;&lt;/li&gt;
24  * &lt;div class=&quot;sub-desc&quot;&gt;&lt;ul class=&quot;mdetail-params&quot;&gt;
25  * &lt;li&gt;&lt;tt&gt;&lt;b&gt;{@link Ext.data.proxy.Direct#directFn directFn}&lt;/b&gt;&lt;/tt&gt;&lt;/li&gt;
26  * &lt;li&gt;&lt;tt&gt;&lt;b&gt;{@link Ext.data.proxy.Direct#paramOrder paramOrder}&lt;/b&gt;&lt;/tt&gt;&lt;/li&gt;
27  * &lt;li&gt;&lt;tt&gt;&lt;b&gt;{@link Ext.data.proxy.Direct#paramsAsHash paramsAsHash}&lt;/b&gt;&lt;/tt&gt;&lt;/li&gt;
28  * &lt;/ul&gt;&lt;/div&gt;
29  * &lt;/ul&gt;&lt;/div&gt;
30  *
31  * @constructor
32  * @param {Object} config
33  */
34
35 Ext.define('Ext.data.DirectStore', {
36     /* Begin Definitions */
37     
38     extend: 'Ext.data.Store',
39     
40     alias: 'store.direct',
41     
42     requires: ['Ext.data.proxy.Direct'],
43    
44     /* End Definitions */
45    
46    constructor : function(config){
47         config = Ext.apply({}, config);
48         if (!config.proxy) {
49             var proxy = {
50                 type: 'direct',
51                 reader: {
52                     type: 'json'
53                 }
54             };
55             Ext.copyTo(proxy, config, 'paramOrder,paramsAsHash,directFn,api,simpleSortMode');
56             Ext.copyTo(proxy.reader, config, 'totalProperty,root,idProperty');
57             config.proxy = proxy;
58         }
59         this.callParent([config]);
60     }    
61 });
62 </pre></pre></body></html>