X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/output/Ext.form.Action.Submit.html diff --git a/docs/output/Ext.form.Action.Submit.html b/docs/output/Ext.form.Action.Submit.html deleted file mode 100644 index 7563b3f3..00000000 --- a/docs/output/Ext.form.Action.Submit.html +++ /dev/null @@ -1,143 +0,0 @@ -
Action Action.Submit
Package: | Ext.form |
Defined In: | Action.js |
Class: | Action.Submit |
Subclasses: | Action.DirectSubmit |
Extends: | Action |
A class which handles submission of data from Forms -and processes the returned response.
-Instances of this class are only created by a Form when -submitting.
-Response Packet Criteria
-A response packet may contain: -
success
property : Boolean
-success
property is required.errors
property : Object
-errors
property,
-which is optional, contains error messages for invalid fields.JSON Packets
-By default, response packets are assumed to be JSON, so a typical response -packet may look like this:
{
- success: false,
- errors: {
- clientCode: "Client not found",
- portOfLoading: "This field must not be null"
- }
-}
-Other data may be placed into the response for processing by the Ext.form.BasicForm's callback -or event handler methods. The object decoded from this JSON is available in the -result property.
-Alternatively, if an errorReader is specified as an XmlReader:
errorReader: new Ext.data.XmlReader({
- record : 'field',
- success: '@success'
- }, [
- 'id', 'msg'
- ]
- )
-then the results may be sent back in XML format:
<?xml version="1.0" encoding="UTF-8"?>
-<message success="false">
-<errors>
- <field>
- <id>clientCode</id>
- <msg><![CDATA[Code not found. <br /><i>This is a test validation message from the server </i>]]></msg>
- </field>
- <field>
- <id>portOfLoading</id>
- <msg><![CDATA[Port not found. <br /><i>This is a test validation message from the server </i>]]></msg>
- </field>
-</errors>
-</message>
-Other elements may be placed into the response XML for processing by the Ext.form.BasicForm's callback -or event handler methods. The XML document is available in the errorReader's xmlData property.
Config Options | Defined By | |
---|---|---|
clientValidation : boolean Determines whether a Form's fields are validated
-in a final call to isValid prior to submission.
-Pass false in the ... Determines whether a Form's fields are validated
-in a final call to isValid prior to submission.
-Pass false in the Form's submit options to prevent this. If not defined, pre-submission field validation
-is performed. | Action.Submit | |
errorReader : Ext.data.DataReader Optional. JSON is interpreted with
-no need for an errorReader.
-A Reader which reads a single record from the return... Optional. JSON is interpreted with -no need for an errorReader. -A Reader which reads a single record from the returned data. The DataReader's -success property specifies how submission success is determined. The Record's -data provides the error messages to apply to any invalid form Fields. | Action.Submit | |
failure : Function The function to call when a failure packet was recieved, or when an
-error ocurred in the Ajax communication.
-The fu... The function to call when a failure packet was recieved, or when an
-error ocurred in the Ajax communication.
-The function is passed the following parameters:
| Action | |
method : String The HTTP method to use to access the requested URL. Defaults to the
-Ext.form.BasicForm's method, or if that is not s... The HTTP method to use to access the requested URL. Defaults to the
-Ext.form.BasicForm's method, or if that is not specified, the underlying DOM form's method. | Action | |
params : Mixed Extra parameter values to pass. These are added to the Form's
-Ext.form.BasicForm.baseParams and passed to the specif... Extra parameter values to pass. These are added to the Form's -Ext.form.BasicForm.baseParams and passed to the specified URL along with the Form's -input fields. -Parameters are encoded as standard HTTP parameters using Ext.urlEncode. | Action | |
reset : Boolean When set to true, causes the Form to be
-reset on Action success. If specified, this happens
-before the success call... When set to true, causes the Form to be
-reset on Action success. If specified, this happens
-before the success callback is called and before the Form's
-actioncomplete event fires. | Action | |
scope : Object The scope in which to call the callback functions (The this reference
-for the callback functions). | Action | |
success : Function The function to call when a valid success return packet is recieved.
-The function is passed the following parameters... The function to call when a valid success return packet is recieved.
-The function is passed the following parameters:
| Action | |
timeout : Number The number of seconds to wait for a server response before
-failing with the failureType as Action.CONNECT_FAILURE. I... The number of seconds to wait for a server response before
-failing with the failureType as Action.CONNECT_FAILURE. If not specified,
-defaults to the configured timeout of the
-form. | Action | |
url : String The URL that the Action is to invoke. | Action | |
waitMsg : String The message to be displayed by a call to Ext.MessageBox.wait
-during the time the action is being processed. | Action | |
waitTitle : String The title to be displayed by a call to Ext.MessageBox.wait
-during the time the action is being processed. | Action |
Property | Defined By | |
---|---|---|
CLIENT_INVALID : String Failure type returned when client side validation of the Form fails
-thus aborting a submit action. Client side valid... Failure type returned when client side validation of the Form fails
-thus aborting a submit action. Client side validation is performed unless
-clientValidation is explicitly set to false. | Action | |
CONNECT_FAILURE : String Failure type returned when a communication error happens when attempting
-to send a request to the remote server. The... Failure type returned when a communication error happens when attempting
-to send a request to the remote server. The response may be examined to
-provide further information. | Action | |
LOAD_FAILURE : String Failure type returned when the response's <tt style="font-weight:bold">success
-property is set to false, or no field... Failure type returned when the response's success
-property is set to false, or no field values are returned in the response's
-data property. | Action | |
SERVER_INVALID : String Failure type returned when server side processing fails and the result's
-<tt style="font-weight:bold">success proper... | Action | |
failureType : String The type of failure detected will be one of these: CLIENT_INVALID,
-SERVER_INVALID, CONNECT_FAILURE, or LOAD_FAILURE.... The type of failure detected will be one of these: CLIENT_INVALID,
-SERVER_INVALID, CONNECT_FAILURE, or LOAD_FAILURE. Usage:
-
| Action | |
response : Object The XMLHttpRequest object used to perform the action. | Action | |
result : Object The decoded response object containing a boolean <tt style="font-weight:bold">success property and
-other, action-spe... The decoded response object containing a boolean success property and
-other, action-specific properties. | Action | |
type : String The type of action this Action instance performs.
-Currently only "submit" and "load" are supported. | Action |