For up to date documentation and features, visit http://docs.sencha.com/ext-js/4-0

## Sencha Documentation

# Ext.form.Basic

####

    HierarchyExt.util.ObservableExt.form.Basic

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.

Note: File uploads are not performed using normal 'Ajax' techniques; see the description for hasUpload for details.

# 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);
                        }
                    });
                }
            }
        }]
    });

Defined By

### Config Options

#### Other Configs

Ext.form.Basic
view source
api : 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.

Ext.form.Basic
view source
baseParams : Object
Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}. Parameters are encoded as standard ...

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

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

Ext.form.Basic
view source
errorReader : Ext.data.reader.Reader
An Ext.data.DataReader (e.g. Ext.data.reader.Xml) to be used to read field error messages returned from 'submit' acti...

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
    }

Ext.util.Observable
view source
listeners : Object
(optional) A config object containing one or more event handlers to be added to this object during initialization. T...

(optional)

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 ExtJs Components

While some ExtJs 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 `click` 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'); }
            }
        }
    });

Ext.form.Basic
view source
method : 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.

Ext.form.Basic
view source
paramOrder : Array/String
A list of params to be executed server side. Defaults to undefined. Only used for the api load configuration. Speci...

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'

Ext.form.Basic
view source
paramsAsHash : Boolean
Only used for the api load configuration. If true, parameters will be sent as a single hash collection of named argum...

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

Ext.form.Basic
view source
reader : Ext.data.reader.Reader
An Ext.data.DataReader (e.g. Ext.data.reader.Xml) to be used to read data when executing 'load' actions. This is opti...

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.

Ext.form.Basic
view source
standardSubmit : Boolean
If set to true, a standard HTML form submit is used instead of a XHR (Ajax) style form submission. Defaults to false....

If set to `true`, a standard HTML form submit is used instead of a XHR (Ajax) style form submission. Defaults to `false`. 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.

Ext.form.Basic
view source
timeout : Number

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

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

Ext.form.Basic
view source
trackResetOnLoad : Boolean
If set to true, reset() resets to the last loaded or setValues() data instead of when the form was first created. De...

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

Ext.form.Basic
view source
url : 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.

Ext.form.Basic
view source
waitMsgTarget : Mixed
By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific element by passing it or i...

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. Defaults to `undefined`.

Ext.form.Basic
view source
waitTitle : String

The default title to show for the waiting message box (defaults to `'Please Wait...'`)

The default title to show for the waiting message box (defaults to `'Please Wait...'`)

Defined By

### Properties

Ext.form.Basic
view source
owner : Ext.container.Container

The container component to which this BasicForm is attached.

The container component to which this BasicForm is attached.

Defined By

### Methods

Ext.form.Basic
view source
Basic( Ext.container.Container owner, Object config) : void

### Parameters

- owner : Ext.container.Container

  The component that is the container for the form, usually a Ext.form.Panel

- config : Object

  Configuration options. These are normally specified in the config to the Ext.form.Panel constructor, which passes them along to the BasicForm automatically.

### Returns

- void

Ext.util.Observable
view source
addEvents( Object/String o, String ) : void

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.

### 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.

- : String

  [additional] Optional additional event names if multiple event names are being passed as separate parameters. Usage:

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

### Returns

- void

Ext.util.Observable
view source
addListener( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object.

Appends an event handler to this object.

### Parameters

- eventName : String

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

- handler : Function

  The method the event invokes.

- 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. properties. This 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'
            }
        });

    When added in this way, the options available are the options applicable to Ext.core.Element.addListener

  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
      });

  .

### Returns

- void

Ext.util.Observable
view source
addManagedListener( Observable/Element item, Object/String ename, Function fn, Object scope, Object opt) : void

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

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

### Parameters

- item : Observable/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.

### Returns

- void

Ext.form.Basic
view source
applyIfToFields( Object obj) : Ext.form.Basic

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.

### Parameters

- obj : Object

  The object to be applied

### Returns

- Ext.form.Basic

  this

Ext.form.Basic
view source
applyToFields( Object obj) : Ext.form.Basic

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.

### Parameters

- obj : Object

  The object to be applied

### Returns

- Ext.form.Basic

  this

Ext.util.Observable
view source
capture( Observable o, Function fn, [Object scope]) : void
Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + ...

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.

### Parameters

- o : Observable

  The Observable to capture events from.

- fn : Function

  The function to call when an event is fired.

- scope : Object

  (optional) The scope (`this` reference) in which the function is executed. Defaults to the Observable firing the event.

### Returns

- void

Ext.form.Basic
view source
checkDirty : void
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.

### Returns

- void

Ext.form.Basic
view source
checkValidity : void
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.

### Returns

- void

Ext.form.Basic
view source
clearInvalid : Ext.form.Basic

Clears all invalid field messages in this form.

Clears all invalid field messages in this form.

### Returns

- Ext.form.Basic

  this

Ext.util.Observable
view source
clearListeners : void

Removes all listeners for this object including the managed listeners

Removes all listeners for this object including the managed listeners

### Returns

- void

Ext.util.Observable
view source
clearManagedListeners : void

Removes all managed listeners for this object.

Removes all managed listeners for this object.

### Returns

- void

Ext.form.Basic
view source
destroy : void

Destroys this object.

Destroys this object.

### Returns

- void

Ext.form.Basic
view source
doAction( String/Ext.form.action.Action action, [Object options]) : Ext.form.Basic

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.

### 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:
      - `response`
      - `result` : interrogate for custom postprocessing
      - `type`
  - failure : Function
    The callback that will be invoked after a failed transaction attempt. 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:
      - `failureType`
      - `response`
      - `result` : interrogate for custom postprocessing
      - `type`
  - 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

- Ext.form.Basic

  this

Ext.util.Observable
view source
enableBubble( String/Array events) : void
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');
        }
    }
    });

### Parameters

- events : String/Array

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

### Returns

- void

Ext.form.Basic
view source
findField( String id) : void

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.

### Parameters

- id : String

  The value to search for (specify either a id or name or hiddenName).

### Returns

- void

  Ext.form.field.Field The first matching field, or `null` if none was found.

Ext.util.Observable
view source
fireEvent( String eventName, Object... args) : Boolean
Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Ob...

Fires the specified event with the passed parameters (minus the event name).

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

### 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.

Ext.form.Basic
view source
getFieldValues( [Boolean 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.

### Parameters

- dirtyOnly : Boolean

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

### Returns

- Object

Ext.form.Basic
view source
getFields : Ext.util.MixedCollection

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

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

### Returns

- Ext.util.MixedCollection

  Collection of the Field objects

Ext.form.Basic
view source
getRecord : Ext.data.Model

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

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

### Returns

- Ext.data.Model

  The record

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

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.)

### 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.

- useDataValues : Object

### Returns

- String/Object

Ext.form.Basic
view source
hasInvalidField : void
Returns true if the form contains any invalid fields. No fields will be marked as invalid as a result of calling this...

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.

### Returns

- void

Ext.util.Observable
view source
hasListener( String eventName) : Boolean

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

### 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
hasUpload : void
Returns true if the form contains a file upload field. This is used to determine the method for submitting the form: ...

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.

### Returns

- void

  Boolean

Ext.form.Basic
view source
isDirty : void
Returns true if any fields in this form have changed from their original values. Note that if this BasicForm was co...

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.

### Returns

- void

  Boolean

Ext.form.Basic
view source
isValid : void
Returns true if client-side validation on the form is successful. Any invalid fields will be marked as invalid. If yo...

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.

### Returns

- void

  Boolean

Ext.form.Basic
view source
load( Object options) : Ext.form.Basic

Shortcut to do a load action.

Shortcut to do a load action.

### Parameters

- options : Object

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

### Returns

- Ext.form.Basic

  this

Ext.form.Basic
view source
loadRecord( Ext.data.Model record) : Ext.form.Basic

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

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

### Parameters

- record : Ext.data.Model

  The record to load

### Returns

- Ext.form.Basic

  this

Ext.form.Basic
view source
markInvalid( Array/Object errors) : Ext.form.Basic

Mark fields in this form invalid in bulk.

Mark fields in this form invalid in bulk.

### Parameters

- errors : Array/Object

  Either an array in the form `[{id:'fieldId', msg:'The message'}, ...]`, an object hash of `{id: msg, id2: msg2}`, or a Ext.data.Errors object.

### Returns

- Ext.form.Basic

  this

Ext.util.Observable
view source
observe( Function c, Object listeners) : void
Sets observability on the passed class constructor. This makes any event fired on any instance of the passed class a...

Sets observability on the passed class constructor.

This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.

Usage:

    Ext.util.Observable.observe(Ext.data.Connection);
    Ext.data.Connection.on('beforerequest', function(con, options) {
        console.log('Ajax request made to ' + options.url);
    });

### Parameters

- c : Function

  The class constructor to make observable.

- listeners : Object

  An object containing a series of listeners to add. See addListener.

### Returns

- void

Ext.util.Observable
view source
on( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object (shorthand for addListener.)

Appends an event handler to this object (shorthand for addListener.)

### Parameters

- eventName : String

  The type of event to listen for

- handler : Function

  The method the event invokes

- 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.

### Returns

- void

Ext.util.Observable
view source
relayEvents( Object origin, Array events, Object prefix) : void

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`.

### Parameters

- origin : Object

  The Observable whose events this object is to relay.

- events : Array

  Array of event names to relay.

- prefix : Object

### Returns

- void

Ext.util.Observable
view source
releaseCapture( Observable o) : void

Removes all added captures from the Observable.

Removes all added captures from the Observable.

### Parameters

- o : Observable

  The Observable to release

### Returns

- void

Ext.util.Observable
view source
removeListener( String eventName, Function handler, [Object scope]) : void

Removes an event handler.

Removes an event handler.

### Parameters

- eventName : String

  The type of event the handler was associated with.

- handler : 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.

### Returns

- void

Ext.util.Observable
view source
removeManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope) : void

Removes listeners that were added by the mon method.

Removes listeners that were added by the mon method.

### Parameters

- item : Observable|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.

### Returns

- void

Ext.form.Basic
view source
reset : Ext.form.Basic

Resets all fields in this form.

Resets all fields in this form.

### Returns

- Ext.form.Basic

  this

Ext.util.Observable
view source
resumeEvents : void
Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event...

Resume 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.

### Returns

- void

Ext.form.Basic
view source
setValues( Array/Object values) : Ext.form.Basic

Set values for fields in this form in bulk.

Set values for fields in this form in bulk.

### Parameters

- values : Array/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

- Ext.form.Basic

  this

Ext.form.Basic
view source
submit( Object options) : Ext.form.Basic
Shortcut to do a submit action. This will use the AJAX submit action by default. If the standardsubmit config is enab...

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.

### 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

- Ext.form.Basic

  this

Ext.util.Observable
view source
suspendEvents( Boolean queueSuspended) : void

Suspend the firing of all events. (see resumeEvents)

Suspend the firing of all events. (see resumeEvents)

### Parameters

- queueSuspended : Boolean

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

### Returns

- void

Ext.util.Observable
view source
un( String eventName, Function handler, [Object scope]) : void

Removes an event handler (shorthand for removeListener.)

Removes an event handler (shorthand for removeListener.)

### Parameters

- eventName : String

  The type of event the handler was associated with.

- handler : 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.

### Returns

- void

Ext.form.Basic
view source
updateRecord( Ext.data.Record record) : Ext.form.Basic

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.

### Parameters

- record : Ext.data.Record

  The record to edit

### Returns

- Ext.form.Basic

  this

Defined By

### Events

Ext.form.Basic
view source
actioncomplete( Ext.form.Basic this, Ext.form.action.Action action)

Fires when an action is completed.

Fires when an action is completed.

### Parameters

- this : Ext.form.Basic
- action : Ext.form.action.Action

  The Ext.form.action.Action that completed

Ext.form.Basic
view source
actionfailed( Ext.form.Basic this, Ext.form.action.Action action)

Fires when an action fails.

Fires when an action fails.

### Parameters

- this : Ext.form.Basic
- action : Ext.form.action.Action

  The Ext.form.action.Action that failed

Ext.form.Basic
view source
beforeaction( Ext.form.Basic this, Ext.form.action.Action action)

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

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

### Parameters

- this : Ext.form.Basic
- action : Ext.form.action.Action

  The Ext.form.action.Action to be performed

Ext.form.Basic
view source
dirtychange( Ext.form.Basic this, Boolean dirty)

Fires when the dirty state of the entire form changes.

Fires when the dirty state of the entire form changes.

### Parameters

- this : Ext.form.Basic
- dirty : Boolean

  `true` if the form is now dirty, `false` if it is no longer dirty.

Ext.form.Basic
view source
validitychange( Ext.form.Basic this, Boolean valid)

Fires when the validity of the entire form changes.

Fires when the validity of the entire form changes.

### Parameters

- this : Ext.form.Basic
- valid : Boolean

  `true` if the form is now valid, `false` if it is now invalid.