Properties Methods Events Config Options Direct Link
Observable
  Component
    BoxComponent
      Field
        Checkbox

Class Ext.form.Checkbox

Package:Ext.form
Defined In:Checkbox.js
Class:Checkbox
Subclasses:Radio
Extends:Field
Single checkbox field. Can be used as a direct replacement for traditional checkbox fields.

Config Options

Config Options Defined By
  allowDomMove : Boolean
Whether the component can move the Dom node when rendering (defaults to true).
Component
  autoHeight : Boolean
True to use height:'auto', false to use fixed height (defaults to false).
BoxComponent
  autoWidth : Boolean
True to use width:'auto', false to use fixed width (defaults to false).
BoxComponent
  boxLabel : String
The text that appears beside the checkbox
Checkbox
  checked : Boolean
True if the the checkbox should render already checked (defaults to false)
Checkbox
  clearCls : String
The CSS class used to provide field clearing (defaults to 'x-form-clear-left')
Field
  disabled : Boolean
True to disable the field (defaults to false).
Field
  disabledClass : String
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
Component
  fieldClass : String
The default CSS class for the checkbox (defaults to "x-form-field")
Checkbox
  fieldLabel : String
The label text to display next to this field (defaults to '')
Field
  focusClass : String
The CSS class to use when the checkbox receives focus (defaults to undefined)
Checkbox
  height : Number
The height of this component in pixels (defaults to auto).
BoxComponent
  hideLabel : Boolean
True to completely hide the label element (defaults to false)
Field
  id : String
The unique id of this component (defaults to an auto-assigned id).
Component
  inputType : String
The type attribute for input fields -- e.g. radio, text, password (defaults to "text").
Field
  inputValue : String
The value that should go into the generated input element's value attribute
Checkbox
  invalidClass : String
The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
Field
  itemCls : String
An additional CSS class to apply to this field (defaults to the container's itemCls value if set, or '')
Field
  msgFx : String
Experimental The effect used when displaying a validation message under the field (defaults to 'normal').
Field
  name : String
The field's HTML name attribute.
Field
  stateId : String
The unique id for this component to use for state management purposes (defaults to the component id).
Component
  validateOnBlur : Boolean
Whether the field should validate when it loses focus (defaults to true).
Field
  validationDelay : Number
The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
Field
  validationEvent : String/Boolean
The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").
Field
  value : Mixed
A value to initialize this field with.
Field
  width : Number
The width of this component in pixels (defaults to auto).
BoxComponent

Public Properties

Property Defined By
  disabled : Boolean
True if this component is disabled. Read-only.
Component
  hidden : Boolean
True if this component is hidden. Read-only.
Component
  initialConfig : Object
This Component's initial configuration specification. Read-only.
Component
  rendered : Boolean
True if this component has been rendered. Read-only.
Component

Public Methods

Method Defined By

Public Events

Event Defined By