Properties Methods Events Config Options Direct Link

    Action
      Action.Load

# Class Ext.form.Action.Load

Package: | Ext.form
Defined In: | Action.js
Class: | Action.Load
Extends: | Action

A class which handles loading of data from a server into the Fields of an Ext.form.BasicForm.
Instances of this class are only created by a Form when submitting.
A response packet must contain a boolean `success` property, and a `data` property. 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.
By default, response packets are assumed to be JSON, so a typical response packet may look like this:

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

Other data may be placed into the response for processing the 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 : Ext.form.BasicForm The form that requested the action action : 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 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
| 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: form : Ext.form.BasicForm The form that requested the action action : Ext.form.Action The Action class. The result property of this object may be examined to perform custom postprocessing. | 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

Property | Defined By
--- | ---
| failureType : String The type of failure detected. See {@link #Ext.form.Action-Action.CLIENT_INVALID CLIENT_INVALID}, {@link #Ext.form.Act... The type of failure detected. See {@link #Ext.form.Action-Action.CLIENT_INVALID CLIENT_INVALID}, {@link #Ext.form.Action-Action.SERVER_INVALID SERVER_INVALID}, {@link #Ext.form.Action-Action.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

## Public Methods

This class has no public methods.

## Public Events

This class has no public events.