Ext.form.BasicForm
Hierarchy
Ext.util.ObservableExt.form.BasicFormFiles
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 "<", "&" as "&" 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: 1.1.0
Config options
(Optional) If specified load and submit actions will be handled with Ext.form.Action.DirectLoad and Ext.form.Action.DirectSubmit. Methods which have been imported by Ext.Direct 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
Available since: Ext JS 3.4.0
Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
Parameters are encoded as standard HTTP parameters using Ext.urlEncode.
Available since: 1.1.0
An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read field error messages returned from 'submit' actions. This is 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
}
Available since: 1.1.0
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 "<", "&" as "&" 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: 1.1.0
(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 Component's HTMLElement, listeners must be added to the Element after the Component
has been rendered. A plugin can simplify this step:
// Plugin is configured with a listeners config object.
// The Component is appended to the argument list of all handler functions.
Ext.DomObserver = Ext.extend(Object, {
constructor: function(config) {
this.listeners = config.listeners ? config.listeners : config;
},
// Component passes itself into plugin's init method
init: function(c) {
var p, l = this.listeners;
for (p in l) {
if (Ext.isFunction(l[p])) {
l[p] = this.createHandler(l[p], c);
} else {
l[p].fn = this.createHandler(l[p].fn, c);
}
}
// Add the listeners to the Element immediately following the render call
c.render = c.render.createSequence(function() {
var e = c.getEl();
if (e) {
e.on(l);
}
});
},
createHandler: function(fn, c) {
return function(e) {
fn.call(this, e, c);
};
}
});
var combo = new Ext.form.ComboBox({
// Collapse combo when its element is clicked on
plugins: [ new Ext.DomObserver({
click: function(evt, comp) {
comp.collapse();
}
})],
store: myStore,
typeAhead: true,
mode: 'local',
triggerAction: 'all'
});
Available since: 1.1.0
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.
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: Ext JS 3.4.0
Only used for the api
load configuration. Send parameters as a collection of named
arguments (defaults to false). Providing a
paramOrder nullifies this configuration.
Defaults to: false
Available since: Ext JS 3.4.0
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. For additional information on using an XMLReader see the example provided in examples/form/xml-form.html.
Available since: 1.1.0
If set to true, standard HTML form submits are used instead of XHR (Ajax) style form submissions. Defaults to false.
Note: When using standardSubmit, the
options to submit are ignored because
Ext's Ajax infrastracture is bypassed. To pass extra parameters (e.g.
baseParams and params), utilize hidden fields
to submit extra data, for example:
new Ext.FormPanel({
standardSubmit: true,
baseParams: {
foo: 'bar'
},
url: 'myProcess.php',
items: [{
xtype: 'textfield',
name: 'userName'
}],
buttons: [{
text: 'Save',
handler: function(){
var fp = this.ownerCt.ownerCt,
form = fp.getForm();
if (form.isValid()) {
// check if there are baseParams and if
// hiddent items have been added already
if (fp.baseParams && !fp.paramsAdded) {
// add hidden items for all baseParams
for (i in fp.baseParams) {
fp.add({
xtype: 'hidden',
name: i,
value: fp.baseParams[i]
});
}
fp.doLayout();
// set a custom flag to prevent re-adding
fp.paramsAdded = true;
}
form.submit();
}
}
}]
});
Available since: 2.3.0
Timeout for form actions in seconds (default is 30 seconds).
Defaults to: 30
Available since: 1.1.0
Properties
A MixedCollection containing all the Ext.form.Fields in this form.
A MixedCollection containing all the Ext.form.Fields in this form.
Available since: Ext JS 3.4.0
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: 1.1.0
Methods
Available since: 1.1.0
Parameters
- el : Mixed
The form element or its id
- config : Object
Configuration options
Returns
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.
Available since: 1.1.0
Parameters
- field1 : Field
- field2 : Field (optional)
- etc : Field (optional)
Returns
- BasicForm
this
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
trueor the first event name string if multiple event names are being passed as separate parameters. - Optional : string
. Event name if multiple event names are being passed as separate parameters. Usage:
this.addEvents('storeloaded', 'storecleared');
Appends an event handler to this object.
Available since: 1.1.0
Parameters
- eventName : String
The name of the event to listen for.
- handler : Function
The method the event invokes.
- scope : Object (optional)
The scope (
thisreference) 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 : ObjectThe scope (
thisreference) in which the handler function is executed. If omitted, defaults to the object which fired the event. - delay : NumberThe number of milliseconds to delay the invocation of the handler after the event fires.
- single : BooleanTrue to add a handler to handle just the next firing of the event, and then remove itself.
- buffer : NumberCauses 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 : ObservableOnly 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 }); - scope : Object
private
Available since: Ext JS 3.4.0
Parameters
- action : Object
- success : Object
Calls Ext.applyIf for all field in this form with the passed object.
Available since: 1.1.0
Parameters
- values : Object
Returns
- BasicForm
this
Calls Ext.apply for all fields in this form with the passed object.
Available since: 1.1.0
Parameters
- values : Object
Returns
- BasicForm
this
private
Available since: Ext JS 3.4.0
Parameters
- action : Object
Removes all fields from the collection that have been destroyed.
Available since: Ext JS 3.4.0
Clears all invalid messages in this form.
Available since: 1.1.0
Returns
- BasicForm
this
Destroys this object.
Available since: Ext JS 3.4.0
Parameters
- bound : Boolean
true if the object is bound to a form panel. If this is the case the FormPanel will take care of destroying certain things, so we're just doubling up.
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.
Available since: 1.1.0
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 (see top of submit and load for a description of what constitutes a successful response). The function is passed the following parameters:- form : Ext.form.BasicFormThe form 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:- form : The Ext.form.BasicForm 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. - url : String
Returns
- BasicForm
this
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, {
// Add functionality to Field's initComponent to enable the change event to bubble
initComponent : Ext.form.Field.prototype.initComponent.createSequence(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: Ext JS 3.4.0
Parameters
Find a Ext.form.Field in this form.
Available since: 1.1.0
Parameters
- id : String
The value to search for (specify either a id, dataIndex, name or hiddenName).
Returns
- Object
Field
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.
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.
Retrieves the fields in the form as a set of key/value pairs, using the getValue() method. If multiple fields exist with the same name they are returned as an array.
Available since: Ext JS 3.4.0
Parameters
- dirtyOnly : Boolean (optional)
True to return only fields that are dirty.
Returns
- Object
The values in the form
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 value can potentially be the emptyText of a field.
Available since: 1.1.0
Parameters
- asString : Boolean (optional)
Pass true to return the values as a string. (defaults to false, returning an Object)
Returns
- String/Object
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
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
- Object
Boolean
Returns true if client-side validation on the form is successful.
Available since: 1.1.0
Returns
- Object
Boolean
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
- BasicForm
this
Loads an Ext.data.Record into this form by calling setValues with the record data. See also trackResetOnLoad.
Available since: 1.1.0
Parameters
- record : Record
The record to load
Returns
- BasicForm
this
Mark fields in this form invalid in bulk.
Available since: 1.1.0
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
Appends an event handler to this object (shorthand for addListener.)
Available since: 1.1.0
Parameters
- eventName : String
The type of event to listen for
- handler : Function
The method the event invokes
- scope : Object (optional)
The scope (
thisreference) 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.
Removes all listeners for this object
Available since: 1.1.0
Relays selected events from the specified Observable as if the events were fired by this.
Available since: 2.3.0
Parameters
- o : Object
The Observable whose events this object is to relay.
- events : Array
Array of event names to relay.
Removes a field from the items collection (does NOT remove its markup).
Available since: 1.1.0
Parameters
- field : Field
Returns
- BasicForm
this
Removes an event handler.
Available since: 1.1.0
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.
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.
Available since: 1.1.0
Returns
- BasicForm
this
Resets this form.
Available since: 1.1.0
Returns
- BasicForm
this
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.
Available since: 2.3.0
Set values for fields in this form in bulk.
Available since: 1.1.0
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
Shortcut to do a submit action.
Available since: 1.1.0
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, // 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
- BasicForm
this
Suspend 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;
Removes an event handler (shorthand for removeListener.)
Available since: 1.1.0
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.
Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block.
Available since: 1.1.0
Parameters
- record : Record
The record to edit
Returns
- BasicForm
this
Events
Fires when an action is completed.
Available since: 1.1.0
Parameters
- this : Form
- action : Action
The Ext.form.Action that completed
Fires when an action fails.
Available since: 1.1.0
Parameters
- this : Form
- action : Action
The Ext.form.Action that failed
Fires before any action is performed. Return false to cancel the action.
Available since: 1.1.0
Parameters
- this : Form
- action : Action
The Ext.form.Action to be performed