ActionAction.Load
Action.DirectLoad
| Package: | CQ.Ext.form |
| Class: | Action.DirectLoad |
| Extends: | CQ.Ext.form.Action.Load |
| Clientlib: | cq.widgets |
Provides CQ.Ext.direct support for loading form data.
This example illustrates usage of CQ.Ext.Direct to load a form through CQ.Ext.Direct.
var myFormPanel = new CQ.Ext.form.FormPanel({
// configs for FormPanel
title: 'Basic Information',
renderTo: document.body,
width: 300, height: 160,
padding: 10,
// configs apply to child items
defaults: {anchor: '100%'},
defaultType: 'textfield',
items: [{
fieldLabel: 'Name',
name: 'name'
},{
fieldLabel: 'Email',
name: 'email'
},{
fieldLabel: 'Company',
name: 'company'
}],
// configs for BasicForm
api: {
// The server-side method to call for load() requests
load: Profile.getBasicInfo,
// The server-side must mark the submit handler as a 'formHandler'
submit: Profile.updateBasicInfo
},
// specify the order for the passed params
paramOrder: ['uid', 'foo']
});
// load the form
myFormPanel.getForm().load({
// pass 2 arguments to server side getBasicInfo method (len=2)
params: {
foo: 'bar',
uid: 34
}
});
The data packet sent to the server will resemble something like:
[
{
"action":"Profile","method":"getBasicInfo","type":"rpc","tid":2,
"data":[34,"bar"] // note the order of the params
}
]
The form will process a data packet returned by the server that is similar
to the following format:
[
{
"action":"Profile","method":"getBasicInfo","type":"rpc","tid":2,
"result":{
"success":true,
"data":{
"name":"Fred Flintstone",
"company":"Slate Rock and Gravel",
"email":"fred.flintstone@slaterg.com"
}
}
}
] | 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:
|
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:
|
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 | |
| 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:
|
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 | |