Class Ext.form.BasicForm

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

Supplies the functionality to do "actions" on forms and initialize Ext.form.Field types on existing markup.

Properties - Methods - Events - Config Options

Public Properties

Property		Defined By
	waitMsgTarget : Mixed	BasicForm
	By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific element by passing it or i...	BasicForm

Public Methods

Method		Defined By
	BasicForm(`String/HTMLElement/Ext.Element el`, `Object config`)	BasicForm
		BasicForm
	add(`Field field1`, [`Field field2`], [`Field etc`]) : BasicForm	BasicForm
	Add Ext.form components to this form	BasicForm
	addEvents(`Object object`) : void	Observable
	Used to define events on this Observable	Observable
	addListener(`String eventName`, `Function handler`, [`Object scope`], [`Object options`]) : void	Observable
	Appends an event handler to this component	Observable
	applyIfToFields(`Object values`) : BasicForm	BasicForm
	Calls Ext.applyIf for all field in this form with the passed object	BasicForm
	applyToFields(`Object values`) : BasicForm	BasicForm
	Calls Ext.apply for all field in this form with the passed object	BasicForm
	clearInvalid() : BasicForm	BasicForm
	Clears all invalid messages in this form	BasicForm
	doAction(`String actionName`, `Object options`) : BasicForm	BasicForm
	Performs a predefined action (submit or load) or custom actions you define on this form	BasicForm
	findField(`String id`) : Field	BasicForm
	Find a Ext.form.Field in this form by id, dataIndex, name or hiddenName	BasicForm
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	Fires the specified event with the passed parameters (minus the event name).	Observable
	getValues(`Boolean asString`) : Object	BasicForm
	Returns the fields in this form as an object with key value pair. If multiple fields exist with the same name they ar...	BasicForm
	hasListener(`String eventName`) : Boolean	Observable
	Checks to see if this object has any listeners for a specified event	Observable
	isDirty() : Boolean	BasicForm
	Returns true if any fields in this form have changed since their original load	BasicForm
	isValid() : Boolean	BasicForm
	Returns true is client-side validation on the form is successful	BasicForm
	load(`Object options`) : BasicForm	BasicForm
	Shortcut to do a load action	BasicForm
	loadRecord(`Record record`) : BasicForm	BasicForm
	Loads an Ext.data.Record into this form	BasicForm
	markInvalid(`Array/Object errors`) : BasicForm	BasicForm
	Mark fields in this form invalid in bulk.	BasicForm
	on(`String eventName`, `Function handler`, [`Object scope`], [`Object options`]) : void	Observable
	Appends an event handler to this element (shorthand for addListener)	Observable
	purgeListeners() : void	Observable
	Removes all listeners for this object	Observable
	remove(`Field field`) : BasicForm	BasicForm
	Removes a field from the items collection (does NOT remove its markup)	BasicForm
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener	Observable
	render() : BasicForm	BasicForm
	Looks at the fields in this form, checks them for an id attribute and call applyTo on the existing dom element with t...	BasicForm
	reset() : BasicForm	BasicForm
	Resets this form	BasicForm
	setValues(`Array/Object values`) : BasicForm	BasicForm
	Set values for fields in this form in bulk.	BasicForm
	submit(`Object options`) : BasicForm	BasicForm
	Shortcut to do a submit action	BasicForm
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener (shorthand for removeListener)	Observable
	updateRecord(`Record record`) : BasicForm	BasicForm
	Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block.	BasicForm

Public Events

Event		Defined By
	actioncomplete : (`Form this`, `Action action`)	BasicForm
	Fires when an action is completed	BasicForm
	actionfailed : (`Form this`, `Action action`)	BasicForm
	Fires when an action fails	BasicForm
	beforeaction : (`Form this`, `Action action`)	BasicForm
	Fires before any action is performed. Return false to cancel the action.	BasicForm

Config Options

Config Options		Defined By
	baseParams : Object	BasicForm
	Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}	BasicForm
	errorReader : DataReader	BasicForm
	An Ext.data.DataReader (e.g. Ext.data.XmlReader to be used to read data when reading validation errors on "submit" ac...	BasicForm
	fileUpload : Boolean	BasicForm
	Set to true if this form is a file upload	BasicForm
	method : String	BasicForm
	The request method to use (GET or POST) for form actions if one isn't supplied in the action options	BasicForm
	reader : DataReader	BasicForm
	An Ext.data.DataReader (e.g. Ext.data.XmlReader to be used to read data when executing "load" actions. This is comple...	BasicForm
	timeout : Number	BasicForm
		BasicForm
	trackResetOnLoad : Boolean	BasicForm
	If set to true, form.reset() resets to the last loaded or setValues() data instead of the when the form was first cre...	BasicForm
	url : String	BasicForm
	The url to use for form actions if one isn't supplied in the action options	BasicForm

Property Details

waitMsgTarget

public Mixed waitMsgTarget

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.

This property is defined by BasicForm.

Constructor Details

BasicForm

public function BasicForm(String/HTMLElement/Ext.Element el, Object config)

Parameters:

el : String/HTMLElement/Ext.Element
The form element or its id
config : Object
Configuration options

Method Details

add

public function add(Field field1, [Field field2], [Field etc])

Add Ext.form components to this form

Parameters:

field1 : Field
field2 : Field
(optional)
etc : Field
(optional)

Returns:

BasicForm
this

This method is defined by BasicForm.

addEvents

public function addEvents(Object object)

Used to define events on this Observable

Parameters:

object : Object
The object with the events defined

Returns:

void

This method is defined by Observable.

addListener

public function addListener(String eventName, Function handler, [Object scope], [Object options])

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 in which to execute the handler function. The handler function's "this" context.
options : Object
(optional) An object containing handler configuration properties. This may contain any of the following properties:
- scope {Object} The scope in which to execute the handler function. The handler function's "this" context.
- delay {Number} The number of milliseconds to delay the invocation of the handler after te 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.
Combining Options
Using the options argument, it is possible to combine different types of listeners:

A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
Code:
```
 el.on('click', this.onClick, this, { single: true, delay: 100, forumId: 4 });
```
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.
Code:
```
 foo.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:
Code:
```
 foo.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });
```

Returns:

void

This method is defined by Observable.

applyIfToFields

public function applyIfToFields(Object values)

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

Parameters:

values : Object

Returns:

BasicForm
this

This method is defined by BasicForm.

applyToFields

public function applyToFields(Object values)

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

Parameters:

values : Object

Returns:

BasicForm
this

This method is defined by BasicForm.

clearInvalid

public function clearInvalid()

Clears all invalid messages in this form

Parameters:

None.

Returns:

BasicForm
this

This method is defined by BasicForm.

doAction

public function doAction(String actionName, Object options)

Performs a predefined action (submit or load) or custom actions you define on this form

Parameters:

actionName : String
The name of the action type
options : Object
The options to pass to the action

Returns:

BasicForm
this

This method is defined by BasicForm.

findField

public function findField(String id)

Find a Ext.form.Field in this form by id, dataIndex, name or hiddenName

Parameters:

id : String
The value to search for

Returns:

Field

This method is defined by BasicForm.

fireEvent

public function fireEvent(String eventName, Object... args)

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

This method is defined by Observable.

getValues

public function getValues(Boolean asString)

Returns the fields in this form as an object with key value pair. If multiple fields exist with the same name they are returned as an array.

Parameters:

asString : Boolean

Returns:

Object

This method is defined by BasicForm.

hasListener

public function hasListener(String eventName)

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

This method is defined by Observable.

isDirty

public function isDirty()

Returns true if any fields in this form have changed since their original load

Parameters:

None.

Returns:

Boolean

This method is defined by BasicForm.

isValid

public function isValid()

Returns true is client-side validation on the form is successful

Parameters:

None.

Returns:

Boolean

This method is defined by BasicForm.

load

public function load(Object options)

Shortcut to do a load action

Parameters:

options : Object
The options to pass to the action

Returns:

BasicForm
this

This method is defined by BasicForm.

loadRecord

public function loadRecord(Record record)

Loads an Ext.data.Record into this form

Parameters:

record : Record
The record to load

Returns:

BasicForm
this

This method is defined by BasicForm.

markInvalid

public function markInvalid(Array/Object errors)

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

This method is defined by BasicForm.

on

public function on(String eventName, Function handler, [Object scope], [Object options])

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

This method is defined by Observable.

purgeListeners

public function purgeListeners()

Removes all listeners for this object

Parameters:

None.

Returns:

void

This method is defined by Observable.

remove

public function remove(Field field)

Removes a field from the items collection (does NOT remove its markup)

Parameters:

field : Field

Returns:

BasicForm
this

This method is defined by BasicForm.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])

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

This method is defined by Observable.

render

public function render()

Looks at the fields in this form, checks them for an id attribute and call applyTo on the existing dom element with that id

Parameters:

None.

Returns:

BasicForm
this

This method is defined by BasicForm.

reset

public function reset()

Resets this form

Parameters:

None.

Returns:

BasicForm
this

This method is defined by BasicForm.

setValues

public function setValues(Array/Object values)

Set values for fields in this form in bulk.

Parameters:

values : Array/Object
Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}

Returns:

BasicForm
this

This method is defined by BasicForm.

submit

public function submit(Object options)

Shortcut to do a submit action

Parameters:

options : Object
The options to pass to the action

Returns:

BasicForm
this

This method is defined by BasicForm.

un

public function un(String eventName, Function handler, [Object scope])

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

This method is defined by Observable.

updateRecord

public function updateRecord(Record record)

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

This method is defined by BasicForm.

Event Details

actioncomplete

public event actioncomplete

Fires when an action is completed

Subscribers will be called with the following parameters:

this : Form
action : Action
The action that completed

This event is defined by BasicForm.

actionfailed

public event actionfailed

Fires when an action fails

Subscribers will be called with the following parameters:

this : Form
action : Action
The action that failed

This event is defined by BasicForm.

beforeaction

public event beforeaction

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

Subscribers will be called with the following parameters:

this : Form
action : Action
The action to be performed

This event is defined by BasicForm.

Config Details

baseParams

baseParams : Object

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

This config option is defined by BasicForm.

errorReader

errorReader : DataReader

An Ext.data.DataReader (e.g. Ext.data.XmlReader to be used to read data when reading validation errors on "submit" actions. This is completely optional as there is built-in support for processing JSON.

This config option is defined by BasicForm.

fileUpload

fileUpload : Boolean

Set to true if this form is a file upload

This config option is defined by BasicForm.

method

method : String

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

This config option is defined by BasicForm.

reader

reader : DataReader

An Ext.data.DataReader (e.g. Ext.data.XmlReader to be used to read data when executing "load" actions. This is completely optional as there is built-in support for processing JSON.

This config option is defined by BasicForm.

timeout

timeout : Number

This config option is defined by BasicForm.

trackResetOnLoad

trackResetOnLoad : Boolean

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

This config option is defined by BasicForm.

url

url : String

The url to use for form actions if one isn't supplied in the action options

This config option is defined by BasicForm.