Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / source / DirectStore.html
index 75933ac..dd6e33a 100644 (file)
@@ -1,56 +1,62 @@
-<html>\r
-<head>\r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js"><div id="cls-Ext.data.DirectStore"></div>/**\r
- * @class Ext.data.DirectStore\r
- * @extends Ext.data.Store\r
- * <p>Small helper class to create an {@link Ext.data.Store} configured with an\r
- * {@link Ext.data.DirectProxy} and {@link Ext.data.JsonReader} to make interacting\r
- * with an {@link Ext.Direct} Server-side {@link Ext.direct.Provider Provider} easier.\r
- * To create a different proxy/reader combination create a basic {@link Ext.data.Store}\r
- * configured as needed.</p>\r
- *\r
- * <p><b>*Note:</b> Although they are not listed, this class inherits all of the config options of:</p>\r
- * <div><ul class="mdetail-params">\r
- * <li><b>{@link Ext.data.Store Store}</b></li>\r
- * <div class="sub-desc"><ul class="mdetail-params">\r
- *\r
- * </ul></div>\r
- * <li><b>{@link Ext.data.JsonReader JsonReader}</b></li>\r
- * <div class="sub-desc"><ul class="mdetail-params">\r
- * <li><tt><b>{@link Ext.data.JsonReader#root root}</b></tt></li>\r
- * <li><tt><b>{@link Ext.data.JsonReader#idProperty idProperty}</b></tt></li>\r
- * <li><tt><b>{@link Ext.data.JsonReader#totalProperty totalProperty}</b></tt></li>\r
- * </ul></div>\r
- *\r
- * <li><b>{@link Ext.data.DirectProxy DirectProxy}</b></li>\r
- * <div class="sub-desc"><ul class="mdetail-params">\r
- * <li><tt><b>{@link Ext.data.DirectProxy#directFn directFn}</b></tt></li>\r
- * <li><tt><b>{@link Ext.data.DirectProxy#paramOrder paramOrder}</b></tt></li>\r
- * <li><tt><b>{@link Ext.data.DirectProxy#paramsAsHash paramsAsHash}</b></tt></li>\r
- * </ul></div>\r
- * </ul></div>\r
- *\r
- * @xtype directstore\r
- *\r
- * @constructor\r
- * @param {Object} config\r
- */\r
-Ext.data.DirectStore = function(c){\r
-    // each transaction upon a singe record will generatie a distinct Direct transaction since Direct queues them into one Ajax request.\r
-    c.batchTransactions = false;\r
-\r
-    Ext.data.DirectStore.superclass.constructor.call(this, Ext.apply(c, {\r
-        proxy: (typeof(c.proxy) == 'undefined') ? new Ext.data.DirectProxy(Ext.copyTo({}, c, 'paramOrder,paramsAsHash,directFn,api')) : c.proxy,\r
-        reader: (typeof(c.reader) == 'undefined' && typeof(c.fields) == 'object') ? new Ext.data.JsonReader(Ext.copyTo({}, c, 'totalProperty,root,idProperty'), c.fields) : c.reader\r
-    }));\r
-};\r
-Ext.extend(Ext.data.DirectStore, Ext.data.Store, {});\r
-Ext.reg('directstore', Ext.data.DirectStore);
-</pre>    \r
-</body>\r
-</html>
\ No newline at end of file
+<!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'>/**
+</span></span> * @class Ext.data.DirectStore
+ * @extends Ext.data.Store
+ * &lt;p&gt;Small helper class to create an {@link Ext.data.Store} configured with an
+ * {@link Ext.data.proxy.Direct} and {@link Ext.data.reader.Json} to make interacting
+ * with an {@link Ext.Direct} Server-side {@link Ext.direct.Provider Provider} easier.
+ * To create a different proxy/reader combination create a basic {@link Ext.data.Store}
+ * configured as needed.&lt;/p&gt;
+ *
+ * &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;
+ * &lt;div&gt;&lt;ul class=&quot;mdetail-params&quot;&gt;
+ * &lt;li&gt;&lt;b&gt;{@link Ext.data.Store Store}&lt;/b&gt;&lt;/li&gt;
+ * &lt;div class=&quot;sub-desc&quot;&gt;&lt;ul class=&quot;mdetail-params&quot;&gt;
+ *
+ * &lt;/ul&gt;&lt;/div&gt;
+ * &lt;li&gt;&lt;b&gt;{@link Ext.data.reader.Json JsonReader}&lt;/b&gt;&lt;/li&gt;
+ * &lt;div class=&quot;sub-desc&quot;&gt;&lt;ul class=&quot;mdetail-params&quot;&gt;
+ * &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;
+ * &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;
+ * &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;
+ * &lt;/ul&gt;&lt;/div&gt;
+ *
+ * &lt;li&gt;&lt;b&gt;{@link Ext.data.proxy.Direct DirectProxy}&lt;/b&gt;&lt;/li&gt;
+ * &lt;div class=&quot;sub-desc&quot;&gt;&lt;ul class=&quot;mdetail-params&quot;&gt;
+ * &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;
+ * &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;
+ * &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;
+ * &lt;/ul&gt;&lt;/div&gt;
+ * &lt;/ul&gt;&lt;/div&gt;
+ *
+ * @constructor
+ * @param {Object} config
+ */
+
+Ext.define('Ext.data.DirectStore', {
+    /* Begin Definitions */
+    
+    extend: 'Ext.data.Store',
+    
+    alias: 'store.direct',
+    
+    requires: ['Ext.data.proxy.Direct'],
+   
+    /* End Definitions */
+   
+   constructor : function(config){
+        config = Ext.apply({}, config);
+        if (!config.proxy) {
+            var proxy = {
+                type: 'direct',
+                reader: {
+                    type: 'json'
+                }
+            };
+            Ext.copyTo(proxy, config, 'paramOrder,paramsAsHash,directFn,api,simpleSortMode');
+            Ext.copyTo(proxy.reader, config, 'totalProperty,root,idProperty');
+            config.proxy = proxy;
+        }
+        this.callParent([config]);
+    }    
+});
+</pre></pre></body></html>
\ No newline at end of file