add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / form / action / Load.js

/**\r
 * A class which handles loading of data from a server into the Fields of an {@link Ext.form.Basic}.\r
 *\r
 * Instances of this class are only created by a {@link Ext.form.Basic Form} when {@link Ext.form.Basic#load load}ing.\r
 *\r
 * ## Response Packet Criteria\r
 *\r
 * A response packet **must** contain:\r
 *\r
 *   - **`success`** property : Boolean\r
 *   - **`data`** property : Object\r
 *\r
 * The `data` property contains the values of Fields to load. The individual value object for each Field is passed to\r
 * the Field's {@link Ext.form.field.Field#setValue setValue} method.\r
 *\r
 * ## JSON Packets\r
 *\r
 * By default, response packets are assumed to be JSON, so for the following form load call:\r
 *\r
 *     var myFormPanel = new Ext.form.Panel({\r
 *         title: 'Client and routing info',\r
 *         renderTo: Ext.getBody(),\r
 *         defaults: {\r
 *             xtype: 'textfield'\r
 *         },\r
 *         items: [{\r
 *             fieldLabel: 'Client',\r
 *             name: 'clientName'\r
 *         }, {\r
 *             fieldLabel: 'Port of loading',\r
 *             name: 'portOfLoading'\r
 *         }, {\r
 *             fieldLabel: 'Port of discharge',\r
 *             name: 'portOfDischarge'\r
 *         }]\r
 *     });\r
 *     myFormPanel.{@link Ext.form.Panel#getForm getForm}().{@link Ext.form.Basic#load load}({\r
 *         url: '/getRoutingInfo.php',\r
 *         params: {\r
 *             consignmentRef: myConsignmentRef\r
 *         },\r
 *         failure: function(form, action) {\r
 *             Ext.Msg.alert("Load failed", action.result.errorMessage);\r
 *         }\r
 *     });\r
 *\r
 * a **success response** packet may look like this:\r
 *\r
 *     {\r
 *         success: true,\r
 *         data: {\r
 *             clientName: "Fred. Olsen Lines",\r
 *             portOfLoading: "FXT",\r
 *             portOfDischarge: "OSL"\r
 *         }\r
 *     }\r
 *\r
 * while a **failure response** packet may look like this:\r
 *\r
 *     {\r
 *         success: false,\r
 *         errorMessage: "Consignment reference not found"\r
 *     }\r
 *\r
 * Other data may be placed into the response for processing the {@link Ext.form.Basic Form}'s callback or event handler\r
 * methods. The object decoded from this JSON is available in the {@link Ext.form.action.Action#result result} property.\r
 */\r
Ext.define('Ext.form.action.Load', {\r
    extend:'Ext.form.action.Action',\r
    requires: ['Ext.data.Connection'],\r
    alternateClassName: 'Ext.form.Action.Load',\r
    alias: 'formaction.load',\r
\r
    type: 'load',\r
\r
    /**\r
     * @private\r
     */\r
    run: function() {\r
        Ext.Ajax.request(Ext.apply(\r
            this.createCallback(),\r
            {\r
                method: this.getMethod(),\r
                url: this.getUrl(),\r
                headers: this.headers,\r
                params: this.getParams()\r
            }\r
        ));\r
    },\r
\r
    /**\r
     * @private\r
     */\r
    onSuccess: function(response){\r
        var result = this.processResponse(response),\r
            form = this.form,\r
            formActive = form && !form.destroying && !form.destroyed;\r
        \r
        if (result === true || !result.success || !result.data) {\r
            this.failureType = Ext.form.action.Action.LOAD_FAILURE;\r
            \r
            if (formActive) {\r
                form.afterAction(this, false);\r
            }\r
            \r
            return;\r
        }\r
        \r
        if (formActive) {\r
            form.clearInvalid();\r
            form.setValues(result.data);\r
            form.afterAction(this, true);\r
        }\r
    },\r
\r
    /**\r
     * @private\r
     */\r
    handleResponse: function(response) {\r
        var reader = this.form.reader,\r
            rs, data;\r
        if (reader) {\r
            rs = reader.read(response);\r
            data = rs.records && rs.records[0] ? rs.records[0].data : null;\r
            return {\r
                success : rs.success,\r
                data : data\r
            };\r
        }\r
        return Ext.decode(response.responseText);\r
    }\r
});\r
\r