Class Ext.form.Checkbox

Package:	Ext.form
Class:	Checkbox
Extends:	Field
Subclasses:	Radio
Defined In:	Checkbox.js

Single checkbox field. Can be used as a direct replacement for traditional checkbox fields.

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

公共属性

属性		定义对象
	disabled : Object	Component
	true if this component is disabled. Read-only.	Component
	disabledClass : Object	Component
	CSS class added to the component when it is disabled.	Component
	hidden : Object	Component
	true if this component is hidden. Read-only.	Component
	rendered : Object	Component
	true if this component has been rendered. Read-only.	Component

公共方法

方法		定义对象
	Checkbox(`Object config`)	Checkbox
	Creates a new CheckBox	Checkbox
	addEvents(`Object object`) : void	Observable
	将对象中没有的事件从给出的对象中复制过来。	Observable
	addListener(`String eventName`, `Function handler`, [`Object scope`], [`Object options`]) : void	Observable
	为该组件加入事件处理器函数	Observable
	applyTo(`String/HTMLElement/Element el`) : Ext.form.Field	Field
	Apply the behaviors of this component to an existing element. This is used instead of render().	Field
	clearInvalid() : void	Field
	Clear any invalid styles/messages for this field	Field
	disable() : void	Component
	Disable this component	Component
	enable() : void	Component
	Enable this component	Component
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	触发指定的事件, 并将参数传入（至少要有事件名称）。	Observable
	focus(`Boolean selectText`) : void	Component
	Try to focus this component	Component
	getEl() : Ext.Element	Component
	Returns the underlying Ext.Element	Component
	getId() : String	Component
	Returns the id of this component	Component
	getName() : String	Field
	Returns the name attribute of the field if available	Field
	getRawValue() : Mixed	Field
	Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue.	Field
	getValue() : Boolean	Checkbox
	Returns the checked state of the checkbox.	Checkbox
	hasListener(`String eventName`) : Boolean	Observable
	检查该对象是否拥有指定事件的侦听器	Observable
	hide() : void	Component
	Hide this component	Component
	isValid(`Boolean preventMark`) : Boolean	Field
	Returns whether or not the field value is currently valid	Field
	isVisible() : void	Component
	Returns true if this component is visible	Component
	markInvalid(`String msg`) : void	Field
	Mark this field as invalid	Field
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	为该组件加入事件处理器函数, addListener 的简写方式	Observable
	purgeListeners() : void	Observable
	从对象身上移除所有的侦听器	Observable
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器	Observable
	render([`String/HTMLElement/Element container`]) : void	Component
	If this is a lazy rendering component, render it to its container element	Component
	reset() : void	Field
	Resets the current field value to the originally-loaded value and clears any validation messages	Field
	setDisabled(`Boolean disabled`) : void	Component
	Convenience function for setting disabled/enabled by boolean	Component
	setRawValue(`Mixed value`) : void	Field
	Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.	Field
	setSize(`Number width`, `Number height`) : void	Checkbox
	* Sets the width and height of the checkbox wrapper element	Checkbox
	setValue(`Boolean/String checked`) : void	Checkbox
	Sets the checked state of the checkbox	Checkbox
	setVisible(`Boolean visible`) : void	Component
	Convenience function to hide or show this component by boolean	Component
	show() : void	Component
	Show this component	Component
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器, removeListener 的简写方式	Observable
	validate() : Boolean	Field
	Validates the field value	Field

公共事件

事件		定义对象
	beforedestroy : (`Ext.Component this`)	Component
	Fires before the component is destroyed	Component
	beforehide : (`Ext.Component this`)	Component
	Fires before the component is hidden	Component
	beforerender : (`Ext.Component this`)	Component
	Fires before the component is rendered	Component
	beforeshow : (`Ext.Component this`)	Component
	Fires before the component is shown	Component
	blur : (`Ext.form.Field this`)	Field
	Fires when	Field
	change : (`Ext.form.Field this`, `Mixed value`, `Mixed value`)	Field
	Fires just before the field blurs if the field value has changed	Field
	check : (`Ext.form.Checkbox this`, `Boolean checked`)	Checkbox
	Fires when the checkbox is checked or unchecked	Checkbox
	destroy : (`Ext.Component this`)	Component
	Fires after the component is destroyed	Component
	disable : (`Ext.Component this`)	Component
	Fires after the component is disabled	Component
	enable : (`Ext.Component this`)	Component
	Fires after the component is enabled	Component
	focus : (`Ext.form.Field this`)	Field
	Fires when this field receives input focus	Field
	hide : (`Ext.Component this`)	Component
	Fires after the component is hidden	Component
	invalid : (`Ext.form.Field this`, `String msg`)	Field
	Fires after the field has been marked as invalid	Field
	render : (`Ext.Component this`)	Component
	Fires after the component is rendered	Component
	show : (`Ext.Component this`)	Component
	Fires after the component is shown	Component
	specialkey : (`Ext.form.Field this`, `Ext.EventObject e`)	Field
	Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check Ext.EventObject.g...	Field
	valid : (`Ext.form.Field this`)	Field
	Fires after the field has been validated with no errors	Field

设置选项

设置选项		定义对象
	autoCreate : String/Object	Field
	A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", au...	Field
	boxLabel : String	Checkbox
	The text that appears beside the checkbox	Checkbox
	checked : Boolean	Checkbox
	True if the the checkbox should render already checked (defaults to false)	Checkbox
	fieldClass : String	Checkbox
	The default CSS class for the checkbox (defaults to "x-form-field")	Checkbox
	focusClass : String	Checkbox
	The CSS class to use when the checkbox receives focus (defaults to 'x-form-check-focus')	Checkbox
	inputType : String	Field
	The type attribute for input fields - e.g. radio, text, password. (defaults to "text")	Field
	inputValue : String	Checkbox
	The value that should go into the generated input element's value attribute	Checkbox
	invalidClass : String	Field
	The CSS class to use when marking a field invalid (defaults to "x-form-invalid")	Field
	invalidText : String	Field
	The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field i...	Field
	msgFx : String	Field
	Experimental The effect used when displaying a validation message under the field (defaults to 'normal').	Field
	msgTarget : String	Field
	The location where error text should display. Should be one of the following values (defaults to 'qtip'): Value Desc...	Field
	validateOnBlur : String/Boolean	Field
	Defaults to true.	Field
	validationDelay : Number	Field
	The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)	Field
	validationEvent : String/Boolean	Field
	The event that should initiate field validation. Set to false to disable automatic validation. (defaults to "keyup")	Field
	value : Mixed	Field
	A value to initialize this field with	Field

属性详情

disabled

public Object disabled

true if this component is disabled. Read-only.

This property is defined by Component.

disabledClass

public Object disabledClass

CSS class added to the component when it is disabled.

This property is defined by Component.

hidden

public Object hidden

true if this component is hidden. Read-only.

This property is defined by Component.

rendered

public Object rendered

true if this component has been rendered. Read-only.

This property is defined by Component.

构造函数

Checkbox

public function Checkbox(Object config)

Creates a new CheckBox

参数：

config : Object
Configuration options

方法详情

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.

applyTo

public function applyTo(String/HTMLElement/Element el)

Apply the behaviors of this component to an existing element. This is used instead of render().

参数：

el : String/HTMLElement/Element
The id of the node, a DOM Node or an existing Element

返回：

Ext.form.Field
this

This method is defined by Field.

clearInvalid

public function clearInvalid()

Clear any invalid styles/messages for this field

参数：

无。

返回：

void

This method is defined by Field.

disable

public function disable()

Disable this component

参数：

无。

返回：

void

This method is defined by Component.

enable

public function enable()

Enable this component

参数：

无。

返回：

void

This method is defined by Component.

fireEvent

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

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

参数：

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

返回：

Boolean
如果任何处理函数返回 false 则返回值为 false, 否则返回 true。

This method is defined by Observable.

focus

public function focus(Boolean selectText)

Try to focus this component

参数：

selectText : Boolean
True to also select the text in this component (if applicable)

返回：

void

This method is defined by Component.

getEl

public function getEl()

Returns the underlying Ext.Element

参数：

无。

返回：

Ext.Element
The element

This method is defined by Component.

getId

public function getId()

Returns the id of this component

参数：

无。

返回：

String

This method is defined by Component.

getName

public function getName()

Returns the name attribute of the field if available

参数：

无。

返回：

String
name The field name

This method is defined by Field.

getRawValue

public function getRawValue()

Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue.

参数：

无。

返回：

Mixed
value The field value

This method is defined by Field.

getValue

public function getValue()

Returns the checked state of the checkbox.

参数：

无。

返回：

Boolean
True if checked, else false

This method is defined by Checkbox.

hasListener

public function hasListener(String eventName)

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

参数：

eventName : String
查询事件之名称

返回：

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

This method is defined by Observable.

hide

public function hide()

Hide this component

参数：

无。

返回：

void

This method is defined by Component.

isValid

public function isValid(Boolean preventMark)

Returns whether or not the field value is currently valid

参数：

preventMark : Boolean
True to disable marking the field invalid

返回：

Boolean
True if the value is valid, else false

This method is defined by Field.

isVisible

public function isVisible()

Returns true if this component is visible

参数：

无。

返回：

void

This method is defined by Component.

markInvalid

public function markInvalid(String msg)

Mark this field as invalid

参数：

msg : String
The validation message

返回：

void

This method is defined by Field.

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.

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

If this is a lazy rendering component, render it to its container element

参数：

container : String/HTMLElement/Element
（可选） The element this component should be rendered into. If it is being applied to existing markup, this should be left off.

返回：

void

This method is defined by Component.

reset

public function reset()

Resets the current field value to the originally-loaded value and clears any validation messages

参数：

无。

返回：

void

This method is defined by Field.

setDisabled

public function setDisabled(Boolean disabled)

Convenience function for setting disabled/enabled by boolean

参数：

disabled : Boolean

返回：

void

This method is defined by Component.

setRawValue

public function setRawValue(Mixed value)

Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.

参数：

value : Mixed
The value to set

返回：

void

This method is defined by Field.

setSize

public function setSize(Number width, Number height)

* Sets the width and height of the checkbox wrapper element

参数：

width : Number
New width in pixels
height : Number
New height in pixels

返回：

void

This method is defined by Checkbox.

setValue

public function setValue(Boolean/String checked)

Sets the checked state of the checkbox

参数：

checked : Boolean/String
True, 'true,' or '1' to check the checkbox, any other value will uncheck it

返回：

void

This method is defined by Checkbox.

setVisible

public function setVisible(Boolean visible)

Convenience function to hide or show this component by boolean

参数：

visible : Boolean
True to show, false to hide

返回：

void

This method is defined by Component.

show

public function show()

Show this component

参数：

无。

返回：

void

This method is defined by Component.

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.

validate

public function validate()

Validates the field value

参数：

无。

返回：

Boolean
True if the value is valid, else false

This method is defined by Field.