Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / src / data / DirectStore.js
1 /*!
2  * Ext JS Library 3.1.0
3  * Copyright(c) 2006-2009 Ext JS, LLC
4  * licensing@extjs.com
5  * http://www.extjs.com/license
6  */
7 /**\r
8  * @class Ext.data.DirectStore\r
9  * @extends Ext.data.Store\r
10  * <p>Small helper class to create an {@link Ext.data.Store} configured with an\r
11  * {@link Ext.data.DirectProxy} and {@link Ext.data.JsonReader} to make interacting\r
12  * with an {@link Ext.Direct} Server-side {@link Ext.direct.Provider Provider} easier.\r
13  * To create a different proxy/reader combination create a basic {@link Ext.data.Store}\r
14  * configured as needed.</p>\r
15  *\r
16  * <p><b>*Note:</b> Although they are not listed, this class inherits all of the config options of:</p>\r
17  * <div><ul class="mdetail-params">\r
18  * <li><b>{@link Ext.data.Store Store}</b></li>\r
19  * <div class="sub-desc"><ul class="mdetail-params">\r
20  *\r
21  * </ul></div>\r
22  * <li><b>{@link Ext.data.JsonReader JsonReader}</b></li>\r
23  * <div class="sub-desc"><ul class="mdetail-params">\r
24  * <li><tt><b>{@link Ext.data.JsonReader#root root}</b></tt></li>\r
25  * <li><tt><b>{@link Ext.data.JsonReader#idProperty idProperty}</b></tt></li>\r
26  * <li><tt><b>{@link Ext.data.JsonReader#totalProperty totalProperty}</b></tt></li>\r
27  * </ul></div>\r
28  *\r
29  * <li><b>{@link Ext.data.DirectProxy DirectProxy}</b></li>\r
30  * <div class="sub-desc"><ul class="mdetail-params">\r
31  * <li><tt><b>{@link Ext.data.DirectProxy#directFn directFn}</b></tt></li>\r
32  * <li><tt><b>{@link Ext.data.DirectProxy#paramOrder paramOrder}</b></tt></li>\r
33  * <li><tt><b>{@link Ext.data.DirectProxy#paramsAsHash paramsAsHash}</b></tt></li>\r
34  * </ul></div>\r
35  * </ul></div>\r
36  *\r
37  * @xtype directstore\r
38  *\r
39  * @constructor\r
40  * @param {Object} config\r
41  */\r
42 Ext.data.DirectStore = function(c){\r
43     // each transaction upon a singe record will generatie a distinct Direct transaction since Direct queues them into one Ajax request.\r
44     c.batchTransactions = false;\r
45 \r
46     Ext.data.DirectStore.superclass.constructor.call(this, Ext.apply(c, {\r
47         proxy: (typeof(c.proxy) == 'undefined') ? new Ext.data.DirectProxy(Ext.copyTo({}, c, 'paramOrder,paramsAsHash,directFn,api')) : c.proxy,\r
48         reader: (typeof(c.reader) == 'undefined' && typeof(c.fields) == 'object') ? new Ext.data.JsonReader(Ext.copyTo({}, c, 'totalProperty,root,idProperty'), c.fields) : c.reader\r
49     }));\r
50 };\r
51 Ext.extend(Ext.data.DirectStore, Ext.data.Store, {});\r
52 Ext.reg('directstore', Ext.data.DirectStore);