Class Ext.form.Form

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

Adds the ability to dynamically render forms with JS to Ext.form.BasicForm.

属性 - 方法 - 事件 - 设置选项

公共属性

属性		定义对象
	buttons : Array	Form
	Array of all the buttons that have been added to this form via addButton	Form
	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

公共方法

方法		定义对象
	Form(`Object config`)	Form
		Form
	add(`Field field1`, [`Field field2`], [`Field etc`]) : Form	Form
	Add Ext.form components to the current open container (e.g. column, fieldset, etc)	Form
	addButton(`String/Object config`, `Function handler`, [`Object scope`]) : Ext.Button	Form
	Adds a button to the footer of the form - this must be called before the form is rendered.	Form
	addEvents(`Object object`) : void	Observable
	将对象中没有的事件从给出的对象中复制过来。	Observable
	addListener(`String eventName`, `Function handler`, [`Object scope`], [`Object options`]) : void	Observable
	为该组件加入事件处理器函数	Observable
	applyIfToFields(`Object values`) : void	BasicForm
	Calls Ext.applyIf for all field in this form with the passed object	BasicForm
	applyToFields(`Object values`) : void	BasicForm
	Calls Ext.apply for all field in this form with the passed object	BasicForm
	clearInvalid() : void	BasicForm
	Clears all invalid messages in this form	BasicForm
	column(`Object config`, [`Field field1`], [`Field field2`], [`Field etc`]) : Column	Form
	Opens the a new Ext.form.Column container in the layout stack. If fields are passed after the config, the fields are ...	Form
	container(`Object config`, [`Field field1`], [`Field field2`], [`Field etc`]) : Layout	Form
	Opens the a new Ext.form.Layout container in the layout stack. If fields are passed after the config, the fields are ...	Form
	doAction(`String actionName`, `Object options`) : void	BasicForm
	Performs a predefined action (submit or load) or custom actions you define on this form	BasicForm
	end() : Form	Form
	Closes the current open container	Form
	fieldset(`Object config`, [`Field field1`], [`Field field2`], [`Field etc`]) : FieldSet	Form
	Opens the a new Ext.form.FieldSet container in the layout stack. If fields are passed after the config, the fields ar...	Form
	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
	触发指定的事件, 并将参数传入（至少要有事件名称）。	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
	检查该对象是否拥有指定事件的侦听器	Observable
	isValid() : Boolean	BasicForm
	Returns true is client-side validation on the form is successful	BasicForm
	load(`Object options`) : void	BasicForm
	Shortcut to do a load action	BasicForm
	markInvalid(`Array/Object errors`) : void	BasicForm
	Mark fields in this form invalid in bulk.	BasicForm
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	为该组件加入事件处理器函数, addListener 的简写方式	Observable
	purgeListeners() : void	Observable
	从对象身上移除所有的侦听器	Observable
	remove(`Field field`) : void	BasicForm
	Removes a field from the items collection (does NOT remove its markup)	BasicForm
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器	Observable
	render(`String/HTMLElement/Element container`) : Form	Form
	Render this form into the passed container. This should only be called once!	Form
	reset() : void	BasicForm
	Resets this form	BasicForm
	setValues(`Array/Object values`) : void	BasicForm
	Set values for fields in this form in bulk.	BasicForm
	start(`Object container`) : Form	Form
	Opens the passed container in the layout stack. The container can be any Ext.form.Layout or subclass.	Form
	startMonitoring() : void	Form
	Starts monitoring of the valid state of this form. Usually this is don't by passing the config option "monitorValid"	Form
	stopMonitoring() : void	Form
	Stops monitoring of the valid state of this form	Form
	submit(`Object options`) : void	BasicForm
	Shortcut to do a submit action	BasicForm
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器, removeListener 的简写方式	Observable
	updateRecord(`Record record`) : void	BasicForm
	Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block.	BasicForm

公共事件

事件		定义对象
	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
	clientvalidation : (`Form this`, `Boolean valid`)	Form
	If the monitorValid config option is true, this event fires repetitively to notify of valid state	Form

设置选项

设置选项		定义对象
	baseParams : Object	BasicForm
	Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}	BasicForm
	buttonAlign : String	Form
	Valid values are "left," "center" and "right" (defaults to "center")	Form
	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 (YUI adapter only)	BasicForm
	itemCls : String	Form
	A css class to apply to the x-form-item of fields. This property cascades to child containers.	Form
	labelAlign : String	Form
	Valid values are "left," "top" and "right" (defaults to "left"). This property cascades to child containers if not set.	Form
	labelWidth : Number	Form
	The width of labels. This property cascades to child containers.	Form
	method : String	BasicForm
	The request method to use (GET or POST) for form actions if one isn't supplied in the action options	BasicForm
	minButtonWidth : Number	Form
	Minimum width of all buttons (defaults to 75)	Form
	monitorPoll : Number	Form
	The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)	Form
	monitorValid : Boolean	Form
	If true the form monitors it's valid state client-side and fires a looping event with that state. This is required to...	Form
	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
	url : String	BasicForm
	The url to use for form actions if one isn't supplied in the action options	BasicForm

属性详情

buttons

public Array buttons

Array of all the buttons that have been added to this form via addButton

This property is defined by Form.

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.

构造函数

Form

public function Form(Object config)

参数：

config : Object
Configuration options

方法详情

add

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

Add Ext.form components to the current open container (e.g. column, fieldset, etc)

参数：

field1 : Field
field2 : Field
（可选）
etc : Field
（可选）

返回：

Form
this

This method is defined by Form.

addButton

public function addButton(String/Object config, Function handler, [Object scope])

Adds a button to the footer of the form - this must be called before the form is rendered.

参数：

config : String/Object
A string becomes the button text, an object can either be a Button config object or a valid Ext.DomHelper element config
handler : Function
The function called when the button is clicked
scope : Object
（可选） The scope of the handler function

返回：

Ext.Button

This method is defined by Form.

addEvents

public function addEvents(Object object)

将对象中没有的事件从给出的对象中复制过来。给出的对象必须也继承于 Observable 对象此方法才会有效果。

参数：

object : Object
要复制事件的源对象

返回：

void

This method is defined by Observable.

addListener

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

为组件添加一个事件监听器

参数：

eventName : String
侦听事件的类型
handler : Function
事件调用的方法
scope : Object
（可选）处理函数执行的作用域。处理函数 "this" 的内容。
options : Object
（可选）一个包含处理设置属性的对象。可以包含下列的属性：
- scope {Object} 处理函数执行的作用域。处理函数 "this" 的内容。
- delegate {String} 一个简单的选择器用来过滤目标或查找目标的子节点。
- stopEvent {Boolean} 值为 True 时用来中止事件。那样将中止传播，并防止缺省动作。
- preventDefault {Boolean} 值为 True 时用来防止缺省动作。
- stopPropagation {Boolean} 值为 True 时用来中止事件传播。
- normalized {Boolean} 值为 False 时向处理函数传递浏览器事件用以代替 Ext.EventObject 对象。
- delay {Number} 当事件触发后启用处理函数的延迟微秒数。
- single {Boolean} 值为 True 时将添加一个处理函数用来处理下个触发的事件，并在处理完后移除。
- buffer {Number} 使处理函数计划在由 Ext.util.DelayedTask 指定的微秒数后执行。如果事件在延迟期间再次触发，原来的处理函数将不再启动，而是由新的计划代替。
组合选项
使用选项参数可以组合不同类型的监听器：

下面是一个标准的、延迟执行的、一次性的监听器，将会自动停止事件并传递一个自定义的参数(forumId)
代码：
```
el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 });
```
这个方法也允许传递的单个参数是一个包含多个指定处理函数的设置对象。

一次调用多个处理函数
代码：
```
el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });
```
或者简写为：
代码：
```
el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });
```

返回：

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

参数：

values : Object

返回：

void

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

参数：

values : Object

返回：

void

This method is defined by BasicForm.

clearInvalid

public function clearInvalid()

Clears all invalid messages in this form

参数：

无。

返回：

void

This method is defined by BasicForm.

column

public function column(Object config, [Field field1], [Field field2], [Field etc])

Opens the a new Ext.form.Column container in the layout stack. If fields are passed after the config, the fields are added and the column is closed. If no fields are passed the column remains open until end() is called.

参数：

config : Object
The config to pass to the column
field1 : Field
（可选）
field2 : Field
（可选）
etc : Field
（可选）

返回：

Column
The column container object

This method is defined by Form.

container

public function container(Object config, [Field field1], [Field field2], [Field etc])

Opens the a new Ext.form.Layout container in the layout stack. If fields are passed after the config, the fields are added and the container is closed. If no fields are passed the container remains open until end() is called.

参数：

config : Object
The config to pass to the Layout
field1 : Field
（可选）
field2 : Field
（可选）
etc : Field
（可选）

返回：

Layout
The container object

This method is defined by Form.

doAction

public function doAction(String actionName, Object options)

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

参数：

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

返回：

void

This method is defined by BasicForm.

end

public function end()

Closes the current open container

参数：

无。

返回：

Form
this

This method is defined by Form.

fieldset

public function fieldset(Object config, [Field field1], [Field field2], [Field etc])

Opens the a new Ext.form.FieldSet container in the layout stack. If fields are passed after the config, the fields are added and the fieldset is closed. If no fields are passed the fieldset remains open until end() is called.

参数：

config : Object
The config to pass to the fieldset
field1 : Field
（可选）
field2 : Field
（可选）
etc : Field
（可选）

返回：

FieldSet
The fieldset container object

This method is defined by Form.

findField

public function findField(String id)

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

参数：

id : String
The value to search for

返回：

Field

This method is defined by BasicForm.

fireEvent

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

触发指定的事件并给出参数（至少要有事件名称）。

参数：

eventName : String
args : Object...
传入处理函数的参数

返回：

Boolean
如果任何处理函数返回 false 则返回值为 false, 否则返回 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.

参数：

asString : Boolean

返回：

Object

This method is defined by BasicForm.

hasListener

public function hasListener(String eventName)

检查该对象是否拥有指定事件的侦听器

参数：

eventName : String
查询事件之名称

返回：

Boolean
值为 True 值表示事件监听器存在, 否则值为 false。

This method is defined by Observable.

isValid

public function isValid()

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

参数：

无。

返回：

Boolean

This method is defined by BasicForm.

load

public function load(Object options)

Shortcut to do a load action

参数：

options : Object
The options to pass to the action

返回：

void

This method is defined by BasicForm.

markInvalid

public function markInvalid(Array/Object errors)

Mark fields in this form invalid in bulk.

参数：

errors : Array/Object
Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}

返回：

void

This method is defined by BasicForm.

on

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

为该组件加入事件处理器函数, addListener 的简写方式

参数：

eventName : String
侦听事件的类型
handler : Function
事件调用的方法
options : Object
（可选）

返回：

void

This method is defined by Observable.

purgeListeners

public function purgeListeners()

从对象身上移除所有的侦听器

参数：

无。

返回：

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)

参数：

field : Field

返回：

void

This method is defined by BasicForm.

removeListener

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

移除侦听器

参数：

eventName : String
侦听事件的类型
handler : Function
删除的处理函数
scope : Object
（可选） The scope (this object) for the handler

返回：

void

This method is defined by Observable.

render

public function render(String/HTMLElement/Element container)

Render this form into the passed container. This should only be called once!

参数：

container : String/HTMLElement/Element
The element this component should be rendered into

返回：

Form
this

This method is defined by Form.

reset

public function reset()

Resets this form

参数：

无。

返回：

void

This method is defined by BasicForm.

setValues

public function setValues(Array/Object values)

Set values for fields in this form in bulk.

参数：

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

返回：

void

This method is defined by BasicForm.

start

public function start(Object container)

Opens the passed container in the layout stack. The container can be any Ext.form.Layout or subclass.

参数：

container : Object
A Ext.form.Layout or subclass of Layout

返回：

Form
this

This method is defined by Form.

startMonitoring

public function startMonitoring()

Starts monitoring of the valid state of this form. Usually this is don't by passing the config option "monitorValid"

参数：

无。

返回：

void

This method is defined by Form.

stopMonitoring

public function stopMonitoring()

Stops monitoring of the valid state of this form

参数：

无。

返回：

void

This method is defined by Form.

submit

public function submit(Object options)

Shortcut to do a submit action

参数：

options : Object
The options to pass to the action

返回：

void

This method is defined by BasicForm.

un

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

移除侦听器, removeListener 的简写方式

参数：

eventName : String
侦听事件的类型
handler : Function
删除的处理函数
scope : Object
（可选） The scope (this object) for the handler

返回：

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.

参数：

record : Record
The record to edit

返回：

void

This method is defined by BasicForm.

事件详情

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.

clientvalidation

public event clientvalidation

If the monitorValid config option is true, this event fires repetitively to notify of valid state

Subscribers will be called with the following parameters:

this : Form
valid : Boolean
true if the form has passed client-side validation

This event is defined by Form.

设置详情

baseParams

baseParams : Object

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

This config option is defined by BasicForm.

buttonAlign

buttonAlign : String

Valid values are "left," "center" and "right" (defaults to "center")

This config option is defined by Form.

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 (YUI adapter only)

This config option is defined by BasicForm.

itemCls

itemCls : String

A css class to apply to the x-form-item of fields. This property cascades to child containers.

This config option is defined by Form.

labelAlign

labelAlign : String

Valid values are "left," "top" and "right" (defaults to "left"). This property cascades to child containers if not set.

This config option is defined by Form.

labelWidth

labelWidth : Number

The width of labels. This property cascades to child containers.

This config option is defined by Form.

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.

minButtonWidth

minButtonWidth : Number

Minimum width of all buttons (defaults to 75)

This config option is defined by Form.

monitorPoll

monitorPoll : Number

The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)

This config option is defined by Form.

monitorValid

monitorValid : Boolean

If true the form monitors it's valid state client-side and fires a looping event with that state. This is required to bind buttons to the valid state using the config value bindForm:true on the button.

This config option is defined by Form.

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.

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.