Observable Component BoxComponent Field Checkbox
Package: | Ext.form |
Defined In: | Checkbox.js |
Class: | Checkbox |
Subclasses: | Radio |
Extends: | Field |
Config Options | Defined By | |
---|---|---|
allowDomMove : Boolean
Whether the component can move the Dom node when rendering (defaults to true).
|
Component | |
applyTo : Mixed The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document ...
The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container.
|
Component | |
autoCreate : String/Object A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "checkbox", autocomple...
A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "checkbox", autocomplete: "off"})
|
Checkbox | |
autoHeight : Boolean
True to use height:'auto', false to use fixed height (defaults to false).
|
BoxComponent | |
autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render...
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).
|
Component | |
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 | |
cls : String An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for a...
An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.
|
Component | |
ctCls : String An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for...
An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
|
Component | |
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 | |
hideMode : String How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi...
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".
|
Component | |
hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide and show the...
True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container.
|
Component | |
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 | |
invalidText : String The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field i...
The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")
|
Field | |
itemCls : String
An additional CSS class to apply to this field (defaults to the container's itemCls value if set, or '')
|
Field | |
labelSeparator : String The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.l...
The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''.
|
Field | |
labelStyle : String A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if se...
A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or ''). For example,
labelStyle: 'font-weight:bold;' . |
Field | |
listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should b...
A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.
|
Observable | |
msgFx : String
Experimental The effect used when displaying a validation message under the field (defaults to 'normal').
|
Field | |
msgTarget : String The location where error text should display. Should be one of the following values (defaults to 'qtip'): Value ...
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 |
Field | |
name : String
The field's HTML name attribute.
|
Field | |
plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only requirement for a v...
An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.
|
Component | |
readOnly : Boolean True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM att...
True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.
|
Field | |
renderTo : Mixed The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using...
The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.
|
Component | |
stateEvents : Array An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be...
An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']).
|
Component | |
stateId : String
The unique id for this component to use for state management purposes (defaults to the component id).
|
Component | |
style : String A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.app...
A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.applyStyles.
|
Component | |
tabIndex : Number The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyT...
The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).
|
Field | |
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 | |
xtype : String The registered xtype to create. This config option is not used when passing a config object into a constructor. This ...
The registered xtype to create. This config option is not used when passing a config object into a constructor. This config option is used only when lazy instantiation is being used, and a child item of a Container is being specified not as a fully instantiated Component, but as a Component config object. The xtype will be looked up at render time up to determine what type of child Component to create.
The predefined xtypes are listed here. If you subclass Components to create your own Components, you may register them using Ext.ComponentMgr.registerType in order to be able to take advantage of lazy instantiation and rendering. |
Component |
Property | Defined By | |
---|---|---|
disabled : Boolean
True if this component is disabled. Read-only.
|
Component | |
True if this component is hidden. Read-only.
|
hidden : Boolean Component | |
initialConfig : Object
This Component's initial configuration specification. Read-only.
|
Component | |
ownerCt : Ext.Container The component's owner Ext.Container (defaults to undefined, and is set automatically when
the component is added to a...
The component's owner Ext.Container (defaults to undefined, and is set automatically when
the component is added to a container). Read-only.
|
Component | |
rendered : Boolean
True if this component has been rendered. Read-only.
|
Component |
Method | Defined By | |
---|---|---|
Checkbox( Object config ) Creates a new Checkbox
Creates a new Checkbox
Parameters:
|
Checkbox | |
addClass( string cls ) : void Adds a CSS class to the component's underlying element.
Adds a CSS class to the component's underlying element.
Parameters:
|
Component | |
addEvents( Object object ) : void Used to define events on this Observable
Used to define events on this Observable
Parameters:
|
Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this component
Appends an event handler to this component
Parameters:
|
Observable | |
applyToMarkup( String/HTMLElement el ) : void Apply this component to existing markup that is valid. With this function, no call to render() is required.
Apply this component to existing markup that is valid. With this function, no call to render() is required.
Parameters:
|
Component | |
cloneConfig( Object overrides ) : Ext.Component Clone the current component using the original config values passed into this instance by default.
Clone the current component using the original config values passed into this instance by default.
Parameters:
|
Component | |
destroy() : void Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the c...
Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the component from its Ext.Container (if applicable) and unregistering it from
Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method
should usually not need to be called directly.
Parameters:
|
Component | |
disable() : Ext.Component Disable this component.
Disable this component.
Parameters:
|
Component | |
enable() : Ext.Component Enable this component.
Enable this component.
Parameters:
|
Component | |
fireEvent( String eventName , Object... args ) : Boolean Fires the specified event with the passed parameters (minus the event name).
Fires the specified event with the passed parameters (minus the event name).
Parameters:
|
Observable | |
focus( [Boolean selectText ], [Boolean/Number delay ] ) : Ext.Component Try to focus this component.
Try to focus this component.
Parameters:
|
Component | |
getBox( [Boolean local ] ) : Object Gets the current box measurements of the component's underlying element.
Gets the current box measurements of the component's underlying element.
Parameters:
|
BoxComponent | |
getEl() : Ext.Element Returns the underlying Ext.Element.
Returns the underlying Ext.Element.
Parameters:
|
Component | |
getId() : String Returns the id of this component.
Returns the id of this component.
Parameters:
|
Component | |
getItemId() : String Returns the item id of this component.
Returns the item id of this component.
Parameters:
|
Component | |
getName() : String Returns the name attribute of the field if available
Returns the name attribute of the field if available
Parameters:
|
Field | |
getPosition( [Boolean local ] ) : Array Gets the current XY position of the component's underlying element.
Gets the current XY position of the component's underlying element.
Parameters:
|
BoxComponent | |
getRawValue() : Mixed | Field | |
getSize() : Object Gets the current size of the component's underlying element.
Gets the current size of the component's underlying element.
Parameters:
|
BoxComponent | |
getValue() : Boolean Returns the checked state of the checkbox.
Returns the checked state of the checkbox.
Parameters:
|
Checkbox | |
getXType() : String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
available xtypes, see the Ex...
Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
available xtypes, see the Ext.Component header. Example usage:
Parameters:
|
Component | |
getXTypes() : String Returns this component's xtype hierarchy as a slash-delimited string. For a list of all
available xtypes, see the Ext...
Returns this component's xtype hierarchy as a slash-delimited string. For a list of all
available xtypes, see the Ext.Component header. Example usage:
Parameters:
|
Component | |
hasListener( String eventName ) : Boolean Checks to see if this object has any listeners for a specified event
Checks to see if this object has any listeners for a specified event
Parameters:
|
Observable | |
hide() : Ext.Component Hide this component.
Hide this component.
Parameters:
|
Component | |
initComponent() : void
Parameters:
|
BoxComponent | |
isDirty() : void Returns true if this field has been changed since it was originally loaded and is not disabled.
Returns true if this field has been changed since it was originally loaded and is not disabled.
Parameters:
|
Field | |
isValid( Boolean preventMark ) : Boolean Returns whether or not the field value is currently valid
Returns whether or not the field value is currently valid
Parameters:
|
Field | |
isVisible() : void Returns true if this component is visible.
Returns true if this component is visible.
Parameters:
|
Component | |
isXType( String xtype , [Boolean shallow ] ) : void Tests whether or not this component is of a specific xtype. This can test whether this component is descended
from th...
Tests whether or not this component is of a specific xtype. This can test whether this component is descended
from the xtype (default) or whether it is directly of the xtype specified (shallow = true). For a list of all
available xtypes, see the Ext.Component header. Example usage:
Parameters:
|
Component | |
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this element (shorthand for addListener)
Appends an event handler to this element (shorthand for addListener)
Parameters:
|
Observable | |
purgeListeners() : void Removes all listeners for this object
Removes all listeners for this object
Parameters:
|
Observable | |
removeClass( string cls ) : void Removes a CSS class from the component's underlying element.
Removes a CSS class from the component's underlying element.
Parameters:
|
Component | |
removeListener( String eventName , Function handler , [Object scope ] ) : void Removes a listener
Removes a listener
Parameters:
|
Observable | |
render( [Mixed container ], [String/Number position ] ) : void If this is a lazy rendering component, render it to its container element.
If this is a lazy rendering component, render it to its container element.
Parameters:
|
Component | |
reset() : void Resets the current field value to the originally loaded value and clears any validation messages
Resets the current field value to the originally loaded value and clears any validation messages
Parameters:
|
Field | |
resumeEvents() : void Resume firing events. (see suspendEvents)
Resume firing events. (see suspendEvents)
Parameters:
|
Observable | |
setDisabled( Boolean disabled ) : void Convenience function for setting disabled/enabled by boolean.
Convenience function for setting disabled/enabled by boolean.
Parameters:
|
Component | |
setHeight( Number height ) : Ext.BoxComponent Sets the height of the component. This method fires the resize event.
Sets the height of the component. This method fires the resize event.
Parameters:
|
BoxComponent | |
setPagePosition( Number x , Number y ) : Ext.BoxComponent Sets the page XY position of the component. To set the left and top instead, use setPosition.
This method fires the ...
Sets the page XY position of the component. To set the left and top instead, use setPosition.
This method fires the move event.
Parameters:
|
BoxComponent | |
setPosition( Number left , Number top ) : Ext.BoxComponent Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires ...
Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires the move event.
Parameters:
|
BoxComponent | |
setRawValue( Mixed value ) : void
|
Field | |
setSize( Number/Object width , Number height ) : Ext.BoxComponent Sets the width and height of the component. This method fires the resize event. This method can accept
either width...
Sets the width and height of the component. This method fires the resize event. This method can accept
either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.
Parameters:
|
BoxComponent | |
setValue( Boolean/String checked ) : void Sets the checked state of the checkbox.
Sets the checked state of the checkbox.
Parameters:
|
Checkbox | |
setVisible( Boolean visible ) : Ext.Component Convenience function to hide or show this component by boolean.
Convenience function to hide or show this component by boolean.
Parameters:
|
Component | |
setWidth( Number width ) : Ext.BoxComponent Sets the width of the component. This method fires the resize event.
Sets the width of the component. This method fires the resize event.
Parameters:
|
BoxComponent | |
show() : Ext.Component Show this component.
Show this component.
Parameters:
|
Component | |
suspendEvents() : void Suspend the firing of all events. (see resumeEvents)
Suspend the firing of all events. (see resumeEvents)
Parameters:
|
Observable | |
syncSize() : Ext.BoxComponent Force the component's size to recalculate based on the underlying element's current height and width.
Force the component's size to recalculate based on the underlying element's current height and width.
Parameters:
|
BoxComponent | |
un( String eventName , Function handler , [Object scope ] ) : void Removes a listener (shorthand for removeListener)
Removes a listener (shorthand for removeListener)
Parameters:
|
Observable | |
updateBox( Object box ) : Ext.BoxComponent Sets the current box measurements of the component's underlying element.
Sets the current box measurements of the component's underlying element.
Parameters:
|
BoxComponent | |
validate() : Boolean Validates the field value
Validates the field value
Parameters:
|
Field |
Event | Defined By | |
---|---|---|
beforedestroy : ( Ext.Component this ) Fires before the component is destroyed. Return false to stop the destroy.
Fires before the component is destroyed. Return false to stop the destroy.
Listeners will be called with the following arguments:
|
Component | |
beforehide : ( Ext.Component this ) Fires before the component is hidden. Return false to stop the hide.
Fires before the component is hidden. Return false to stop the hide.
Listeners will be called with the following arguments:
|
Component | |
beforerender : ( Ext.Component this ) Fires before the component is rendered. Return false to stop the render.
Fires before the component is rendered. Return false to stop the render.
Listeners will be called with the following arguments:
|
Component | |
beforeshow : ( Ext.Component this ) Fires before the component is shown. Return false to stop the show.
Fires before the component is shown. Return false to stop the show.
Listeners will be called with the following arguments:
|
Component | |
beforestaterestore : ( Ext.Component this , Object state ) Fires before the state of the component is restored. Return false to stop the restore.
Fires before the state of the component is restored. Return false to stop the restore.
Listeners will be called with the following arguments:
|
Component | |
beforestatesave : ( Ext.Component this , Object state ) Fires before the state of the component is saved to the configured state provider. Return false to stop the save.
Fires before the state of the component is saved to the configured state provider. Return false to stop the save.
Listeners will be called with the following arguments:
|
Component | |
blur : ( Ext.form.Field this ) Fires when this field loses input focus.
Fires when this field loses input focus.
Listeners will be called with the following arguments:
|
Field | |
change : ( Ext.form.Field this , Mixed newValue , Mixed oldValue ) Fires just before the field blurs if the field value has changed.
Fires just before the field blurs if the field value has changed.
Listeners will be called with the following arguments:
|
Field | |
check : ( Ext.form.Checkbox this , Boolean checked ) Fires when the checkbox is checked or unchecked.
Fires when the checkbox is checked or unchecked.
Listeners will be called with the following arguments:
|
Checkbox | |
destroy : ( Ext.Component this ) Fires after the component is destroyed.
Fires after the component is destroyed.
Listeners will be called with the following arguments:
|
Component | |
disable : ( Ext.Component this ) Fires after the component is disabled.
Fires after the component is disabled.
Listeners will be called with the following arguments:
|
Component | |
enable : ( Ext.Component this ) Fires after the component is enabled.
Fires after the component is enabled.
Listeners will be called with the following arguments:
|
Component | |
focus : ( Ext.form.Field this ) Fires when this field receives input focus.
Fires when this field receives input focus.
Listeners will be called with the following arguments:
|
Field | |
hide : ( Ext.Component this ) Fires after the component is hidden.
Fires after the component is hidden.
Listeners will be called with the following arguments:
|
Component | |
invalid : ( Ext.form.Field this , String msg ) Fires after the field has been marked as invalid.
Fires after the field has been marked as invalid.
Listeners will be called with the following arguments:
|
Field | |
move : ( Ext.Component this , Number x , Number y ) Fires after the component is moved.
Fires after the component is moved.
Listeners will be called with the following arguments:
|
BoxComponent | |
render : ( Ext.Component this ) Fires after the component is rendered.
Fires after the component is rendered.
Listeners will be called with the following arguments:
|
Component | |
resize : ( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight ) Fires after the component is resized.
Fires after the component is resized.
Listeners will be called with the following arguments:
|
BoxComponent | |
show : ( Ext.Component this ) Fires after the component is shown.
Fires after the component is shown.
Listeners will be called with the following arguments:
|
Component | |
specialkey : ( Ext.form.Field this , Ext.EventObject e ) Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check
Ext.EventObject.g...
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.
Listeners will be called with the following arguments:
|
Field | |
staterestore : ( Ext.Component this , Object state ) Fires after the state of the component is restored.
Fires after the state of the component is restored.
Listeners will be called with the following arguments:
|
Component | |
statesave : ( Ext.Component this , Object state ) Fires after the state of the component is saved to the configured state provider.
Fires after the state of the component is saved to the configured state provider.
Listeners will be called with the following arguments:
|
Component | |
valid : ( Ext.form.Field this ) Fires after the field has been validated with no errors.
Fires after the field has been validated with no errors.
Listeners will be called with the following arguments:
|
Field |