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.

Properties - Methods - Events - Config Options

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	Checkbox(`Object config`)	Checkbox
	Creates a new CheckBox	Checkbox
	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
	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
	initComponent() : void	Field
	*	Field
	isDirty() : void	Field
	Returns true if this field has ben changed since it was originally loaded and is not disabled.	Field
	isValid(`Boolean preventMark`) : Boolean	Field
	Returns whether or not the field value is currently valid	Field
	markInvalid(`String msg`) : void	Field
	Mark this field as invalid	Field
	reset() : void	Field
	Resets the current field value to the originally-loaded value and clears any validation messages	Field
	setRawValue(`Mixed value`) : void	Field
	Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.	Field
	setValue(`Boolean/String checked`) : void	Checkbox
	Sets the checked state of the checkbox	Checkbox
	validate() : Boolean	Field
	Validates the field value	Field

Public Events

Event		Defined By
	blur : (`Ext.form.Field this`)	Field
	Fires when this field loses input focus.	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
	focus : (`Ext.form.Field this`)	Field
	Fires when this field receives input focus.	Field
	invalid : (`Ext.form.Field this`, `String msg`)	Field
	Fires after the field has been marked as invalid.	Field
	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

Config Options

Config Options		Defined By
	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
	name : String	Field
	The field's HTML name attribute	Field
	readOnly : Boolean	Field
	True to mark the field as readOnly in HTML - Note: this only sets the readOnly attribute.	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

Constructor Details

Checkbox

public function Checkbox(Object config)

Creates a new CheckBox

Parameters:

config : Object
Configuration options

Method Details

applyTo

public function applyTo(String/HTMLElement/Element el)

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

Parameters:

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

Returns:

Ext.form.Field
this

This method is defined by Field.

clearInvalid

public function clearInvalid()

Clear any invalid styles/messages for this field

Parameters:

None.

Returns:

void

This method is defined by Field.

getName

public function getName()

Returns the name attribute of the field if available

Parameters:

None.

Returns:

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.

Parameters:

None.

Returns:

Mixed
value The field value

This method is defined by Field.

getValue

public function getValue()

Returns the checked state of the checkbox.

Parameters:

None.

Returns:

Boolean
True if checked, else false

This method is defined by Checkbox.

initComponent

public function initComponent()

Parameters:

None.

Returns:

void

This method is defined by Field.

isDirty

public function isDirty()

Returns true if this field has ben changed since it was originally loaded and is not disabled.

Parameters:

None.

Returns:

void

This method is defined by Field.

isValid

public function isValid(Boolean preventMark)

Returns whether or not the field value is currently valid

Parameters:

preventMark : Boolean
True to disable marking the field invalid

Returns:

Boolean
True if the value is valid, else false

This method is defined by Field.

markInvalid

public function markInvalid(String msg)

Mark this field as invalid

Parameters:

msg : String
The validation message

Returns:

void

This method is defined by Field.

reset

public function reset()

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

Parameters:

None.

Returns:

void

This method is defined by Field.

setRawValue

public function setRawValue(Mixed value)

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

Parameters:

value : Mixed
The value to set

Returns:

void

This method is defined by Field.

setValue

public function setValue(Boolean/String checked)

Sets the checked state of the checkbox

Parameters:

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

Returns:

void

This method is defined by Checkbox.

validate

public function validate()

Validates the field value

Parameters:

None.

Returns:

Boolean
True if the value is valid, else false

This method is defined by Field.

Event Details

blur

public event blur

Fires when this field loses input focus.

Subscribers will be called with the following parameters:

this : Ext.form.Field

This event is defined by Field.

change

public event change

Fires just before the field blurs if the field value has changed.

Subscribers will be called with the following parameters:

this : Ext.form.Field
value : Mixed
The changed value
value : Mixed
The original value

This event is defined by Field.

check

public event check

Fires when the checkbox is checked or unchecked

Subscribers will be called with the following parameters:

this : Ext.form.Checkbox
This checkbox
checked : Boolean
The new checked value

This event is defined by Checkbox.

focus

public event focus

Fires when this field receives input focus.

Subscribers will be called with the following parameters:

this : Ext.form.Field

This event is defined by Field.

invalid

public event invalid

Fires after the field has been marked as invalid.

Subscribers will be called with the following parameters:

this : Ext.form.Field
msg : String
The validation message

This event is defined by Field.

specialkey

public event specialkey

Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check Ext.EventObject.getKey to determine which key was pressed.

Subscribers will be called with the following parameters:

this : Ext.form.Field
e : Ext.EventObject
The event object

This event is defined by Field.

valid

public event valid

Fires after the field has been validated with no errors.

Subscribers will be called with the following parameters:

this : Ext.form.Field

This event is defined by Field.

Config Details

autoCreate

autoCreate : String/Object

A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"})

This config option is defined by Field.

boxLabel

boxLabel : String

The text that appears beside the checkbox

This config option is defined by Checkbox.

checked

checked : Boolean

True if the the checkbox should render already checked (defaults to false)

This config option is defined by Checkbox.

fieldClass

fieldClass : String

The default CSS class for the checkbox (defaults to "x-form-field")

This config option is defined by Checkbox.

focusClass

focusClass : String

The CSS class to use when the checkbox receives focus (defaults to 'x-form-check-focus')

This config option is defined by Checkbox.

inputType

inputType : String

The type attribute for input fields - e.g. radio, text, password. (defaults to "text")

This config option is defined by Field.

inputValue

inputValue : String

The value that should go into the generated input element's value attribute

This config option is defined by Checkbox.

invalidClass

invalidClass : String

The CSS class to use when marking a field invalid (defaults to "x-form-invalid")

This config option is defined by Field.

invalidText

invalidText : String

The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")

This config option is defined by Field.

msgFx

msgFx : String

Experimental The effect used when displaying a validation message under the field (defaults to 'normal').

This config option is defined by Field.

msgTarget

msgTarget : String

The location where error text should display. Should be one of the following values (defaults to 'qtip'):

 Value Description ----------- ---------------------------------------------------------------------- qtip Display a quick tip when the user hovers over the field title Display a default browser title attribute popup under Add a block div beneath the field containing the error text side Add an error icon to the right of the field with a popup on hover [element id] Add the error text directly to the innerHTML of the specified element

This config option is defined by Field.

name

name : String

The field's HTML name attribute

This config option is defined by Field.

readOnly

readOnly : Boolean

True to mark the field as readOnly in HTML - Note: this only sets the readOnly attribute.

This config option is defined by Field.

validateOnBlur

validateOnBlur : String/Boolean

Defaults to true.

This config option is defined by Field.

validationDelay

validationDelay : Number

The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)

This config option is defined by Field.

validationEvent

validationEvent : String/Boolean

The event that should initiate field validation. Set to false to disable automatic validation. (defaults to "keyup")

This config option is defined by Field.

value

value : Mixed

A value to initialize this field with

This config option is defined by Field.