/* This file is part of Ext JS 3.4 Copyright (c) 2011-2013 Sencha Inc Contact: http://www.sencha.com/contact GNU General Public License Usage This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file. Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html. If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact. Build date: 2013-04-03 15:07:25 */ Ext.data.JsonP.Ext_form_Action_Load({"alternateClassNames":[],"aliases":{},"enum":null,"parentMixins":[],"tagname":"class","subclasses":["Ext.form.Action.DirectLoad"],"extends":"Ext.form.Action","uses":[],"html":"

Hierarchy

Ext.form.Action
Ext.form.Action.Load

Subclasses

Files

A class which handles loading of data from a server into the Fields of an Ext.form.BasicForm.

\n\n\n

Instances of this class are only created by a Form when\nloading.

\n\n\n

Response Packet Criteria

\n\n\n

A response packet must contain:\n

    \n
  • success property : Boolean
  • \n
  • data property : Object
  • \n
    The data property contains the values of Fields to load.\nThe individual value object for each Field is passed to the Field's\nsetValue method.
    \n
\n

JSON Packets

\n

By default, response packets are assumed to be JSON, so for the following form load call:\n

var myFormPanel = new Ext.form.FormPanel({\n    title: 'Client and routing info',\n    items: [{\n        fieldLabel: 'Client',\n        name: 'clientName'\n    }, {\n        fieldLabel: 'Port of loading',\n        name: 'portOfLoading'\n    }, {\n        fieldLabel: 'Port of discharge',\n        name: 'portOfDischarge'\n    }]\n});\nmyFormPanel.getForm().load({\n    url: '/getRoutingInfo.php',\n    params: {\n        consignmentRef: myConsignmentRef\n    },\n    failure: function(form, action) {\n        Ext.Msg.alert(\"Load failed\", action.result.errorMessage);\n    }\n});\n
\na success response packet may look like this:

\n
{\n    success: true,\n    data: {\n        clientName: \"Fred. Olsen Lines\",\n        portOfLoading: \"FXT\",\n        portOfDischarge: \"OSL\"\n    }\n}
\nwhile a failure response packet may look like this:

\n\n\n
{\n    success: false,\n    errorMessage: \"Consignment reference not found\"\n}
\n\n\n

Other data may be placed into the response for processing the Form's\ncallback or event handler methods. The object decoded from this JSON is available in the\nresult property.

\n\n
Defined By

Config options

The function to call when a failure packet was recieved, or when an\nerror ocurred in the Ajax communication. ...

The function to call when a failure packet was recieved, or when an\nerror ocurred in the Ajax communication.\nThe function is passed the following parameters:

    \n
  • form : Ext.form.BasicForm
    The form that requested the action
  • \n
  • action : Ext.form.Action
    The Action class. If an Ajax\nerror ocurred, the failure type will be in failureType. The result\nproperty of this object may be examined to perform custom postprocessing.
  • \n

\n
The HTTP method to use to access the requested URL. ...

The HTTP method to use to access the requested URL. Defaults to the\nExt.form.BasicForm's method, or if that is not specified, the underlying DOM form's method.

\n
Extra parameter values to pass. ...

Extra parameter values to pass. These are added to the Form's\nExt.form.BasicForm.baseParams and passed to the specified URL along with the Form's\ninput fields.

\n\n\n

Parameters are encoded as standard HTTP parameters using Ext.urlEncode.

\n\n
When set to true, causes the Form to be\nreset on Action success. ...

When set to true, causes the Form to be\nreset on Action success. If specified, this happens\nbefore the success callback is called and before the Form's\nactioncomplete event fires.

\n

The scope in which to call the callback functions (The this reference\nfor the callback functions).

\n

The scope in which to call the callback functions (The this reference\nfor the callback functions).

\n
If set to true, the emptyText value will be sent with the form\nwhen it is submitted. ...

If set to true, the emptyText value will be sent with the form\nwhen it is submitted. Defaults to true.

\n
The function to call when a valid success return packet is recieved. ...

The function to call when a valid success return packet is recieved.\nThe function is passed the following parameters:

\n
The number of seconds to wait for a server response before\nfailing with the failureType as Action.CONNECT_FAILURE. ...

The number of seconds to wait for a server response before\nfailing with the failureType as Action.CONNECT_FAILURE. If not specified,\ndefaults to the configured timeout of the\nform.

\n

The URL that the Action is to invoke.

\n

The URL that the Action is to invoke.

\n

The message to be displayed by a call to Ext.MessageBox.wait\nduring the time the action is being processed.

\n

The message to be displayed by a call to Ext.MessageBox.wait\nduring the time the action is being processed.

\n

The title to be displayed by a call to Ext.MessageBox.wait\nduring the time the action is being processed.

\n

The title to be displayed by a call to Ext.MessageBox.wait\nduring the time the action is being processed.

\n
Defined By

Properties

The type of failure detected will be one of these: CLIENT_INVALID,\nSERVER_INVALID, CONNECT_FAILURE, or LOAD_FAILURE. ...

The type of failure detected will be one of these: CLIENT_INVALID,\nSERVER_INVALID, CONNECT_FAILURE, or LOAD_FAILURE. Usage:

\n\n
var fp = new Ext.form.FormPanel({\n...\nbuttons: [{\n    text: 'Save',\n    formBind: true,\n    handler: function(){\n        if(fp.getForm().isValid()){\n            fp.getForm().submit({\n                url: 'form-submit.php',\n                waitMsg: 'Submitting your data...',\n                success: function(form, action){\n                    // server responded with success = true\n                    var result = action.result;\n                },\n                failure: function(form, action){\n                    if (action.failureType === Ext.form.Action.CONNECT_FAILURE) {\n                        Ext.Msg.alert('Error',\n                            'Status:'+action.response.status+': '+\n                            action.response.statusText);\n                    }\n                    if (action.failureType === Ext.form.Action.SERVER_INVALID){\n                        // server responded with success = false\n                        Ext.Msg.alert('Invalid', action.result.errormsg);\n                    }\n                }\n            });\n        }\n    }\n},{\n    text: 'Reset',\n    handler: function(){\n        fp.getForm().reset();\n    }\n}]\n
\n\n

The XMLHttpRequest object used to perform the action.

\n

The XMLHttpRequest object used to perform the action.

\n

The decoded response object containing a boolean success property and\nother, action-specific properties.

\n

The decoded response object containing a boolean success property and\nother, action-specific properties.

\n
The type of action this Action instance performs. ...

The type of action this Action instance performs.\nCurrently only \"submit\" and \"load\" are supported.

\n

Defaults to: 'default'

","superclasses":["Ext.form.Action"],"meta":{},"requires":[],"html_meta":{},"statics":{"property":[],"cfg":[],"css_var":[],"method":[],"event":[],"css_mixin":[]},"files":[{"href":"Action2.html#Ext-form-Action-Load","filename":"Action.js"}],"linenr":419,"members":{"property":[{"tagname":"property","owner":"Ext.form.Action","meta":{},"name":"failureType","id":"property-failureType"},{"tagname":"property","owner":"Ext.form.Action","meta":{},"name":"response","id":"property-response"},{"tagname":"property","owner":"Ext.form.Action","meta":{},"name":"result","id":"property-result"},{"tagname":"property","owner":"Ext.form.Action","meta":{},"name":"type","id":"property-type"}],"cfg":[{"tagname":"cfg","owner":"Ext.form.Action","meta":{},"name":"failure","id":"cfg-failure"},{"tagname":"cfg","owner":"Ext.form.Action","meta":{},"name":"method","id":"cfg-method"},{"tagname":"cfg","owner":"Ext.form.Action","meta":{},"name":"params","id":"cfg-params"},{"tagname":"cfg","owner":"Ext.form.Action","meta":{},"name":"reset","id":"cfg-reset"},{"tagname":"cfg","owner":"Ext.form.Action","meta":{},"name":"scope","id":"cfg-scope"},{"tagname":"cfg","owner":"Ext.form.Action","meta":{},"name":"submitEmptyText","id":"cfg-submitEmptyText"},{"tagname":"cfg","owner":"Ext.form.Action","meta":{},"name":"success","id":"cfg-success"},{"tagname":"cfg","owner":"Ext.form.Action","meta":{},"name":"timeout","id":"cfg-timeout"},{"tagname":"cfg","owner":"Ext.form.Action","meta":{},"name":"url","id":"cfg-url"},{"tagname":"cfg","owner":"Ext.form.Action","meta":{},"name":"waitMsg","id":"cfg-waitMsg"},{"tagname":"cfg","owner":"Ext.form.Action","meta":{},"name":"waitTitle","id":"cfg-waitTitle"}],"css_var":[],"method":[],"event":[],"css_mixin":[]},"inheritable":null,"private":null,"component":false,"name":"Ext.form.Action.Load","singleton":false,"override":null,"inheritdoc":null,"id":"class-Ext.form.Action.Load","mixins":[],"mixedInto":[]});