X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/530ef4b6c5b943cfa68b779d11cf7de29aa878bf..b37ceabb82336ee82757cd32efe353cfab8ec267:/docs/source/JsonWriter.html diff --git a/docs/source/JsonWriter.html b/docs/source/JsonWriter.html index 34706b2b..3af977d0 100644 --- a/docs/source/JsonWriter.html +++ b/docs/source/JsonWriter.html @@ -7,7 +7,7 @@

/*!
- * Ext JS Library 3.2.1
+ * Ext JS Library 3.2.2
  * Copyright(c) 2006-2010 Ext JS, Inc.
  * licensing@extjs.com
  * http://www.extjs.com/license
@@ -19,14 +19,18 @@
  */
 Ext.data.JsonWriter = Ext.extend(Ext.data.DataWriter, {
     /**
-     * @cfg {Boolean} encode true to {@link Ext.util.JSON#encode encode} the
-     * {@link Ext.data.DataWriter#toHash hashed data}. Defaults to true.  When using
-     * {@link Ext.data.DirectProxy}, set this to false since Ext.Direct.JsonProvider will perform
+     * @cfg {Boolean} encode true to {@link Ext.util.JSON#encode JSON encode} the
+     * {@link Ext.data.DataWriter#toHash hashed data} into a standard HTTP parameter named after this
+     * Reader's meta.root property which, by default is imported from the associated Reader. Defaults to true.
+     * If set to false, the hashed data is {@link Ext.util.JSON#encode JSON encoded}, along with
+     * the associated {@link Ext.data.Store}'s {@link Ext.data.Store#baseParams baseParams}, into the POST body.
+     * When using {@link Ext.data.DirectProxy}, set this to false since Ext.Direct.JsonProvider will perform
      * its own json-encoding.  In addition, if you're using {@link Ext.data.HttpProxy}, setting to false
      * will cause HttpProxy to transmit data using the jsonData configuration-params of {@link Ext.Ajax#request}
-     * instead of params.  When using a {@link Ext.data.Store#restful} Store, some serverside frameworks are
+     * instead of params.
+     * 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 encode: false, as in
-     * let the lower-level connection object (eg: Ext.Ajax) do the encoding.
+     * let the lower-level connection object (eg: Ext.Ajax) do the encoding.
      */
     encode : true,
     /**
@@ -42,10 +46,14 @@ Ext.data.JsonWriter = Ext.extend(Ext.data.DataWriter, {
     },
 
     /**
-     * Final action of a write event.  Apply the written data-object to params.
-     * @param {Object} http params-object to write-to.
+     * This method should not need to be called by application code, however it may be useful on occasion to
+     * override it, or augment it with an {@link Function#createInterceptor interceptor} or {@link Function#createSequence sequence}.
+     * The provided implementation encodes the serialized data representing the Store's modified Records into the Ajax request's
+     * params according to the {@link #encode} setting.
+     * @param {Object} Ajax request params object to write into.
      * @param {Object} baseParams as defined by {@link Ext.data.Store#baseParams}.  The baseParms must be encoded by the extending class, eg: {@link Ext.data.JsonWriter}, {@link Ext.data.XmlWriter}.
-     * @param {Object/Object[]} data Data-object representing compiled Store-recordset.
+     * @param {Object/Object[]} data Data object representing the serialized modified records from the Store. May be either a single object,
+     * or an Array of objects - user implementations must handle both cases.
      */
     render : function(params, baseParams, data) {
         if (this.encode === true) {