</head>
<body onload="prettyPrint();">
<pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.2.1
- * Copyright(c) 2006-2010 Ext JS, Inc.
- * licensing@extjs.com
- * http://www.extjs.com/license
+ * Ext JS Library 3.3.1
+ * Copyright(c) 2006-2010 Sencha Inc.
+ * licensing@sencha.com
+ * http://www.sencha.com/license
*/
<div id="cls-Ext.data.JsonWriter"></div>/**
* @class Ext.data.JsonWriter
*/
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
- * {@link Ext.data.DirectProxy}, set this to <tt>false</tt> since Ext.Direct.JsonProvider will perform
+ * @cfg {Boolean} encode <p><tt>true</tt> 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 <code>meta.root</code> property which, by default is imported from the associated Reader. Defaults to <tt>true</tt>.</p>
+ * <p>If set to <code>false</code>, 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.</p>
+ * <p>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
+ * instead of <b>params</b>.</p>
+ * <p>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>, 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.</p>
*/
encode : true,
<div id="cfg-Ext.data.JsonWriter-encodeDelete"></div>/**
},
<div id="method-Ext.data.JsonWriter-render"></div>/**
- * Final action of a write event. Apply the written data-object to params.
- * @param {Object} http params-object to write-to.
+ * <p>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}.</p>
+ * <p>The provided implementation encodes the serialized data representing the Store's modified Records into the Ajax request's
+ * <code>params</code> according to the <code>{@link #encode}</code> setting.</p>
+ * @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) {
git.ithinksw.org / extjs.git / blobdiff