Print Friendly

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

Property Defined By
  disabled : Object Component
true if this component is disabled. Read-only.
  disabledClass : Object Component
CSS class added to the component when it is disabled.
  hidden : Object Component
true if this component is hidden. Read-only.
  rendered : Object Component
true if this component has been rendered. Read-only.

Public Methods

Method Defined By
  Checkbox(Object config) Checkbox
Creates a new CheckBox
  addEvents(Object object) : void Observable
Copies any events from the passed object onto this object if they do not already exist. The passed object must also ...
  addListener(String eventName, Function handler, [Object options]) : void Observable
Appends an event handler to this component
  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().
  clearInvalid() : void Field
Clear any invalid styles/messages for this field
  disable() : void Component
Disable this component
  enable() : void Component
Enable this component
  fireEvent(String eventName, Object... args) : Boolean Observable
Fires the specified event with the passed parameters (minus the event name).
  focus(Boolean selectText) : void Component
Try to focus this component
  getEl() : Ext.Element Component
Returns the underlying Ext.Element
  getName() : String Field
Returns the name attribute of the field if available
  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.
  getValue() : Boolean Checkbox
Returns the checked state of the checkbox.
  hasListener(String eventName) : Boolean Observable
Checks to see if this object is currently listening for a specified event
  hide() : void Component
Hide this component
  isValid() : Boolean Field
Returns whether or not the field value is currently valid
  markInvalid(String msg) : void Field
Mark this field as invalid
  on(String eventName, Function handler, [Object options]) : void Observable
Appends an event handler to this element (shorthand for addListener)
  purgeListeners() : void Observable
Removes all listeners for this object
  removeListener(String eventName, Function handler, [Object scope]) : void Observable
Removes a listener
  render(String/HTMLElement/Element container) : void Component
If this is a lazy rendering component, render it to it's container element
  reset() : void Field
Resets the current field value to the originally-loaded value and clears any validation messages
  setDisabled(Boolean disabled) : void Component
Convenience function for setting disabled/enabled by boolean
  setRawValue(Mixed value) : void Field
Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.
  setSize(Number width, Number height) : void Checkbox
* Sets the width and height of the checkbox wrapper element
  setValue(Boolean/String checked) : void Checkbox
Sets the checked state of the checkbox
  setVisible(Boolean visible) : void Component
Convenience function to hide or show this component by boolean
  show() : void Component
Show this component
  un(String eventName, Function handler, [Object scope]) : void Observable
Removes a listener (shorthand for removeListener)
  validate() : Boolean Field
Validates the field value

Public Events

Event Defined By
  beforedestroy : (Ext.Component this) Component
Fires before the component is destroyed
  beforehide : (Ext.Component this) Component
Fires before the component is hidden
  beforerender : (Ext.Component this) Component
Fires before the component is rendered
  beforeshow : (Ext.Component this) Component
Fires before the component is shown
  blur : (Ext.form.Field this) Field
Fires when
  change : (Ext.form.Field this, Mixed value, Mixed value) Field
Fires just before the field blurs if the field value has changed
  check : (Ext.form.Checkbox this, Boolean checked) Checkbox
Fires when the checkbox is checked or unchecked
  destroy : (Ext.Component this) Component
Fires after the component is destroyed
  disable : (Ext.Component this) Component
Fires after the component is disabled
  enable : (Ext.Component this) Component
Fires after the component is enabled
  focus : (Ext.form.Field this) Field
Fires when this field receives input focus
  hide : (Ext.Component this) Component
Fires after the component is hidden
  invalid : (Ext.form.Field this, String msg) Field
Fires after the field has been marked as invalid
  render : (Ext.Component this) Component
Fires after the component is rendered
  show : (Ext.Component this) Component
Fires after the component is shown
  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...
  valid : (Ext.form.Field this) Field
Fires after the field has been validated with no errors

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...
  boxLabel : String Checkbox
The text that appears beside the checkbox
  checked : Boolean Checkbox
True if the the checkbox should render already checked (defaults to false)
  fieldClass : String Checkbox
The default CSS class for the checkbox (defaults to "x-form-field")
  focusClass : String Checkbox
The CSS class to use when the checkbox receives focus (defaults to 'x-form-check-focus')
  inputType : String Field
The type attribute for input fields - e.g. radio, text, password. (defaults to "text")
  inputValue : String Checkbox
The value that should go into the generated input element's value attribute
  invalidClass : String Field
The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
  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...
  msgFx : String Field
Experimental The effect used when displaying a validation message under the field (defaults to 'normal').
  msgTarget : String Field
The location where error text should display. Should be one of the following values (defaults to 'qtip'): Value Desc...
  validationDelay : Number Field
The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
  validationEvent : String/Boolean Field
The event that should initiate field validation. Set to false to disable automatic validation. (defaults to "keyup")

Property Details

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.

Constructor Details

Checkbox

public function Checkbox(Object config)
Creates a new CheckBox
Parameters:
  • config : Object
    Configuration options

Method Details

addEvents

public function addEvents(Object object)
Copies any events from the passed object onto this object if they do not already exist. The passed object must also inherit from Observable for this method to have any effect.
Parameters:
  • object : Object
    The object from which to copy events
Returns:
  • void
This method is defined by Observable.

addListener

public function addListener(String eventName, Function handler, [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
  • options : Object
    (optional)
Returns:
  • 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().
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.

disable

public function disable()
Disable this component
Parameters:
  • None.
Returns:
  • void
This method is defined by Component.

enable

public function enable()
Enable this component
Parameters:
  • None.
Returns:
  • void
This method is defined by Component.

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.

focus

public function focus(Boolean selectText)
Try to focus this component
Parameters:
  • selectText : Boolean
    True to also select the text in this component (if applicable)
Returns:
  • void
This method is defined by Component.

getEl

public function getEl()
Returns the underlying Ext.Element
Parameters:
  • None.
Returns:
  • Ext.Element
    The element
This method is defined by Component.

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.

hasListener

public function hasListener(String eventName)
Checks to see if this object is currently listening 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.

hide

public function hide()
Hide this component
Parameters:
  • None.
Returns:
  • void
This method is defined by Component.

isValid

public function isValid()
Returns whether or not the field value is currently valid
Parameters:
  • None.
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.

on

public function on(String eventName, Function handler, [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
  • 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.

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(String/HTMLElement/Element container)
If this is a lazy rendering component, render it to it's container element
Parameters:
  • container : String/HTMLElement/Element
    The element this component should be rendered into
Returns:
  • 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
Parameters:
  • None.
Returns:
  • void
This method is defined by Field.

setDisabled

public function setDisabled(Boolean disabled)
Convenience function for setting disabled/enabled by boolean
Parameters:
  • disabled : Boolean
Returns:
  • 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.
Parameters:
  • value : Mixed
    The value to set
Returns:
  • 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
Parameters:
  • width : Number
    New width in pixels
  • height : Number
    New height in pixels
Returns:
  • void
This method is defined by Checkbox.

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.

setVisible

public function setVisible(Boolean visible)
Convenience function to hide or show this component by boolean
Parameters:
  • visible : Boolean
    True to show, false to hide
Returns:
  • void
This method is defined by Component.

show

public function show()
Show this component
Parameters:
  • None.
Returns:
  • void
This method is defined by Component.

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.

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

beforedestroy

public event beforedestroy
Fires before the component is destroyed
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

beforehide

public event beforehide
Fires before the component is hidden
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

beforerender

public event beforerender
Fires before the component is rendered
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

beforeshow

public event beforeshow
Fires before the component is shown
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

blur

public event blur
Fires when
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.

destroy

public event destroy
Fires after the component is destroyed
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

disable

public event disable
Fires after the component is disabled
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

enable

public event enable
Fires after the component is enabled
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

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.

hide

public event hide
Fires after the component is hidden
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

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.

render

public event render
Fires after the component is rendered
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

show

public event show
Fires after the component is shown
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

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.

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.
Ext - Copyright © 2006-2007 Ext JS, LLC
All rights reserved.