/* 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_Submit({"alternateClassNames":[],"aliases":{},"enum":null,"parentMixins":[],"tagname":"class","subclasses":["Ext.form.Action.DirectSubmit"],"extends":"Ext.form.Action","uses":[],"html":"
Hierarchy
Ext.form.Action
Ext.form.Action.Submit
Subclasses
Ext.form.Action.DirectSubmit
Files
Action.js

A class which handles submission of data from Forms\nand processes the returned response.

\n\n\n

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

\n\n\n

Response Packet Criteria

\n\n\n

A response packet may contain:\n

    \n
  • success property : Boolean\n
    The success property is required.
    • \n
  • errors property : Object\n
    The errors property,\nwhich is optional, contains error messages for invalid fields.
    • \n
\n

JSON Packets

\n

By default, response packets are assumed to be JSON, so a typical response\npacket may look like this:

\n
{\n    success: false,\n    errors: {\n        clientCode: \"Client not found\",\n        portOfLoading: \"This field must not be null\"\n    }\n}
\n

Other data may be placed into the response for processing by the Ext.form.BasicForm's callback\nor event handler methods. The object decoded from this JSON is available in the\nresult property.

\n

Alternatively, if an errorReader is specified as an XmlReader:

\n
    errorReader: new Ext.data.XmlReader({\n            record : 'field',\n            success: '@success'\n        }, [\n            'id', 'msg'\n        ]\n    )\n
\n

then the results may be sent back in XML format:

\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<message success=\"false\">\n<errors>\n    <field>\n        <id>clientCode</id>\n        <msg><![CDATA[Code not found. <br /><i>This is a test validation message from the server </i>]]></msg>\n    </field>\n    <field>\n        <id>portOfLoading</id>\n        <msg><![CDATA[Port not found. <br /><i>This is a test validation message from the server </i>]]></msg>\n    </field>\n</errors>\n</message>\n
\n

Other elements may be placed into the response XML for processing by the Ext.form.BasicForm's callback\nor event handler methods. The XML document is available in the errorReader's xmlData property.

\n\n

Defined By

Config options

Ext.form.Action.Submit
view source
: boolean
Determines whether a Form's fields are validated\nin a final call to isValid prior to submission. ...

Determines whether a Form's fields are validated\nin a final call to isValid prior to submission.\nPass false in the Form's submit options to prevent this. If not defined, pre-submission field validation\nis performed.

\n
Ext.form.Action.Submit
view source
: Ext.data.DataReader
Optional. ...

Optional. JSON is interpreted with\nno need for an errorReader.

\n\n\n

A Reader which reads a single record from the returned data. The DataReader's\nsuccess property specifies how submission success is determined. The Record's\ndata provides the error messages to apply to any invalid form Fields.

\n\n
Ext.form.Action
view source
: Function
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
Ext.form.Action
view source
: String
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
Ext.form.Action
view source
: Mixed
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
Ext.form.Action
view source
: Boolean
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
Ext.form.Action
view source
scope : Object

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
Ext.form.Action
view source
: Boolean
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
Ext.form.Action
view source
: Function
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
Ext.form.Action
view source
: Number
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
Ext.form.Action
view source
url : String

The URL that the Action is to invoke.

\n

The URL that the Action is to invoke.

\n
Ext.form.Action
view source
waitMsg : String

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
Ext.form.Action
view source
waitTitle : String

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

Ext.form.Action
view source
: String
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
Ext.form.Action
view source
response : Object

The XMLHttpRequest object used to perform the action.

\n

The XMLHttpRequest object used to perform the action.

\n
Ext.form.Action
view source
result : Object

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
Ext.form.Action
view source
: String
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-Submit","filename":"Action.js"}],"linenr":263,"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.Submit","meta":{},"name":"clientValidation","id":"cfg-clientValidation"},{"tagname":"cfg","owner":"Ext.form.Action.Submit","meta":{},"name":"errorReader","id":"cfg-errorReader"},{"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.Submit","singleton":false,"override":null,"inheritdoc":null,"id":"class-Ext.form.Action.Submit","mixins":[],"mixedInto":[]});