X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/d41dc04ad17d1d9125fb2cf72db2b4782dbe3a8c..f5240829880f87e0cf581c6a296e436fdef0ef80:/docs/output/Ext.form.Action.Submit.html?ds=sidebyside diff --git a/docs/output/Ext.form.Action.Submit.html b/docs/output/Ext.form.Action.Submit.html index cdb4a712..26eb5656 100644 --- a/docs/output/Ext.form.Action.Submit.html +++ b/docs/output/Ext.form.Action.Submit.html @@ -1,29 +1,17 @@ -
Action - Action.Submit
Package: | Ext.form |
Defined In: | Action.js |
Class: | Action.Submit |
Extends: | Action |
A class which handles submission of data from Forms +
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.
-A response packet must contain a boolean success property, and, optionally -an errors property. The errors property contains error -messages for invalid fields.
+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,
@@ -32,9 +20,10 @@ packet may look like this:{
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({
+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'
}, [
@@ -54,205 +43,102 @@ or event handler methods. The object decoded from this JSON is available in the
</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 Fo...
-
- 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 returned...
-
- 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 func...
-
- 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 sp...
-
- 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 specifi...
-
- 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.
- |
- Action | -
- |
-
- reset : Boolean
-
- When set to true, causes the Form to be reset on Action success. If specified, this happens before the success callba...
-
- 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 milliseconds to wait for a server response before failing with the failureType as Action.CONNECT_FAILURE.
- |
- 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 | -|
---|---|---|
- |
-
- failureType : String
-
- The type of failure detected. See Ext.form.Action#Action.CLIENT_INVALID CLIENT_INVALID,
-Ext.form.Action#Action.SERVER...
-
- The type of failure detected. See Ext.form.Action#Action.CLIENT_INVALID CLIENT_INVALID,
-Ext.form.Action#Action.SERVER_INVALID SERVER_INVALID,
-Ext.form.ActionAction.CONNECT_FAILURE CONNECT_FAILURE, {@link Ext.form.Action#Action.LOAD_FAILURE LOAD_FAILURE}
- |
- Action | -
- |
-
- response : Object
-
-The XMLHttpRequest object used to perform the action.
- |
- Action | -
- |
-
- result : Object
-
-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 | -
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 Fo... 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 returned... 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 func... 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 sp... 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 specifi... 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 callba... 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 | |
submitEmptyText : Boolean If set to true, the emptyText value will be sent with the form
+when it is submitted. Defaults to true. | 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. If... 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 valida... 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 propert... | 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-spec... 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 |