Properties Methods Events Config Options Direct Link
Action
  Action.Submit

Class CQ.Ext.form.Action.Submit

Package:CQ.Ext.form
Class:Action.Submit
Subclasses:Action.DirectSubmit, SlingSubmitAction
Extends:CQ.Ext.form.Action
Clientlib:cq.widgets

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 CQ.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 CQ.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 CQ.Ext.form.BasicForm's callback or event handler methods. The XML document is available in the errorReader's xmlData property.

Config Options

Config Options Defined By
  url : String
The URL that the Action is to invoke.
Action

Public Properties

Property Defined By
  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

Public Methods

This class has no public methods.

Public Events

This class has no public events.