Single checkbox field. Can be used as a direct replacement for traditional checkbox fields.
|
Checkbox( Object config ) |
Checkbox |
Creates a new Checkbox |
|
addEvents( Object object ) : void |
Observable |
Used to define events on this Observable |
|
addListener( String eventName , Function handler , [Object scope ], [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 |
|
destroy() : void |
Component |
Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the c... |
|
disable() : Ext.Component |
Component |
Disable this component. |
|
enable() : Ext.Component |
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 ) : Ext.Component |
Component |
Try to focus this component. |
|
getBox( [Boolean local ] ) : s |
BoxComponent |
Gets the current box measurements of the component's underlying element. |
|
getEl() : Ext.Element |
Component |
Returns the underlying Ext.Element. |
|
getId() : String |
Component |
Returns the id of this component. |
|
getName() : String |
Field |
Returns the name attribute of the field if available |
|
getPosition( [Boolean local ] ) : Array |
BoxComponent |
Gets the current XY position of the component's underlying element. |
|
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. |
|
getSize() : Object |
BoxComponent |
Gets the current size of the component's underlying element. |
|
getValue() : Boolean |
Checkbox |
Returns the checked state of the checkbox. |
|
hasListener( String eventName ) : Boolean |
Observable |
Checks to see if this object has any listeners for a specified event |
|
hide() : Ext.Component |
Component |
Hide this component. |
|
isDirty() : void |
Field |
Returns true if this field has been changed since it was originally loaded and is not disabled. |
|
isValid( Boolean preventMark ) : Boolean |
Field |
Returns whether or not the field value is currently valid |
|
isVisible() : void |
Component |
Returns true if this component is visible. |
|
markInvalid( String msg ) : void |
Field |
Mark this field as invalid |
|
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void |
Observable |
Appends an event handler to this element (shorthand for addListener) |
|
onPosition( Number x , Number y ) : void |
BoxComponent |
Called after the component is moved, this method is empty by default but can be implemented by any
subclass that need... |
|
onResize( Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight ) : void |
BoxComponent |
Called after the component is resized, this method is empty by default but can be implemented by any
subclass that ne... |
|
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 its 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. |
|
setPagePosition( Number x , Number y ) : s |
BoxComponent |
Sets the page XY position of the component. To set the left and top instead, use setPosition.
This method fires the ... |
|
setPosition( Number left , Number top ) : s |
BoxComponent |
Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires ... |
|
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/Object width , Number height ) : Ext.BoxComponent |
BoxComponent |
Sets the width and height of the component. This method fires the resize event. This method can accept
either width... |
|
setValue( Boolean/String checked ) : void |
Checkbox |
Sets the checked state of the checkbox. |
|
setVisible( Boolean visible ) : Ext.Component |
Component |
Convenience function to hide or show this component by boolean. |
|
show() : Ext.Component |
Component |
Show this component. |
|
syncSize() : s |
BoxComponent |
Force the component's size to recalculate based on the underlying element's current height and width. |
|
un( String eventName , Function handler , [Object scope ] ) : void |
Observable |
Removes a listener (shorthand for removeListener) |
|
updateBox( Object box ) : s |
BoxComponent |
Sets the current box measurements of the component's underlying element. |
|
validate() : Boolean |
Field |
Validates the field value |
|
beforedestroy : ( Ext.Component this ) |
Component |
Fires before the component is destroyed. Return false to stop the destroy. |
|
beforehide : ( Ext.Component this ) |
Component |
Fires before the component is hidden. Return false to stop the hide. |
|
beforerender : ( Ext.Component this ) |
Component |
Fires before the component is rendered. Return false to stop the render. |
|
beforeshow : ( Ext.Component this ) |
Component |
Fires before the component is shown. Return false to stop the show. |
|
blur : ( Ext.form.Field this ) |
Field |
Fires when this field loses input focus. |
|
change : ( Ext.form.Field this , Mixed newValue , Mixed oldValue ) |
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. |
|
move : ( Ext.Component this , Number x , Number y ) |
BoxComponent |
Fires after the component is moved. |
|
render : ( Ext.Component this ) |
Component |
Fires after the component is rendered. |
|
resize : ( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight ) |
BoxComponent |
Fires after the component is resized. |
|
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. |
|
allowDomMove : Boolean |
Component |
Whether the component can move the Dom node when rendering (defaults to true). |
|
autoCreate : String/Object |
Checkbox |
A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "checkbox", autocomple... |
|
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) |
|
cls : String |
Field |
A CSS class to apply to the field's underlying element. |
|
disableClass : String |
Component |
CSS class added to the component when it is disabled (defaults to "x-item-disabled"). |
|
disabled : Boolean |
Field |
True to disable the field (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 undefined) |
|
hideMode : String |
Component |
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi... |
|
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 ... |
|
name : String |
Field |
The field's HTML name attribute. |
|
readOnly : Boolean |
Field |
True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM att... |
|
tabIndex : Number |
Field |
The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyT... |
|
validateOnBlur : Boolean |
Field |
Whether the field should validate when it loses focus (defaults to true). |
|
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"). |
|
value : Mixed |
Field |
A value to initialize this field with. |
allowDomMove
allowDomMove : Boolean
Whether the component can move the Dom node when rendering (defaults to true).
autoCreate
autoCreate : String/Object
A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "checkbox", autocomplete: "off"})
This config option is defined by Checkbox.
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.
cls
cls : String
A CSS class to apply to the field's underlying element.
This config option is defined by
Field.
disableClass
disableClass : String
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
disabled
disabled : Boolean
True to disable the field (defaults to false).
This config option is defined by
Field.
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 undefined)
This config option is defined by Checkbox.
hideMode
hideMode : String
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".
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 (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.
This config option is defined by
Field.
tabIndex
tabIndex : Number
The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).
This config option is defined by
Field.
validateOnBlur
validateOnBlur : Boolean
Whether the field should validate when it loses focus (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.