Properties Methods Events Config Options Direct Link

    Observable
      BasicForm

# Class Ext.form.BasicForm

Package: | Ext.form
Defined In: | BasicForm.js
Class: | BasicForm
Extends: | Observable

Encapsulates the DOM <form> element at the heart of the FormPanel class, and provides input field management, validation, submission, and form loading services.

By default, Ext Forms are submitted through Ajax, using an instance of Ext.form.Action.Submit. To enable normal browser submission of an Ext Form, use the standardSubmit config option.

## File Uploads

File uploads are not performed using Ajax submission, that is they are not performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the DOM `<form>` element temporarily modified to have 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.

## Config Options

Config Options | Defined By
--- | ---
| baseParams : Object Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}. Parameters are encoded as standard HT... Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}. Parameters are encoded as standard HTTP parameters using Ext.urlEncode. | BasicForm
| errorReader : DataReader An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read field error messages returned from "submit" actio... An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read field error messages returned from "submit" actions. This is completely optional as there is built-in support for processing JSON. 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 DataReader. It simply needs to implement a `read(xhr)` function which returns an Array of Records in an object with the following structure:
    {
        records: recordArray
    }
| BasicForm
| fileUpload : Boolean Set to true if this form is a file upload. File uploads are not performed using normal "Ajax" techniques, that is the... Set to true if this form is a file upload. File uploads are not performed using normal "Ajax" techniques, that is they are not performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the DOM `<form>` element temporarily modified to have 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. | BasicForm
| listeners : Object (optional) A config object containing one or more event handlers to be added to this object during initialization. Th... (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. | Observable
| method : String The request method to use (GET or POST) for form actions if one isn't supplied in the action options. | BasicForm
| reader : DataReader An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read data when executing "load" actions. This is optio... An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read data when executing "load" actions. This is optional as there is built-in support for processing JSON. | BasicForm
| standardSubmit : Boolean If set to true, standard HTML form submits are used instead of XHR (Ajax) style form submissions. (defaults to false)... If set to true, standard HTML form submits are used instead of XHR (Ajax) style form submissions. (defaults to false) Note: When using standardSubmit, any the options to submit are ignored because Ext's Ajax infrastracture is bypassed. To pass extra parameters, you will need to create hidden fields within the form. | BasicForm
| timeout : Number Timeout for form actions in seconds (default is 30 seconds). | BasicForm
| trackResetOnLoad : Boolean If set to true, form.reset() resets to the last loaded or setValues() data instead of when the form was first created. | BasicForm
| url : String The URL to use for form actions if one isn't supplied in the action options. | BasicForm

## Public Properties

Property | Defined By
--- | ---
| waitMsgTarget : Mixed By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific element by passing it or ... 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. | BasicForm

## Public Methods

Method | Defined By
--- | ---
| BasicForm( `Mixed el`, `Object config` ) Parameters: `el` : Mixed The form element or its id `config` : Object Configuration options Returns: `` | BasicForm
| add( `Field field1`, [`Field field2`], [`Field etc`] ) : BasicForm Add Ext.form Components to this form's Collection. This does not result in rendering of the passed Component, it just... Add Ext.form Components to this form's Collection. This does not result in rendering of the passed Component, it just enables the form to validate Fields, and distribute values to Fields. You will not usually call this function. In order to be rendered, a Field must be added to a Container, usually an FormPanel. The FormPanel to which the field is added takes care of adding the Field to the BasicForm's collection. Parameters: `field1` : Field `field2` : Field (optional) `etc` : Field (optional) Returns: `BasicForm` this | BasicForm
| addEvents( `Object object` ) : void Used to define events on this Observable Used to define events on this Observable Parameters: `object` : Object The object with the events defined Returns: `void` | Observable
- | addListener( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this component Appends an event handler to this component 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 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. Combining Options Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener.
      myDataView.on('click', this.onClick, 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 handlers.
      myGridPanel.on({
          'click' : {
              fn: this.onClick,
              scope: this,
              delay: 100
          },
          'mouseover' : {
              fn: this.onMouseOver,
              scope: this
          },
          'mouseout' : {
              fn: this.onMouseOut,
              scope: this
          }
      });
  Or a shorthand syntax:
      myGridPanel.on({
          'click' : this.onClick,
          'mouseover' : this.onMouseOver,
          'mouseout' : this.onMouseOut,
           scope: this
      });
Returns: `void` | Observable
| applyIfToFields( `Object values` ) : BasicForm 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: `values` : Object Returns: `BasicForm` this | BasicForm
| applyToFields( `Object values` ) : BasicForm 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: `values` : Object Returns: `BasicForm` this | BasicForm
| clearInvalid() : BasicForm Clears all invalid messages in this form. Clears all invalid messages in this form. Parameters: None. Returns: `BasicForm` this | BasicForm
| doAction( `String/Object actionName`, [`Object options`] ) : BasicForm Performs a predefined action (Ext.form.Action.Submit or Ext.form.Action.Load) or a custom extension of Ext.form.Actio... Performs a predefined action (Ext.form.Action.Submit or Ext.form.Action.Load) or a custom extension of Ext.form.Action to perform application-specific processing. Parameters: `actionName` : String/Object The name of the predefined action type, or instance of Ext.form.Action to perform. `options` : Object (optional) The options to pass to the Ext.form.Action. 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.urlEncode. headers : Object Request headers to set for the action (defaults to the form's default headers) success : Function The callback that will be invoked after a successful response. The function is passed the following parameters: `form` : Ext.form.BasicForm The form that requested the action `action` : Ext.form.Action The Action object which performed the operation. The result property of this object may be examined to perform custom postprocessing. failure : Function The callback that will be invoked after a failed transaction attempt. The function is passed the following parameters: `form` : Ext.form.BasicForm The form that requested the action `action` : Ext.form.Action The Action object which performed the operation. If an Ajax error ocurred, the failure type will be in failureType. The result property of this object may be examined to perform custom postprocessing. 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: `BasicForm` this | BasicForm
| findField( `String id` ) : Field Find a Ext.form.Field in this form by id, dataIndex, name or hiddenName. Find a Ext.form.Field in this form by id, dataIndex, name or hiddenName. Parameters: `id` : String The value to search for Returns: `Field` | BasicForm
| fireEvent( `String eventName`, `Object... args` ) : Boolean Fires the specified event with the passed parameters (minus the event name). Fires the specified event with the passed parameters (minus the event name). Parameters: `eventName` : String `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 | Observable
| getEl() : Ext.Element Get the HTML form Element Get the HTML form Element Parameters: None. Returns: `Ext.Element` | BasicForm
| getValues( [`Boolean asString`] ) : String/Object Returns the fields in this form as an object with key/value pairs as they would be submitted using a standard form su... Returns the fields in this form as an object with key/value pairs as they would be submitted using a standard form submit. If multiple fields exist with the same name they are returned as an array. Note: The values are collected from all enabled HTML input elements within the form, not from the Ext Field objects. This means that all returned values are Strings (or Arrays of Strings) and that the the value can potentionally be the emptyText of a field. Parameters: `asString` : Boolean (optional) Pass true to return the values as a string. (defaults to false, returning an Object) Returns: `String/Object` | BasicForm
| 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 | Observable
| isDirty() : Boolean Returns true if any fields in this form have changed from their original values. Note that if this BasicForm was conf... 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. Parameters: None. Returns: `Boolean` | BasicForm
| isValid() : Boolean Returns true if client-side validation on the form is successful. Returns true if client-side validation on the form is successful. Parameters: None. Returns: `Boolean` | BasicForm
| load( `Object options` ) : BasicForm 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: `BasicForm` this | BasicForm
| loadRecord( `Record record` ) : BasicForm Loads an Ext.data.Record into this form. Loads an Ext.data.Record into this form. Parameters: `record` : Record The record to load Returns: `BasicForm` this | BasicForm
| markInvalid( `Array/Object errors` ) : BasicForm 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'},...] or an object hash of {id: msg, id2: msg2} Returns: `BasicForm` this | BasicForm
| on( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this element (shorthand for addListener) Appends an event handler to this element (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 in which to execute the handler function. The handler function's "this" context. `options` : Object (optional) Returns: `void` | Observable
| purgeListeners() : void Removes all listeners for this object Removes all listeners for this object Parameters: None. Returns: `void` | Observable
| relayEvents( `Object o`, `Array events` ) : 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: `o` : Object The Observable whose events this object is to relay. `events` : Array Array of event names to relay. Returns: `void` | Observable
| remove( `Field field` ) : BasicForm Removes a field from the items collection (does NOT remove its markup). Removes a field from the items collection (does NOT remove its markup). Parameters: `field` : Field Returns: `BasicForm` this | BasicForm
| removeListener( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes a listener Removes a listener Parameters: `eventName` : String The type of event to listen for `handler` : Function The handler to remove `scope` : Object (optional) The scope (this object) for the handler Returns: `void` | Observable
| render() : BasicForm Iterates through the Fields which have been added to this BasicForm, checks them for an id attribute, and calls Ext.f... Iterates through the Fields which have been added to this BasicForm, checks them for an id attribute, and calls Ext.form.Field.applyToMarkup on the existing dom element with that id. Parameters: None. Returns: `BasicForm` this | BasicForm
| reset() : BasicForm Resets this form. Resets this form. Parameters: None. Returns: `BasicForm` this | BasicForm
| resumeEvents() : void Resume firing events. (see suspendEvents) Resume firing events. (see suspendEvents) Parameters: None. Returns: `void` | Observable
- | setValues( `Array/Object values` ) : BasicForm 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: `BasicForm` this | BasicForm
- | submit( `Object options` ) : BasicForm Shortcut to do a submit action. Shortcut to do a submit action. Parameters: `options` : Object The options to pass to the action (see doAction for details). Note: this is ignored when using the standardSubmit option. 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.CLIENT_INVALID:
                      Ext.Msg.alert("Failure", "Form fields may not be submitted with invalid values");
                      break;
                  case Ext.form.Action.CONNECT_FAILURE:
                      Ext.Msg.alert("Failure", "Ajax communication failed");
                      break;
                  case Ext.form.Action.SERVER_INVALID:
                     Ext.Msg.alert("Failure", action.result.msg);
             }
          }
      });
  would process the following server response for a successful submission:
      {
          success: true,
          msg: 'Consignment updated'
      }
  and the following server response for a failed submission:
      {
          success: false,
          msg: 'You do not have permission to perform this operation'
      }
Returns: `BasicForm` this | BasicForm
| suspendEvents() : void Suspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters: None. Returns: `void` | Observable
| un( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes a listener (shorthand for removeListener) Removes a listener (shorthand for removeListener) Parameters: `eventName` : String The type of event to listen for `handler` : Function The handler to remove `scope` : Object (optional) The scope (this object) for the handler Returns: `void` | Observable
| updateRecord( `Record record` ) : BasicForm Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block. Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block. Parameters: `record` : Record The record to edit Returns: `BasicForm` this | BasicForm

## Public Events

Event | Defined By
--- | ---
| actioncomplete : ( `Form this`, `Action action` ) Fires when an action is completed. Fires when an action is completed. Listeners will be called with the following arguments: `this` : Form `action` : Action The Ext.form.Action that completed | BasicForm
| actionfailed : ( `Form this`, `Action action` ) Fires when an action fails. Fires when an action fails. Listeners will be called with the following arguments: `this` : Form `action` : Action The Ext.form.Action that failed | BasicForm
| beforeaction : ( `Form this`, `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. Listeners will be called with the following arguments: `this` : Form `action` : Action The Ext.form.Action to be performed | BasicForm