Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / JsonWriter.html
diff --git a/docs/source/JsonWriter.html b/docs/source/JsonWriter.html
new file mode 100644 (file)
index 0000000..8a25ed1
--- /dev/null
@@ -0,0 +1,84 @@
+<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.JsonWriter"></div>/**
+ * @class Ext.data.JsonWriter
+ * @extends Ext.data.DataWriter
+ * DataWriter extension for writing an array or single {@link Ext.data.Record} object(s) in preparation for executing a remote CRUD action.
+ */
+Ext.data.JsonWriter = function(config) {
+    Ext.data.JsonWriter.superclass.constructor.call(this, config);
+
+    // careful to respect "returnJson", renamed to "encode"
+    // TODO: remove after v3 final release
+    if (this.returnJson != undefined) {
+        this.encode = this.returnJson;
+    }
+}
+Ext.extend(Ext.data.JsonWriter, Ext.data.DataWriter, {
+    <div id="cfg-Ext.data.JsonWriter-returnJson"></div>/**
+     * @cfg {Boolean} returnJson <b>Deprecated.  Use {@link Ext.data.JsonWriter#encode} instead.
+     */
+    returnJson : undefined,
+    <div id="cfg-Ext.data.JsonWriter-encode"></div>/**
+     * @cfg {Boolean} encode <tt>true</tt> to {@link Ext.util.JSON#encode encode} the
+     * {@link Ext.data.DataWriter#toHash hashed data}. Defaults to <tt>true</tt>.  When using
+     * {@link Ext.data.DirectProxy}, set this to <tt>false</tt> since Ext.Direct.JsonProvider will perform
+     * its own json-encoding.  In addition, if you're using {@link Ext.data.HttpProxy}, setting to <tt>false</tt>
+     * will cause HttpProxy to transmit data using the <b>jsonData</b> configuration-params of {@link Ext.Ajax#request}
+     * instead of <b>params</b>.  When using a {@link Ext.data.Store#restful} Store, some serverside frameworks are
+     * tuned to expect data through the jsonData mechanism.  In those cases, one will want to set <b>encode: <tt>false</tt></b>
+     */
+    encode : true,
+
+    <div id="method-Ext.data.JsonWriter-render"></div>/**
+     * Final action of a write event.  Apply the written data-object to params.
+     * @param {String} action [Ext.data.Api.actions.create|read|update|destroy]
+     * @param {Record[]} rs
+     * @param {Object} http params
+     * @param {Object} data object populated according to DataReader meta-data "root" and "idProperty"
+     */
+    render : function(action, rs, params, data) {
+        Ext.apply(params, data);
+
+        if (this.encode === true) { // <-- @deprecated returnJson
+            if (Ext.isArray(rs) && data[this.meta.idProperty]) {
+                params[this.meta.idProperty] = Ext.encode(params[this.meta.idProperty]);
+            }
+            params[this.meta.root] = Ext.encode(params[this.meta.root]);
+        }
+    },
+    <div id="method-Ext.data.JsonWriter-createRecord"></div>/**
+     * createRecord
+     * @protected
+     * @param {Ext.data.Record} rec
+     */
+    createRecord : function(rec) {
+       var data = this.toHash(rec);
+       delete data[this.meta.idProperty];
+       return data;
+    },
+    <div id="method-Ext.data.JsonWriter-updateRecord"></div>/**
+     * updateRecord
+     * @protected
+     * @param {Ext.data.Record} rec
+     */
+    updateRecord : function(rec) {
+        return this.toHash(rec);
+
+    },
+    <div id="method-Ext.data.JsonWriter-destroyRecord"></div>/**
+     * destroyRecord
+     * @protected
+     * @param {Ext.data.Record} rec
+     */
+    destroyRecord : function(rec) {
+        return rec.id;
+    }
+});</pre>    \r
+</body>\r
+</html>
\ No newline at end of file