Properties Methods Events Config Options Direct Link
Action
  Action.Submit

Class Ext.form.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
    The success property is required.
  • errors property : Object
    The 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

Config OptionsDefined By
 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
 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

Public Properties

PropertyDefined By
 response : Object
The XMLHttpRequest object used to perform the action.
Action
 type : String
The type of action this Action instance performs. Currently only "submit" and "load" are supported.
Action

Public Methods

This class has no public methods.

Public Events

This class has no public events.