Upgrade to ExtJS 3.1.1 - Released 02/08/2010
[extjs.git] / docs / source / JsonWriter.html
index 91daa70..a1dad94 100644 (file)
  * @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 Ext-3.0.1 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, will be removed in Ext-3.0.1</b>.  Use {@link Ext.data.JsonWriter#encode} instead.
-     */
-    returnJson : undefined,
+Ext.data.JsonWriter = Ext.extend(Ext.data.DataWriter, {
     <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
@@ -36,6 +23,17 @@ Ext.extend(Ext.data.JsonWriter, Ext.data.DataWriter, {
      * let the lower-level connection object (eg: Ext.Ajax) do the encoding.
      */
     encode : true,
+    <div id="cfg-Ext.data.JsonWriter-encodeDelete"></div>/**
+     * @cfg {Boolean} encodeDelete False to send only the id to the server on delete, true to encode it in an object
+     * literal, eg: <pre><code>
+{id: 1}
+ * </code></pre> Defaults to <tt>false</tt>
+     */
+    encodeDelete: false,
+    
+    constructor : function(config){
+        Ext.data.JsonWriter.superclass.constructor.call(this, config);    
+    },
 
     <div id="method-Ext.data.JsonWriter-render"></div>/**
      * Final action of a write event.  Apply the written data-object to params.
@@ -80,8 +78,14 @@ Ext.extend(Ext.data.JsonWriter, Ext.data.DataWriter, {
      * @param {Ext.data.Record} rec
      * @return {Object}
      */
-    destroyRecord : function(rec) {
-        return rec.id;
+    destroyRecord : function(rec){
+        if(this.encodeDelete){
+            var data = {};
+            data[this.meta.idProperty] = rec.id;
+            return data;
+        }else{
+            return rec.id;
+        }
     }
 });</pre>    \r
 </body>\r