Properties

Methods

Events

Config Options

Direct Link

Action
  Action.Load

Class CQ.Ext.form.Action.Load

Package:	CQ.Ext.form
Class:	Action.Load
Subclasses:	Action.DirectLoad
Extends:	CQ.Ext.form.Action
Clientlib:	cq.widgets

A class which handles loading of data from a server into the Fields of an CQ.Ext.form.BasicForm.

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

Response Packet Criteria

A response packet must contain:

success property : Boolean
data property : Object

The data property contains the values of Fields to load. The individual value object for each Field is passed to the Field's setValue method.

JSON Packets

By default, response packets are assumed to be JSON, so for the following form load call:

var myFormPanel = new CQ.Ext.form.FormPanel({
    title: 'Client and routing info',
    items: [{
        fieldLabel: 'Client',
        name: 'clientName'
    }, {
        fieldLabel: 'Port of loading',
        name: 'portOfLoading'
    }, {
        fieldLabel: 'Port of discharge',
        name: 'portOfDischarge'
    }]
});
myFormPanel.getForm().load({
    url: '/getRoutingInfo.php',
    params: {
        consignmentRef: myConsignmentRef
    },
    failure: function(form, action) {
        CQ.Ext.Msg.alert("Load failed", action.result.errorMessage);
    }
});

a success response packet may look like this:

{
    success: true,
    data: {
        clientName: "Fred. Olsen Lines",
        portOfLoading: "FXT",
        portOfDischarge: "OSL"
    }
}

while a failure response packet may look like this:

{
    success: false,
    errorMessage: "Consignment reference not found"
}

Other data may be placed into the response for processing the Form's callback or event handler methods. The object decoded from this JSON is available in the result property.

Config Options

Config Options		Defined By
	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: form : CQ.Ext.form.BasicForm The form that requested the action action : CQ.Ext.form.Action The Action class. If an Ajax error ocurred, the failure type will be in failureType. The result property of this object may be examined to perform custom postprocessing.	Action
	method : String The HTTP method to use to access the requested URL. Defaults to the CQ.Ext.form.BasicForm's method, or if that is not... The HTTP method to use to access the requested URL. Defaults to the CQ.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 CQ.Ext.form.BasicForm.baseParams and passed to the spec... Extra parameter values to pass. These are added to the Form's CQ.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 CQ.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). 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. 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: form : CQ.Ext.form.BasicForm The form that requested the action action : CQ.Ext.form.Action The Action class. The result property of this object may be examined to perform custom postprocessing.	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 CQ.Ext.MessageBox.wait during the time the action is being processed. The message to be displayed by a call to CQ.Ext.MessageBox.wait during the time the action is being processed.	Action
	waitTitle : String The title to be displayed by a call to CQ.Ext.MessageBox.wait during the time the action is being processed. The title to be displayed by a call to CQ.Ext.MessageBox.wait during the time the action is being processed.	Action

Public Properties

Property		Defined By
	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: var fp = new CQ.Ext.form.FormPanel({ ... buttons: [{ text: 'Save', formBind: true, handler: function(){ if(fp.getForm().isValid()){ fp.getForm().submit({ url: 'form-submit.php', waitMsg: 'Submitting your data...', success: function(form, action){ // server responded with success = true var result = action.result; }, failure: function(form, action){ if (action.failureType === CQ.Ext.form.Action.CONNECT_FAILURE) { CQ.Ext.Msg.alert('Error', 'Status:'+action.response.status+': '+ action.response.statusText); } if (action.failureType === CQ.Ext.form.Action.SERVER_INVALID){ // server responded with success = false CQ.Ext.Msg.alert('Invalid', action.result.errormsg); } } }); } } },{ text: 'Reset', handler: function(){ fp.getForm().reset(); } }]	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

Public Methods

This class has no public methods.

Public Events

This class has no public events.