Upgrade to ExtJS 3.0.0 - Released 07/06/2009

[extjs.git] / docs / source / DirectStore.html
diff --git a/docs/source/DirectStore.html b/docs/source/DirectStore.html

new file mode 100644 (file)

index 0000000..75933ac
--- /dev/null
+++ b/docs/source/DirectStore.html
@@ -0,0 +1,56 @@
+<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