Ext JS 4.0.7 Sencha Docs

Ext.form.Basic

Alternate names

Ext.form.BasicForm

Hierarchy

Requires

Files

Provides input field management, validation, submission, and form loading services for the collection of Field instances within a Ext.container.Container. It is recommended that you use a Ext.form.Panel as the form container, as that has logic to automatically hook up an instance of Ext.form.Basic (plus other conveniences related to field configuration.)

Form Actions

The Basic class delegates the handling of form loads and submits to instances of Ext.form.action.Action. See the various Action implementations for specific details of each one's functionality, as well as the documentation for doAction which details the configuration options that can be specified in each action call.

The default submit Action is Ext.form.action.Submit, which uses an Ajax request to submit the form's values to a configured URL. To enable normal browser submission of an Ext form, use the standardSubmit config option.

File uploads

File uploads are not performed using normal 'Ajax' techniques; see the description for hasUpload for details. If you're using file uploads you should read the method description.

Example usage:

Ext.create('Ext.form.Panel', {
    title: 'Basic Form',
    renderTo: Ext.getBody(),
    bodyPadding: 5,
    width: 350,

    // Any configuration items here will be automatically passed along to
    // the Ext.form.Basic instance when it gets created.

    // The form will submit an AJAX request to this URL when submitted
    url: 'save-form.php',

    items: [{
        fieldLabel: 'Field',
        name: 'theField'
    }],

    buttons: [{
        text: 'Submit',
        handler: function() {
            // The getForm() method returns the Ext.form.Basic instance:
            var form = this.up('form').getForm();
            if (form.isValid()) {
                // Submit the Ajax request and handle the response
                form.submit({
                    success: function(form, action) {
                       Ext.Msg.alert('Success', action.result.msg);
                    },
                    failure: function(form, action) {
                        Ext.Msg.alert('Failed', action.result.msg);
                    }
                });
            }
        }
    }]
});

Available since: 1.1.0

Defined By

Config options

Ext.form.Basic
view source
: Object
(Optional) If specified, load and submit actions will be handled with Ext.form.action.DirectLoad and Ext.form.action....

(Optional) If specified, load and submit actions will be handled with Ext.form.action.DirectLoad and Ext.form.action.DirectLoad. Methods which have been imported by Ext.direct.Manager can be specified here to load and submit forms. Such as the following:

api: {
    load: App.ss.MyProfile.load,
    submit: App.ss.MyProfile.submit
}

Load actions can use paramOrder or paramsAsHash to customize how the load method is invoked. Submit actions will always use a standard form submit. The formHandler configuration must be set on the associated server-side method which has been imported by Ext.direct.Manager.

Available since: 3.4.0

Parameters to pass with all requests. ...

Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.

Parameters are encoded as standard HTTP parameters using Ext.Object.toQueryString.

Available since: 1.1.0

An Ext.data.DataReader (e.g. ...

An Ext.data.DataReader (e.g. Ext.data.reader.Xml) to be used to read field error messages returned from 'submit' actions. This is optional as there is built-in support for processing JSON responses.

The Records which provide messages for the invalid Fields must use the Field name (or id) as the Record ID, and must contain a field called 'msg' which contains the error message.

The errorReader does not have to be a full-blown implementation of a Reader. It simply needs to implement a read(xhr) function which returns an Array of Records in an object with the following structure:

{
    records: recordArray
}

Available since: 1.1.0

A config object containing one or more event handlers to be added to this object during initialization. ...

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

DOM events from Ext JS Components

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

Available since: 1.1.0

Ext.form.Basic
view source
: String

The request method to use (GET or POST) for form actions if one isn't supplied in the action options.

The request method to use (GET or POST) for form actions if one isn't supplied in the action options.

Available since: 1.1.0

A list of params to be executed server side. ...

A list of params to be executed server side. Defaults to undefined. Only used for the api load configuration.

Specify the params in the order in which they must be executed on the server-side as either (1) an Array of String values, or (2) a String of params delimited by either whitespace, comma, or pipe. For example, any of the following would be acceptable:

paramOrder: ['param1','param2','param3']
paramOrder: 'param1 param2 param3'
paramOrder: 'param1,param2,param3'
paramOrder: 'param1|param2|param'
     

Available since: 3.4.0

Only used for the api load configuration. ...

Only used for the api load configuration. If true, parameters will be sent as a single hash collection of named arguments. Providing a paramOrder nullifies this configuration.

Defaults to: false

Available since: 3.4.0

An Ext.data.DataReader (e.g. ...

An Ext.data.DataReader (e.g. Ext.data.reader.Xml) to be used to read data when executing 'load' actions. This is optional as there is built-in support for processing JSON responses.

Available since: 1.1.0

If set to true, a standard HTML form submit is used instead of a XHR (Ajax) style form submission. ...

If set to true, a standard HTML form submit is used instead of a XHR (Ajax) style form submission. All of the field values, plus any additional params configured via baseParams and/or the options to submit, will be included in the values submitted in the form.

Available since: 2.3.0

Ext.form.Basic
view source
: Number
Timeout for form actions in seconds (default is 30 seconds). ...

Timeout for form actions in seconds (default is 30 seconds).

Defaults to: 30

Available since: 1.1.0

If set to true, reset() resets to the last loaded or setValues() data instead of when the form was first created. ...

If set to true, reset() resets to the last loaded or setValues() data instead of when the form was first created.

Defaults to: false

Available since: 1.1.0

Ext.form.Basic
view source
: String

The URL to use for form actions if one isn't supplied in the doAction options.

The URL to use for form actions if one isn't supplied in the doAction options.

Available since: 1.1.0

Ext.form.Basic
view source
: String/HTMLElement/Ext.Element
By default wait messages are displayed with Ext.MessageBox.wait. ...

By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific element by passing it or its id or mask the form itself by passing in true.

Available since: 4.0.0

The default title to show for the waiting message box ...

The default title to show for the waiting message box

Defaults to: 'Please Wait...'

Available since: 3.4.0

Defined By

Properties

Available since: 4.0.0

...

Defaults to: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate|element|vertical|horizontal|freezeEvent)$/

Available since: 4.0.0

...

Defaults to: true

Available since: 4.0.0

The container component to which this BasicForm is attached.

The container component to which this BasicForm is attached.

Available since: 4.0.0

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); / dependent on 'this'

        return this;
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Available since: 4.0.0

Ext.form.Basic
view source
: Booleanprivate
Private ...

Private

Defaults to: false

Available since: 4.0.0

Methods

Defined By

Instance methods

Ext.form.Basic
view source
new( owner, config ) : Ext.form.Basic
Creates new form. ...

Creates new form.

Available since: 1.1.0

Parameters

Returns

Fires

    Overrides: Ext.util.Observable.constructor

    Adds the specified events to the list of events which this Observable may fire. ...

    Adds the specified events to the list of events which this Observable may fire.

    Available since: 1.1.0

    Parameters

    • o : Object/String

      Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. Usage:

      this.addEvents({
          storeloaded: true,
          storecleared: true
      });
      
    • more : String... (optional)

      Additional event names if multiple event names are being passed as separate parameters. Usage:

      this.addEvents('storeloaded', 'storecleared');
      
    ...

    Available since: 4.0.6

    Parameters

    Returns

    ( eventName, fn, [scope], [options] )
    Appends an event handler to this object. ...

    Appends an event handler to this object.

    Available since: 1.1.0

    Parameters

    • eventName : String

      The name of the event to listen for. May also be an object who's property names are event names.

    • fn : Function

      The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

    • scope : Object (optional)

      The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

    • options : Object (optional)

      An object containing handler configuration.

      Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

      This object may contain any of the following properties:

      • scope : Object

        The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

      • delay : Number

        The number of milliseconds to delay the invocation of the handler after the event fires.

      • single : Boolean

        True to add a handler to handle just the next firing of the event, and then remove itself.

      • buffer : Number

        Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

      • target : Observable

        Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

      • element : String

        This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

        This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

        new Ext.panel.Panel({
            title: 'The title',
            listeners: {
                click: this.handlePanelClick,
                element: 'body'
            }
        });
        

      Combining Options

      Using the options argument, it is possible to combine different types of listeners:

      A delayed, one-time listener.

      myPanel.on('hide', this.handleClick, this, {
          single: true,
          delay: 100
      });
      

      Attaching multiple handlers in 1 call

      The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

      myGridPanel.on({
          cellClick: this.onCellClick,
          mouseover: this.onMouseOver,
          mouseout: this.onMouseOut,
          scope: this // Important. Ensure "this" is correct during handler execution
      });
      

      One can also specify options for each event handler separately:

      myGridPanel.on({
          cellClick: {fn: this.onCellClick, scope: this, single: true},
          mouseover: {fn: panel.onMouseOver, scope: panel}
      });
      

    Fires

      ( item, ename, [fn], [scope], [opt] )
      Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destr...

      Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destroyed.

      Available since: 4.0.0

      Parameters

      • item : Ext.util.Observable/Ext.Element

        The item to which to add a listener/listeners.

      • ename : Object/String

        The event name, or an object containing event name properties.

      • fn : Function (optional)

        If the ename parameter was an event name, this is the handler function.

      • scope : Object (optional)

        If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

      • opt : Object (optional)

        If the ename parameter was an event name, this is the addListener options.

      Fires

        Ext.form.Basic
        view source
        ( action, success )private
        Called after an action is performed via doAction. ...

        Called after an action is performed via doAction.

        Available since: 3.4.0

        Parameters

        • action : Ext.form.action.Action

          The Action instance that was invoked

        • success : Boolean

          True if the action completed successfully, false, otherwise.

        Fires

        Ext.form.Basic
        view source
        ( obj ) : Ext.form.Basicchainable
        Calls Ext.applyIf for all field in this form with the passed object. ...

        Calls Ext.applyIf for all field in this form with the passed object.

        Available since: 1.1.0

        Parameters

        • obj : Object

          The object to be applied

        Returns

        Fires

          Ext.form.Basic
          view source
          ( obj ) : Ext.form.Basicchainable
          Calls Ext.apply for all fields in this form with the passed object. ...

          Calls Ext.apply for all fields in this form with the passed object.

          Available since: 1.1.0

          Parameters

          • obj : Object

            The object to be applied

          Returns

          Fires

            Ext.form.Basic
            view source
            ( fn )private
            Utility wrapper that suspends layouts of all field parent containers for the duration of a given function. ...

            Utility wrapper that suspends layouts of all field parent containers for the duration of a given function. Used during full-form validation and resets to prevent huge numbers of layouts.

            Available since: 4.0.0

            Parameters

            Fires

              Ext.form.Basic
              view source
              ( action )private
              Called before an action is performed via doAction. ...

              Called before an action is performed via doAction.

              Available since: 3.4.0

              Parameters

              Fires

                Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

                Call the original method that was previously overridden with override

                Ext.define('My.Cat', {
                    constructor: function() {
                        alert("I'm a cat!");
                
                        return this;
                    }
                });
                
                My.Cat.override({
                    constructor: function() {
                        alert("I'm going to be a cat!");
                
                        var instance = this.callOverridden();
                
                        alert("Meeeeoooowwww");
                
                        return instance;
                    }
                });
                
                var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                          // alerts "I'm a cat!"
                                          // alerts "Meeeeoooowwww"
                

                Available since: 4.0.0

                Parameters

                • args : Array/Arguments

                  The arguments, either an array or the arguments object

                Returns

                • Object

                  Returns the result after calling the overridden method

                Call the parent's overridden method. ...

                Call the parent's overridden method. For example:

                Ext.define('My.own.A', {
                    constructor: function(test) {
                        alert(test);
                    }
                });
                
                Ext.define('My.own.B', {
                    extend: 'My.own.A',
                
                    constructor: function(test) {
                        alert(test);
                
                        this.callParent([test + 1]);
                    }
                });
                
                Ext.define('My.own.C', {
                    extend: 'My.own.B',
                
                    constructor: function() {
                        alert("Going to call parent's overriden constructor...");
                
                        this.callParent(arguments);
                    }
                });
                
                var a = new My.own.A(1); // alerts '1'
                var b = new My.own.B(1); // alerts '1', then alerts '2'
                var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
                                         // alerts '2', then alerts '3'
                

                Available since: 4.0.0

                Parameters

                • args : Array/Arguments

                  The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

                Returns

                • Object

                  Returns the result from the superclass' method

                Ext.form.Basic
                view source
                ( )
                Check whether the dirty state of the entire form has changed since it was last checked, and if so fire the dirtychang...

                Check whether the dirty state of the entire form has changed since it was last checked, and if so fire the dirtychange event. This is automatically invoked when an individual field's dirty state changes.

                Available since: 4.0.0

                Fires

                Ext.form.Basic
                view source
                ( )
                Check whether the validity of the entire form has changed since it was last checked, and if so fire the validitychang...

                Check whether the validity of the entire form has changed since it was last checked, and if so fire the validitychange event. This is automatically invoked when an individual field's validity changes.

                Available since: 4.0.0

                Fires

                Ext.form.Basic
                view source
                ( ) : Ext.form.Basicchainable
                Clears all invalid field messages in this form. ...

                Clears all invalid field messages in this form.

                Available since: 1.1.0

                Returns

                Fires

                  Removes all listeners for this object including the managed listeners ...

                  Removes all listeners for this object including the managed listeners

                  Available since: 4.0.0

                  Fires

                    Removes all managed listeners for this object. ...

                    Removes all managed listeners for this object.

                    Available since: 4.0.0

                    Fires

                      ( eventName, args, bubbles )private
                      Continue to fire event. ...

                      Continue to fire event.

                      Available since: Ext JS 4.0.7

                      Parameters

                      Fires

                        Creates an event handling function which refires the event from this object as the passed event name. ...

                        Creates an event handling function which refires the event from this object as the passed event name.

                        Available since: 4.0.0

                        Parameters

                        Returns

                        Ext.form.Basic
                        view source
                        ( )
                        Destroys this object. ...

                        Destroys this object.

                        Available since: 3.4.0

                        Fires

                          Ext.form.Basic
                          view source
                          ( action, [options] ) : Ext.form.Basicchainable
                          Performs a predefined action (an implementation of Ext.form.action.Action) to perform application-specific processing. ...

                          Performs a predefined action (an implementation of Ext.form.action.Action) to perform application-specific processing.

                          Available since: 1.1.0

                          Parameters

                          • action : String/Ext.form.action.Action

                            The name of the predefined action type, or instance of Ext.form.action.Action to perform.

                          • options : Object (optional)

                            The options to pass to the Ext.form.action.Action that will get created, if the action argument is a String.

                            All of the config options listed below are supported by both the submit and load actions unless otherwise noted (custom actions could also accept other config options):

                            • url : String
                              The url for the action (defaults to the form's url.)
                            • method : String
                              The form method to use (defaults to the form's method, or POST if not defined)
                            • params : String/Object

                              The params to pass (defaults to the form's baseParams, or none if not defined)

                              Parameters are encoded as standard HTTP parameters using Ext.Object.toQueryString.

                            • headers : Object
                              Request headers to set for the action.
                            • success : Function
                              The callback that will be invoked after a successful response (see top of submit and load for a description of what constitutes a successful response). The function is passed the following parameters:
                              • form : The Ext.form.Basic that requested the action.
                              • action : The Action object which performed the operation.
                                The action object contains these properties of interest:
                            • failure : Function
                              The callback that will be invoked after a failed transaction attempt. The function is passed the following parameters:
                            • scope : Object
                              The scope in which to call the callback functions (The this reference for the callback functions).
                            • clientValidation : Boolean
                              Submit Action only. Determines whether a Form's fields are validated in a final call to isValid prior to submission. Set to false to prevent this. If undefined, pre-submission field validation is performed.

                          Returns

                          Fires

                          Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. ...

                          Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

                          This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

                          Example:

                          Ext.override(Ext.form.field.Base, {
                              //  Add functionality to Field's initComponent to enable the change event to bubble
                              initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
                                  this.enableBubble('change');
                              }),
                          
                              //  We know that we want Field's events to bubble directly to the FormPanel.
                              getBubbleTarget : function() {
                                  if (!this.formPanel) {
                                      this.formPanel = this.findParentByType('form');
                                  }
                                  return this.formPanel;
                              }
                          });
                          
                          var myForm = new Ext.formPanel({
                              title: 'User Details',
                              items: [{
                                  ...
                              }],
                              listeners: {
                                  change: function() {
                                      // Title goes red if form has been modified.
                                      myForm.header.setStyle('color', 'red');
                                  }
                              }
                          });
                          

                          Available since: 3.4.0

                          Parameters

                          • events : String/String[]

                            The event name to bubble, or an Array of event names.

                          Ext.form.Basic
                          view source
                          ( id ) : Object
                          Find a specific Ext.form.field.Field in this form by id or name. ...

                          Find a specific Ext.form.field.Field in this form by id or name.

                          Available since: 1.1.0

                          Parameters

                          Returns

                          Fires

                            Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addList...

                            Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

                            An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

                            Available since: 1.1.0

                            Parameters

                            • eventName : String

                              The name of the event to fire.

                            • args : Object...

                              Variable number of parameters are passed to handlers.

                            Returns

                            • Boolean

                              returns false if any of the handlers return false otherwise it returns true.

                            Fires

                              Finds and returns the set of all items bound to fields inside this form ...

                              Finds and returns the set of all items bound to fields inside this form

                              Available since: 4.0.0

                              Returns

                              Gets the bubbling parent for an Observable ...

                              Gets the bubbling parent for an Observable

                              Available since: Ext JS 4.0.7

                              Returns

                              Fires

                                Ext.form.Basic
                                view source
                                ( [dirtyOnly] ) : Object
                                Retrieves the fields in the form as a set of key/value pairs, using their getModelData() method to collect the values. ...

                                Retrieves the fields in the form as a set of key/value pairs, using their getModelData() method to collect the values. If multiple fields return values under the same name those values will be combined into an Array. This is similar to getValues except that this method collects type-specific data values (e.g. Date objects for date fields) while getValues returns only String values for submission.

                                Available since: 3.4.0

                                Parameters

                                • dirtyOnly : Boolean (optional)

                                  If true, only fields that are dirty will be included in the result. Defaults to false.

                                Returns

                                Fires

                                  Return all the Ext.form.field.Field components in the owner container. ...

                                  Return all the Ext.form.field.Field components in the owner container.

                                  Available since: 4.0.0

                                  Returns

                                  Returns the last Ext.data.Model instance that was loaded via loadRecord ...

                                  Returns the last Ext.data.Model instance that was loaded via loadRecord

                                  Available since: 4.0.0

                                  Returns

                                  Ext.form.Basic
                                  view source
                                  ( [asString], [dirtyOnly], [includeEmptyText] ) : String/Object
                                  Retrieves the fields in the form as a set of key/value pairs, using their getSubmitData() method to collect the values. ...

                                  Retrieves the fields in the form as a set of key/value pairs, using their getSubmitData() method to collect the values. If multiple fields return values under the same name those values will be combined into an Array. This is similar to getFieldValues except that this method collects only String values for submission, while getFieldValues collects type-specific data values (e.g. Date objects for date fields.)

                                  Available since: 1.1.0

                                  Parameters

                                  • asString : Boolean (optional)

                                    If true, will return the key/value collection as a single URL-encoded param string. Defaults to false.

                                  • dirtyOnly : Boolean (optional)

                                    If true, only fields that are dirty will be included in the result. Defaults to false.

                                  • includeEmptyText : Boolean (optional)

                                    If true, the configured emptyText of empty fields will be used. Defaults to false.

                                  Returns

                                  Fires

                                    Returns true if the form contains any invalid fields. ...

                                    Returns true if the form contains any invalid fields. No fields will be marked as invalid as a result of calling this; to trigger marking of fields use isValid instead.

                                    Available since: 4.0.0

                                    Fires

                                      Checks to see if this object has any listeners for a specified event ...

                                      Checks to see if this object has any listeners for a specified event

                                      Available since: 1.1.0

                                      Parameters

                                      • eventName : String

                                        The name of the event to check for

                                      Returns

                                      • Boolean

                                        True if the event is being listened for, else false

                                      Ext.form.Basic
                                      view source
                                      ( ) : Object
                                      Returns true if the form contains a file upload field. ...

                                      Returns true if the form contains a file upload field. This is used to determine the method for submitting the form: File uploads are not performed using normal 'Ajax' techniques, that is they are not performed using XMLHttpRequests. Instead a hidden <form> element containing all the fields is created temporarily and submitted with its target set to refer to a dynamically generated, hidden <iframe> which is inserted into the document but removed after the return data has been gathered.

                                      The server response is parsed by the browser to create the document for the IFRAME. If the server is using JSON to send the return object, then the Content-Type header must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.

                                      Characters which are significant to an HTML parser must be sent as HTML entities, so encode "<" as "&lt;", "&" as "&amp;" etc.

                                      The response text is retrieved from the document, and a fake XMLHttpRequest object is created containing a responseText property in order to conform to the requirements of event handlers and callbacks.

                                      Be aware that file upload packets are sent with the content type multipart/form and some server technologies (notably JEE) may require some custom processing in order to retrieve parameter names and parameter values from the packet content.

                                      Available since: 4.0.0

                                      Returns

                                      Fires

                                        ( config ) : Objectchainableprotected
                                        Initialize configuration for this class. ...

                                        Initialize configuration for this class. a typical example:

                                        Ext.define('My.awesome.Class', {
                                            // The default config
                                            config: {
                                                name: 'Awesome',
                                                isAwesome: true
                                            },
                                        
                                            constructor: function(config) {
                                                this.initConfig(config);
                                        
                                                return this;
                                            }
                                        });
                                        
                                        var awesome = new My.awesome.Class({
                                            name: 'Super Awesome'
                                        });
                                        
                                        alert(awesome.getName()); // 'Super Awesome'
                                        

                                        Available since: 4.0.0

                                        Parameters

                                        Returns

                                        • Object

                                          mixins The mixin prototypes as key - value pairs

                                        Fires

                                          Ext.form.Basic
                                          view source
                                          ( )private
                                          Do any post constructor initialization ...

                                          Do any post constructor initialization

                                          Available since: 4.0.0

                                          Fires

                                            Ext.form.Basic
                                            view source
                                            ( ) : Object
                                            Returns true if any fields in this form have changed from their original values. ...

                                            Returns true if any fields in this form have changed from their original values.

                                            Note that if this BasicForm was configured with trackResetOnLoad then the Fields' original values are updated when the values are loaded by setValues or loadRecord.

                                            Available since: 1.1.0

                                            Returns

                                            Fires

                                              Ext.form.Basic
                                              view source
                                              ( ) : Object
                                              Returns true if client-side validation on the form is successful. ...

                                              Returns true if client-side validation on the form is successful. Any invalid fields will be marked as invalid. If you only want to determine overall form validity without marking anything, use hasInvalidField instead.

                                              Available since: 1.1.0

                                              Returns

                                              Fires

                                                Ext.form.Basic
                                                view source
                                                ( options ) : Ext.form.Basicchainable
                                                Shortcut to do a load action. ...

                                                Shortcut to do a load action.

                                                Available since: 1.1.0

                                                Parameters

                                                • options : Object

                                                  The options to pass to the action (see doAction for details)

                                                Returns

                                                Fires

                                                Ext.form.Basic
                                                view source
                                                ( record ) : Ext.form.Basicchainable
                                                Loads an Ext.data.Model into this form by calling setValues with the record data. ...

                                                Loads an Ext.data.Model into this form by calling setValues with the record data. See also trackResetOnLoad.

                                                Available since: 1.1.0

                                                Parameters

                                                Returns

                                                Fires

                                                  Ext.form.Basic
                                                  view source
                                                  ( errors ) : Ext.form.Basicchainable
                                                  Mark fields in this form invalid in bulk. ...

                                                  Mark fields in this form invalid in bulk.

                                                  Available since: 1.1.0

                                                  Parameters

                                                  Returns

                                                  Fires

                                                    ( name, cls )private
                                                    Used internally by the mixins pre-processor ...

                                                    Used internally by the mixins pre-processor

                                                    Available since: 4.0.6

                                                    Parameters

                                                    Fires

                                                      ( item, ename, [fn], [scope], [opt] )
                                                      Shorthand for addManagedListener. ...

                                                      Shorthand for addManagedListener.

                                                      Available since: 4.0.2

                                                      Parameters

                                                      • item : Ext.util.Observable/Ext.Element

                                                        The item to which to add a listener/listeners.

                                                      • ename : Object/String

                                                        The event name, or an object containing event name properties.

                                                      • fn : Function (optional)

                                                        If the ename parameter was an event name, this is the handler function.

                                                      • scope : Object (optional)

                                                        If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

                                                      • opt : Object (optional)

                                                        If the ename parameter was an event name, this is the addListener options.

                                                      ( item, ename, [fn], [scope] )
                                                      Shorthand for removeManagedListener. ...

                                                      Shorthand for removeManagedListener.

                                                      Available since: 4.0.2

                                                      Parameters

                                                      • item : Ext.util.Observable/Ext.Element

                                                        The item from which to remove a listener/listeners.

                                                      • ename : Object/String

                                                        The event name, or an object containing event name properties.

                                                      • fn : Function (optional)

                                                        If the ename parameter was an event name, this is the handler function.

                                                      • scope : Object (optional)

                                                        If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

                                                      ( eventName, fn, [scope], [options] )
                                                      Shorthand for addListener. ...

                                                      Shorthand for addListener.

                                                      Available since: 1.1.0

                                                      Parameters

                                                      • eventName : String

                                                        The name of the event to listen for. May also be an object who's property names are event names.

                                                      • fn : Function

                                                        The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

                                                      • scope : Object (optional)

                                                        The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

                                                      • options : Object (optional)

                                                        An object containing handler configuration.

                                                        Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

                                                        This object may contain any of the following properties:

                                                        • scope : Object

                                                          The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

                                                        • delay : Number

                                                          The number of milliseconds to delay the invocation of the handler after the event fires.

                                                        • single : Boolean

                                                          True to add a handler to handle just the next firing of the event, and then remove itself.

                                                        • buffer : Number

                                                          Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

                                                        • target : Observable

                                                          Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

                                                        • element : String

                                                          This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

                                                          This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

                                                          new Ext.panel.Panel({
                                                              title: 'The title',
                                                              listeners: {
                                                                  click: this.handlePanelClick,
                                                                  element: 'body'
                                                              }
                                                          });
                                                          

                                                        Combining Options

                                                        Using the options argument, it is possible to combine different types of listeners:

                                                        A delayed, one-time listener.

                                                        myPanel.on('hide', this.handleClick, this, {
                                                            single: true,
                                                            delay: 100
                                                        });
                                                        

                                                        Attaching multiple handlers in 1 call

                                                        The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

                                                        myGridPanel.on({
                                                            cellClick: this.onCellClick,
                                                            mouseover: this.onMouseOver,
                                                            mouseout: this.onMouseOut,
                                                            scope: this // Important. Ensure "this" is correct during handler execution
                                                        });
                                                        

                                                        One can also specify options for each event handler separately:

                                                        myGridPanel.on({
                                                            cellClick: {fn: this.onCellClick, scope: this, single: true},
                                                            mouseover: {fn: panel.onMouseOver, scope: panel}
                                                        });
                                                        
                                                      Ext.form.Basic
                                                      view source
                                                      ( parent, child )private
                                                      Handle addition or removal of descendant items. ...

                                                      Handle addition or removal of descendant items. Invalidates the cached list of fields so that getFields will do a fresh query next time it is called. Also adds listeners for state change events on added fields, and tracks components with formBind=true.

                                                      Available since: 4.0.0

                                                      Parameters

                                                      Ext.form.Basic
                                                      view source
                                                      ( valid )private
                                                      Handle changes in the form's validity. ...

                                                      Handle changes in the form's validity. If there are any sub components with formBind=true then they are enabled/disabled based on the new validity.

                                                      Available since: 4.0.0

                                                      Parameters

                                                      Fires

                                                        ( name, value )private
                                                        ...

                                                        Available since: 4.0.6

                                                        Parameters

                                                        Fires

                                                          ( name, fn )private
                                                          ...

                                                          Available since: 4.0.0

                                                          Parameters

                                                          ...

                                                          Available since: 1.1.0

                                                          ...

                                                          Available since: 4.0.0

                                                          Relays selected events from the specified Observable as if the events were fired by this. ...

                                                          Relays selected events from the specified Observable as if the events were fired by this.

                                                          Available since: 2.3.0

                                                          Parameters

                                                          • origin : Object

                                                            The Observable whose events this object is to relay.

                                                          • events : String[]

                                                            Array of event names to relay.

                                                          • prefix : String

                                                          Fires

                                                            Removes an event handler. ...

                                                            Removes an event handler.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            • eventName : String

                                                              The type of event the handler was associated with.

                                                            • fn : Function

                                                              The handler to remove. This must be a reference to the function passed into the addListener call.

                                                            • scope : Object (optional)

                                                              The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                            Fires

                                                              Removes listeners that were added by the mon method. ...

                                                              Removes listeners that were added by the mon method.

                                                              Available since: 4.0.0

                                                              Parameters

                                                              • item : Ext.util.Observable/Ext.Element

                                                                The item from which to remove a listener/listeners.

                                                              • ename : Object/String

                                                                The event name, or an object containing event name properties.

                                                              • fn : Function (optional)

                                                                If the ename parameter was an event name, this is the handler function.

                                                              • scope : Object (optional)

                                                                If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

                                                              Fires

                                                                Remove a single managed listener item ...

                                                                Remove a single managed listener item

                                                                Available since: 4.0.1

                                                                Parameters

                                                                • isClear : Boolean

                                                                  True if this is being called during a clear

                                                                • managedListener : Object

                                                                  The managed listener item See removeManagedListener for other args

                                                                Ext.form.Basic
                                                                view source
                                                                ( ) : Ext.form.Basicchainable
                                                                Resets all fields in this form. ...

                                                                Resets all fields in this form.

                                                                Available since: 1.1.0

                                                                Returns

                                                                Fires

                                                                  Resumes firing events (see suspendEvents). ...

                                                                  Resumes firing events (see suspendEvents).

                                                                  If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

                                                                  Available since: 2.3.0

                                                                  ( config ) : Ext.Basechainableprivate
                                                                  ...

                                                                  Available since: 4.0.0

                                                                  Parameters

                                                                  Returns

                                                                  Fires

                                                                    Ext.form.Basic
                                                                    view source
                                                                    ( values ) : Ext.form.Basicchainable
                                                                    Set values for fields in this form in bulk. ...

                                                                    Set values for fields in this form in bulk.

                                                                    Available since: 1.1.0

                                                                    Parameters

                                                                    • values : Object/Object[]

                                                                      Either an array in the form:

                                                                      [{id:'clientName', value:'Fred. Olsen Lines'},
                                                                       {id:'portOfLoading', value:'FXT'},
                                                                       {id:'portOfDischarge', value:'OSL'} ]

                                                                      or an object hash of the form:

                                                                      {
                                                                          clientName: 'Fred. Olsen Lines',
                                                                          portOfLoading: 'FXT',
                                                                          portOfDischarge: 'OSL'
                                                                      }

                                                                    Returns

                                                                    Fires

                                                                      Get the reference to the class from which this object was instantiated. ...

                                                                      Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

                                                                      Ext.define('My.Cat', {
                                                                          statics: {
                                                                              totalCreated: 0,
                                                                              speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
                                                                          },
                                                                      
                                                                          constructor: function() {
                                                                              var statics = this.statics();
                                                                      
                                                                              alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                                                                                              // equivalent to: My.Cat.speciesName
                                                                      
                                                                              alert(this.self.speciesName);   // dependent on 'this'
                                                                      
                                                                              statics.totalCreated++;
                                                                      
                                                                              return this;
                                                                          },
                                                                      
                                                                          clone: function() {
                                                                              var cloned = new this.self;                      // dependent on 'this'
                                                                      
                                                                              cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
                                                                      
                                                                              return cloned;
                                                                          }
                                                                      });
                                                                      
                                                                      
                                                                      Ext.define('My.SnowLeopard', {
                                                                          extend: 'My.Cat',
                                                                      
                                                                          statics: {
                                                                              speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
                                                                          },
                                                                      
                                                                          constructor: function() {
                                                                              this.callParent();
                                                                          }
                                                                      });
                                                                      
                                                                      var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
                                                                      
                                                                      var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
                                                                      
                                                                      var clone = snowLeopard.clone();
                                                                      alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
                                                                      alert(clone.groupName);                 // alerts 'Cat'
                                                                      
                                                                      alert(My.Cat.totalCreated);             // alerts 3
                                                                      

                                                                      Available since: 4.0.0

                                                                      Returns

                                                                      Ext.form.Basic
                                                                      view source
                                                                      ( options ) : Ext.form.Basicchainable
                                                                      Shortcut to do a submit action. ...

                                                                      Shortcut to do a submit action. This will use the AJAX submit action by default. If the standardSubmit config is enabled it will use a standard form element to submit, or if the api config is present it will use the Ext.direct.Direct submit action.

                                                                      Available since: 1.1.0

                                                                      Parameters

                                                                      • options : Object

                                                                        The options to pass to the action (see doAction for details).

                                                                        The following code:

                                                                        myFormPanel.getForm().submit({
                                                                            clientValidation: true,
                                                                            url: 'updateConsignment.php',
                                                                            params: {
                                                                                newStatus: 'delivered'
                                                                            },
                                                                            success: function(form, action) {
                                                                               Ext.Msg.alert('Success', action.result.msg);
                                                                            },
                                                                            failure: function(form, action) {
                                                                                switch (action.failureType) {
                                                                                    case Ext.form.action.Action.CLIENT_INVALID:
                                                                                        Ext.Msg.alert('Failure', 'Form fields may not be submitted with invalid values');
                                                                                        break;
                                                                                    case Ext.form.action.Action.CONNECT_FAILURE:
                                                                                        Ext.Msg.alert('Failure', 'Ajax communication failed');
                                                                                        break;
                                                                                    case Ext.form.action.Action.SERVER_INVALID:
                                                                                       Ext.Msg.alert('Failure', action.result.msg);
                                                                               }
                                                                            }
                                                                        });
                                                                        

                                                                        would process the following server response for a successful submission:

                                                                        {
                                                                            "success":true, // note this is Boolean, not string
                                                                            "msg":"Consignment updated"
                                                                        }
                                                                        

                                                                        and the following server response for a failed submission:

                                                                        {
                                                                            "success":false, // note this is Boolean, not string
                                                                            "msg":"You do not have permission to perform this operation"
                                                                        }
                                                                        

                                                                      Returns

                                                                      Fires

                                                                      Suspends the firing of all events. ...

                                                                      Suspends the firing of all events. (see resumeEvents)

                                                                      Available since: 2.3.0

                                                                      Parameters

                                                                      • queueSuspended : Boolean

                                                                        Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

                                                                      ( eventName, fn, [scope] )
                                                                      Shorthand for removeListener. ...

                                                                      Shorthand for removeListener.

                                                                      Available since: 1.1.0

                                                                      Parameters

                                                                      • eventName : String

                                                                        The type of event the handler was associated with.

                                                                      • fn : Function

                                                                        The handler to remove. This must be a reference to the function passed into the addListener call.

                                                                      • scope : Object (optional)

                                                                        The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                                      Ext.form.Basic
                                                                      view source
                                                                      ( record ) : Ext.form.Basicchainable
                                                                      Persists the values in this form into the passed Ext.data.Model object in a beginEdit/endEdit block. ...

                                                                      Persists the values in this form into the passed Ext.data.Model object in a beginEdit/endEdit block.

                                                                      Available since: 1.1.0

                                                                      Parameters

                                                                      Returns

                                                                      Fires

                                                                        Defined By

                                                                        Static methods

                                                                        ( members ) : Ext.Basechainablestatic
                                                                        Add / override static properties of this class. ...

                                                                        Add / override static properties of this class.

                                                                        Ext.define('My.cool.Class', {
                                                                            ...
                                                                        });
                                                                        
                                                                        My.cool.Class.addStatics({
                                                                            someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
                                                                            method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
                                                                            method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
                                                                        });
                                                                        

                                                                        Available since: 4.0.2

                                                                        Parameters

                                                                        Returns

                                                                        ( fromClass, members ) : Ext.Basechainablestatic
                                                                        Borrow another class' members to the prototype of this class. ...

                                                                        Borrow another class' members to the prototype of this class.

                                                                        Ext.define('Bank', {
                                                                            money: '$$$',
                                                                            printMoney: function() {
                                                                                alert('$$$$$$$');
                                                                            }
                                                                        });
                                                                        
                                                                        Ext.define('Thief', {
                                                                            ...
                                                                        });
                                                                        
                                                                        Thief.borrow(Bank, ['money', 'printMoney']);
                                                                        
                                                                        var steve = new Thief();
                                                                        
                                                                        alert(steve.money); // alerts '$$$'
                                                                        steve.printMoney(); // alerts '$$$$$$$'
                                                                        

                                                                        Available since: 4.0.2

                                                                        Parameters

                                                                        • fromClass : Ext.Base

                                                                          The class to borrow members from

                                                                        • members : String/String[]

                                                                          The names of the members to borrow

                                                                        Returns

                                                                        Create a new instance of this Class. ...

                                                                        Create a new instance of this Class.

                                                                        Ext.define('My.cool.Class', {
                                                                            ...
                                                                        });
                                                                        
                                                                        My.cool.Class.create({
                                                                            someConfig: true
                                                                        });
                                                                        

                                                                        All parameters are passed to the constructor of the class.

                                                                        Available since: 4.0.2

                                                                        Returns

                                                                        ( alias, origin )static
                                                                        Create aliases for existing prototype methods. ...

                                                                        Create aliases for existing prototype methods. Example:

                                                                        Ext.define('My.cool.Class', {
                                                                            method1: function() { ... },
                                                                            method2: function() { ... }
                                                                        });
                                                                        
                                                                        var test = new My.cool.Class();
                                                                        
                                                                        My.cool.Class.createAlias({
                                                                            method3: 'method1',
                                                                            method4: 'method2'
                                                                        });
                                                                        
                                                                        test.method3(); // test.method1()
                                                                        
                                                                        My.cool.Class.createAlias('method5', 'method3');
                                                                        
                                                                        test.method5(); // test.method3() -> test.method1()
                                                                        

                                                                        Available since: 4.0.2

                                                                        Parameters

                                                                        Get the current class' name in string format. ...

                                                                        Get the current class' name in string format.

                                                                        Ext.define('My.cool.Class', {
                                                                            constructor: function() {
                                                                                alert(this.self.getName()); // alerts 'My.cool.Class'
                                                                            }
                                                                        });
                                                                        
                                                                        My.cool.Class.getName(); // 'My.cool.Class'
                                                                        

                                                                        Available since: 4.0.4

                                                                        Returns

                                                                        Add methods / properties to the prototype of this class. ...

                                                                        Add methods / properties to the prototype of this class.

                                                                        Ext.define('My.awesome.Cat', {
                                                                            constructor: function() {
                                                                                ...
                                                                            }
                                                                        });
                                                                        
                                                                         My.awesome.Cat.implement({
                                                                             meow: function() {
                                                                                alert('Meowww...');
                                                                             }
                                                                         });
                                                                        
                                                                         var kitty = new My.awesome.Cat;
                                                                         kitty.meow();
                                                                        

                                                                        Available since: 4.0.2

                                                                        Parameters

                                                                        ( members ) : Ext.Basechainablestatic
                                                                        Override prototype members of this class. ...

                                                                        Override prototype members of this class. Overridden methods can be invoked via callOverridden

                                                                        Ext.define('My.Cat', {
                                                                            constructor: function() {
                                                                                alert("I'm a cat!");
                                                                        
                                                                                return this;
                                                                            }
                                                                        });
                                                                        
                                                                        My.Cat.override({
                                                                            constructor: function() {
                                                                                alert("I'm going to be a cat!");
                                                                        
                                                                                var instance = this.callOverridden();
                                                                        
                                                                                alert("Meeeeoooowwww");
                                                                        
                                                                                return instance;
                                                                            }
                                                                        });
                                                                        
                                                                        var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                                                                                  // alerts "I'm a cat!"
                                                                                                  // alerts "Meeeeoooowwww"
                                                                        

                                                                        Available since: 4.0.2

                                                                        Parameters

                                                                        Returns

                                                                        Defined By

                                                                        Events

                                                                        Ext.form.Basic
                                                                        view source
                                                                        ( this, action, eOpts )
                                                                        Fires when an action is completed. ...

                                                                        Fires when an action is completed.

                                                                        Available since: 1.1.0

                                                                        Parameters

                                                                        Ext.form.Basic
                                                                        view source
                                                                        ( this, action, eOpts )
                                                                        Fires when an action fails. ...

                                                                        Fires when an action fails.

                                                                        Available since: 1.1.0

                                                                        Parameters

                                                                        Ext.form.Basic
                                                                        view source
                                                                        ( this, action, eOpts )
                                                                        Fires before any action is performed. ...

                                                                        Fires before any action is performed. Return false to cancel the action.

                                                                        Available since: 1.1.0

                                                                        Parameters

                                                                        Ext.form.Basic
                                                                        view source
                                                                        ( this, dirty, eOpts )
                                                                        Fires when the dirty state of the entire form changes. ...

                                                                        Fires when the dirty state of the entire form changes.

                                                                        Available since: 4.0.0

                                                                        Parameters

                                                                        Ext.form.Basic
                                                                        view source
                                                                        ( this, valid, eOpts )
                                                                        Fires when the validity of the entire form changes. ...

                                                                        Fires when the validity of the entire form changes.

                                                                        Available since: 4.0.0

                                                                        Parameters