Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.form.field.Checkbox.html
1 <!DOCTYPE html><html><head><title>Ext.form.field.Checkbox | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.form.field.Checkbox',
13         docClass: 'Ext.form.field.Checkbox',
14         docReq: 'Ext.form.field.Checkbox',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'Checkbox.html#Ext-form.field.Checkbox';
33     clsInfo = {"methods":["Checkbox","addClass","addCls","addClsWithUI","addEvents","addListener","addManagedListener","addStateEvents","afterComponentLayout","alignTo","animate","applyState","batchChanges","beforeComponentLayout","bubble","capture","center","checkChange","checkDirty","clearInvalid","clearListeners","clearManagedListeners","cloneConfig","destroy","disable","doAutoRender","doComponentLayout","doConstrain","enable","enableBubble","extractFileInput","findLayoutController","findParentBy","findParentByType","fireEvent","focus","getActiveAnimation","getActiveError","getActiveErrors","getBox","getBubbleTarget","getEl","getErrors","getFieldLabel","getHeight","getId","getInputId","getInsertPosition","getLoader","getModelData","getName","getPlugin","getPosition","getRawValue","getSize","getState","getStateId","getSubmitData","getSubmitValue","getValue","getWidth","getXType","getXTypes","hasActiveError","hasListener","hasUICls","hide","initField","initLabelable","is","isDescendantOf","isDirty","isDisabled","isDraggable","isDroppable","isEqual","isFileUpload","isFloating","isHidden","isValid","isVisible","isXType","markInvalid","nextNode","nextSibling","observe","on","previousNode","previousSibling","processRawValue","rawToValue","relayEvents","releaseCapture","removeCls","removeClsWithUI","removeListener","removeManagedListener","reset","resetOriginalValue","resumeEvents","sequenceFx","setActive","setActiveError","setActiveErrors","setAutoScroll","setDisabled","setDocked","setFieldDefaults","setFieldStyle","setHeight","setLoading","setPagePosition","setPosition","setRawValue","setReadOnly","setSize","setUI","setValue","setVisible","setWidth","show","stopAnimation","suspendEvents","syncFx","toBack","toFront","un","unsetActiveError","up","update","updateBox","validate","validateValue","valueToRaw"],"cfgs":["activeError","activeErrorsTpl","autoEl","autoFitErrors","autoRender","autoScroll","autoShow","baseBodyCls","baseCls","border","boxLabel","boxLabelAlign","boxLabelCls","checkChangeBuffer","checkChangeEvents","checked","checkedCls","clearCls","cls","componentCls","componentLayout","contentEl","data","dirtyCls","disabled","disabledCls","draggable","errorMsgCls","fieldBodyCls","fieldCls","fieldLabel","fieldStyle","floating","focusCls","focusOnToFront","formItemCls","frame","handler","height","hidden","hideEmptyLabel","hideLabel","hideMode","html","id","inputId","inputType","inputValue","invalidCls","invalidText","itemId","labelAlign","labelCls","labelPad","labelSeparator","labelStyle","labelWidth","labelableRenderTpl","listeners","loader","maintainFlex","margin","maxHeight","maxWidth","minHeight","minWidth","msgTarget","name","overCls","padding","plugins","preventMark","readOnly","readOnlyCls","renderSelectors","renderTo","renderTpl","resizable","resizeHandles","saveBuffer","scope","shadow","stateEvents","stateId","stateful","style","styleHtmlCls","styleHtmlContent","submitValue","tabIndex","toFrontOnShow","tpl","tplWriteMode","ui","uncheckedValue","validateOnBlur","validateOnChange","value","width"],"properties":["bodyEl","boxLabelEl","clearInvalid","draggable","errorEl","floatParent","frameSize","hasActiveFx","inputEl","isFieldLabelable","isFormField","labelEl","markInvalid","maskOnDisable","originalValue","ownerCt","rendered","stopFx","zIndexManager"],"events":["activate","added","afterrender","beforeactivate","beforedeactivate","beforedestroy","beforehide","beforerender","beforeshow","beforestaterestore","beforestatesave","blur","change","deactivate","destroy","dirtychange","disable","enable","errorchange","focus","hide","move","removed","render","resize","show","specialkey","staterestore","statesave","validitychange"],"subclasses":["Ext.form.field.Radio"]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="comp"><a href="../source/Checkbox.html#Ext-form.field.Checkbox" target="_blank">Ext.form.field.Checkbox</a><span>xtype: checkboxfield</span></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.AbstractComponent.html" rel="Ext.AbstractComponent" class="cls docClass">Ext.AbstractComponent</a><div class="subclass"><a href="Ext.Component.html" rel="Ext.Component" class="cls docClass">Ext.Component</a><div class="subclass"><a href="Ext.form.field.Base.html" rel="Ext.form.field.Base" class="cls docClass">Ext.form.field.Base</a><div class="subclass"><strong>Ext.form.field.Checkbox</strong></div></div></div></div><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div><div class="mixin"><a href="Ext.util.Animate.html" rel="Ext.util.Animate" class="cls docClass">Ext.util.Animate</a></div><div class="mixin"><a href="Ext.state.Stateful.html" rel="Ext.state.Stateful" class="cls docClass">Ext.state.Stateful</a></div><div class="mixin"><a href="Ext.util.Floating.html" rel="Ext.util.Floating" class="cls docClass">Ext.util.Floating</a></div><div class="mixin"><a href="Ext.form.Labelable.html" rel="Ext.form.Labelable" class="cls docClass">Ext.form.Labelable</a></div><div class="mixin"><a href="Ext.form.field.Field.html" rel="Ext.form.field.Field" class="cls docClass">Ext.form.field.Field</a></div></pre><p>Single checkbox field. Can be used as a direct replacement for traditional checkbox fields. Also serves as a
38 parent class for <a href="Ext.form.field.Radio.html" rel="Ext.form.field.Radio" class="docClass">radio buttons</a>.</p>
39
40 <p><strong>Labeling:</strong> In addition to the <a href="Ext.form.Labelable.html" rel="Ext.form.Labelable" class="docClass">standard field labeling options</a>, checkboxes
41 may be given an optional <a href="Ext.form.field.Checkbox.html#boxLabel" rel="Ext.form.field.Checkbox#boxLabel" class="docClass">boxLabel</a> which will be displayed immediately after checkbox. Also see
42 <a href="Ext.form.CheckboxGroup.html" rel="Ext.form.CheckboxGroup" class="docClass">Ext.form.CheckboxGroup</a> for a convenient method of grouping related checkboxes.</p>
43
44 <p><strong>Values:</strong>
45 The main value of a checkbox is a boolean, indicating whether or not the checkbox is checked.
46 The following values will check the checkbox:
47 <code>true</code>
48 <code>'true'</code>
49 <code>'1'</code>
50 <code>'on'</code></p>
51
52 <p>Any other value will uncheck the checkbox.</p>
53
54 <p>In addition to the main boolean value, you may also specify a separate <a href="Ext.form.field.Checkbox.html#inputValue" rel="Ext.form.field.Checkbox#inputValue" class="docClass">inputValue</a>. This will be
55 sent as the parameter value when the form is <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submitted</a>. You will want to set
56 this value if you have multiple checkboxes with the same <a href="Ext.form.field.Checkbox.html#name" rel="Ext.form.field.Checkbox#name" class="docClass">name</a>. If not specified, the value <code>on</code>
57 will be used.
58 <img class="screenshot" src="../Ext.form.Checkbox.png" alt="Ext.form.Checkbox Checkbox component" />
59 <strong>Example usage:</strong></p>
60
61 <pre class="prettyprint"><code>Ext.create('Ext.form.Panel', {
62     bodyPadding: 10,
63     width      : 300,
64     title      : 'Pizza Order',
65     items: [
66         {
67             xtype      : 'fieldcontainer',
68             fieldLabel : 'Toppings',
69             defaultType: 'checkboxfield',
70             items: [
71                 {
72                     boxLabel  : 'Anchovies',
73                     name      : 'topping',
74                     inputValue: '1',
75                     id        : 'checkbox1'
76                 }, {
77                     boxLabel  : 'Artichoke Hearts',
78                     name      : 'topping',
79                     inputValue: '2',
80                     checked   : true,
81                     id        : 'checkbox2'
82                 }, {
83                     boxLabel  : 'Bacon',
84                     name      : 'topping',
85                     inputValue: '3',
86                     id        : 'checkbox3'
87                 }
88             ]
89         }
90     ],
91     bbar: [
92         {
93             text: 'Select Bacon',
94             handler: function() {
95                 var checkbox = Ext.getCmp('checkbox3');
96                 checkbox.setValue(true);
97             }
98         },
99         '-',
100         {
101             text: 'Select All',
102             handler: function() {
103                 var checkbox1 = Ext.getCmp('checkbox1'),
104                     checkbox2 = Ext.getCmp('checkbox2'),
105                     checkbox3 = Ext.getCmp('checkbox3');
106
107                 checkbox1.setValue(true);
108                 checkbox2.setValue(true);
109                 checkbox3.setValue(true);
110             }
111         },
112         {
113             text: 'Deselect All',
114             handler: function() {
115                 var checkbox1 = Ext.getCmp('checkbox1'),
116                     checkbox2 = Ext.getCmp('checkbox2'),
117                     checkbox3 = Ext.getCmp('checkbox3');
118
119                 checkbox1.setValue(false);
120                 checkbox2.setValue(false);
121                 checkbox3.setValue(false);
122             }
123         }
124     ],
125     renderTo: Ext.getBody()
126 });
127 </code></pre>
128 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">CSS Class configs</h4><div id="config-baseBodyCls" class="member f inherited"><a href="Ext.form.field.Checkbox.html#config-baseBodyCls" rel="config-baseBodyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-baseBodyCls" class="viewSource">view source</a></div><a name="baseBodyCls"></a><a name="config-baseBodyCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-baseBodyCls" class="cls expand">baseBodyCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'.</p>
129 </div><div class="long"><p>The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'.</p>
130 </div></div></div><div id="config-baseCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-baseCls" rel="config-baseCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-baseCls" class="viewSource">view source</a></div><a name="baseCls"></a><a name="config-baseCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-baseCls" class="cls expand">baseCls</a><span> : String</span></div><div class="description"><div class="short">The base CSS class to apply to this components's element. This will also be prepended to
131 elements within this compone...</div><div class="long"><p>The base CSS class to apply to this components's element. This will also be prepended to
132 elements within this component like Panel's body will get a class x-panel-body. This means
133 that if you create a subclass of Panel, and you want it to get all the Panels styling for the
134 element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this
135 component.</p>
136 </div></div></div><div id="config-boxLabelCls" class="member ni"><a href="Ext.form.field.Checkbox.html#config-boxLabelCls" rel="config-boxLabelCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-boxLabelCls" class="viewSource">view source</a></div><a name="boxLabelCls"></a><a name="config-boxLabelCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-boxLabelCls" class="cls expand">boxLabelCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the <a href="Ext.form.field.Checkbox.html#boxLabel" rel="Ext.form.field.Checkbox#boxLabel" class="docClass">boxLabel</a> element</p>
137 </div><div class="long"><p>The CSS class to be applied to the <a href="Ext.form.field.Checkbox.html#boxLabel" rel="Ext.form.field.Checkbox#boxLabel" class="docClass">boxLabel</a> element</p>
138 </div></div></div><div id="config-checkedCls" class="member ni"><a href="Ext.form.field.Checkbox.html#config-checkedCls" rel="config-checkedCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-checkedCls" class="viewSource">view source</a></div><a name="checkedCls"></a><a name="config-checkedCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-checkedCls" class="cls expand">checkedCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class added to the component's main element when it is in the checked state.</p>
139 </div><div class="long"><p>The CSS class added to the component's main element when it is in the checked state.</p>
140 </div></div></div><div id="config-clearCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-clearCls" rel="config-clearCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-clearCls" class="viewSource">view source</a></div><a name="clearCls"></a><a name="config-clearCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-clearCls" class="cls expand">clearCls</a><span> : String</span></div><div class="description"><div class="short">The CSS class to be applied to the special clearing div rendered directly after the field
141 contents wrapper to provide...</div><div class="long"><p>The CSS class to be applied to the special clearing div rendered directly after the field
142 contents wrapper to provide field clearing (defaults to <tt>'x-clear'</tt>).</p>
143 </div></div></div><div id="config-cls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-cls" rel="config-cls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-cls" class="viewSource">view source</a></div><a name="cls"></a><a name="config-cls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-cls" class="cls expand">cls</a><span> : String</span></div><div class="description"><div class="short">An optional extra CSS class that will be added to this component's Element (defaults to '').  This can be
144 useful for ...</div><div class="long"><p>An optional extra CSS class that will be added to this component's Element (defaults to '').  This can be
145 useful for adding customized styles to the component or any of its children using standard CSS rules.</p>
146 </div></div></div><div id="config-componentCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-componentCls" rel="config-componentCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-componentCls" class="viewSource">view source</a></div><a name="componentCls"></a><a name="config-componentCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-componentCls" class="cls expand">componentCls</a><span> : String</span></div><div class="description"><div class="short"><p>CSS Class to be added to a components root level element to give distinction to it
147 via styling.</p>
148 </div><div class="long"><p>CSS Class to be added to a components root level element to give distinction to it
149 via styling.</p>
150 </div></div></div><div id="config-dirtyCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-dirtyCls" rel="config-dirtyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-dirtyCls" class="viewSource">view source</a></div><a name="dirtyCls"></a><a name="config-dirtyCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-dirtyCls" class="cls expand">dirtyCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to use when the field value <a href="Ext.form.field.Checkbox.html#isDirty" rel="Ext.form.field.Checkbox#isDirty" class="docClass">is dirty</a>.</p>
151 </div><div class="long"><p>The CSS class to use when the field value <a href="Ext.form.field.Checkbox.html#isDirty" rel="Ext.form.field.Checkbox#isDirty" class="docClass">is dirty</a>.</p>
152 </div></div></div><div id="config-disabledCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-disabledCls" rel="config-disabledCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-disabledCls" class="viewSource">view source</a></div><a name="disabledCls"></a><a name="config-disabledCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-disabledCls" class="cls expand">disabledCls</a><span> : String</span></div><div class="description"><div class="short"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
153 </div><div class="long"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
154 </div></div></div><div id="config-errorMsgCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-errorMsgCls" rel="config-errorMsgCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-errorMsgCls" class="viewSource">view source</a></div><a name="errorMsgCls"></a><a name="config-errorMsgCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-errorMsgCls" class="cls expand">errorMsgCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'.</p>
155 </div><div class="long"><p>The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'.</p>
156 </div></div></div><div id="config-fieldBodyCls" class="member ni"><a href="Ext.form.field.Checkbox.html#config-fieldBodyCls" rel="config-fieldBodyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-fieldBodyCls" class="viewSource">view source</a></div><a name="fieldBodyCls"></a><a name="config-fieldBodyCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-fieldBodyCls" class="cls expand">fieldBodyCls</a><span> : String</span></div><div class="description"><div class="short"><p>An extra CSS class to be applied to the body content element in addition to <a href="Ext.form.field.Checkbox.html#fieldBodyCls" rel="Ext.form.field.Checkbox#fieldBodyCls" class="docClass">fieldBodyCls</a>.
157 Defaults to 'x-form-cb-wrap.</p>
158 </div><div class="long"><p>An extra CSS class to be applied to the body content element in addition to <a href="Ext.form.field.Checkbox.html#fieldBodyCls" rel="Ext.form.field.Checkbox#fieldBodyCls" class="docClass">fieldBodyCls</a>.
159 Defaults to 'x-form-cb-wrap.</p>
160 </div></div></div><div id="config-fieldCls" class="member ni"><a href="Ext.form.field.Checkbox.html#config-fieldCls" rel="config-fieldCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-fieldCls" class="viewSource">view source</a></div><a name="fieldCls"></a><a name="config-fieldCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-fieldCls" class="cls expand">fieldCls</a><span> : String</span></div><div class="description"><div class="short"><p>The default CSS class for the checkbox (defaults to <tt>'x-form-field'</tt>)</p>
161 </div><div class="long"><p>The default CSS class for the checkbox (defaults to <tt>'x-form-field'</tt>)</p>
162 </div></div></div><div id="config-focusCls" class="member ni"><a href="Ext.form.field.Checkbox.html#config-focusCls" rel="config-focusCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-focusCls" class="viewSource">view source</a></div><a name="focusCls"></a><a name="config-focusCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-focusCls" class="cls expand">focusCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to use when the checkbox receives focus
163 (defaults to <tt>'x-form-cb-focus'</tt>)</p>
164 </div><div class="long"><p>The CSS class to use when the checkbox receives focus
165 (defaults to <tt>'x-form-cb-focus'</tt>)</p>
166 </div></div></div><div id="config-formItemCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-formItemCls" rel="config-formItemCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-formItemCls" class="viewSource">view source</a></div><a name="formItemCls"></a><a name="config-formItemCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-formItemCls" class="cls expand">formItemCls</a><span> : String</span></div><div class="description"><div class="short">A CSS class to be applied to the outermost element to denote that it is participating in the form
167 field layout. Defau...</div><div class="long"><p>A CSS class to be applied to the outermost element to denote that it is participating in the form
168 field layout. Defaults to 'x-form-item'.</p>
169 </div></div></div><div id="config-invalidCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-invalidCls" rel="config-invalidCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-invalidCls" class="viewSource">view source</a></div><a name="invalidCls"></a><a name="config-invalidCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-invalidCls" class="cls expand">invalidCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to use when marking the component invalid (defaults to 'x-form-invalid')</p>
170 </div><div class="long"><p>The CSS class to use when marking the component invalid (defaults to 'x-form-invalid')</p>
171 </div></div></div><div id="config-labelCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-labelCls" rel="config-labelCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelCls" class="viewSource">view source</a></div><a name="labelCls"></a><a name="config-labelCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-labelCls" class="cls expand">labelCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the label element. Defaults to 'x-form-item-label'.</p>
172 </div><div class="long"><p>The CSS class to be applied to the label element. Defaults to 'x-form-item-label'.</p>
173 </div></div></div><div id="config-overCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-overCls" rel="config-overCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-overCls" class="viewSource">view source</a></div><a name="overCls"></a><a name="config-overCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-overCls" class="cls expand">overCls</a><span> : String</span></div><div class="description"><div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves
174 over the Element, and...</div><div class="long"><p>An optional extra CSS class that will be added to this component's Element when the mouse moves
175 over the Element, and removed when the mouse moves out. (defaults to '').  This can be
176 useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.</p>
177 </div></div></div><div id="config-readOnlyCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-readOnlyCls" rel="config-readOnlyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-readOnlyCls" class="viewSource">view source</a></div><a name="readOnlyCls"></a><a name="config-readOnlyCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-readOnlyCls" class="cls expand">readOnlyCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class applied to the component's main element when it is <a href="Ext.form.field.Checkbox.html#readOnly" rel="Ext.form.field.Checkbox#readOnly" class="docClass">readOnly</a>.</p>
178 </div><div class="long"><p>The CSS class applied to the component's main element when it is <a href="Ext.form.field.Checkbox.html#readOnly" rel="Ext.form.field.Checkbox#readOnly" class="docClass">readOnly</a>.</p>
179 </div></div></div><div id="config-styleHtmlCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-styleHtmlCls" rel="config-styleHtmlCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlCls" class="viewSource">view source</a></div><a name="styleHtmlCls"></a><a name="config-styleHtmlCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-styleHtmlCls" class="cls expand">styleHtmlCls</a><span> : String</span></div><div class="description"><div class="short"><p>The class that is added to the content target when you set styleHtmlContent to true.
180 Defaults to 'x-html'</p>
181 </div><div class="long"><p>The class that is added to the content target when you set styleHtmlContent to true.
182 Defaults to 'x-html'</p>
183 </div></div></div><h4 class="cfgGroup">Other Configs</h4><div id="config-activeError" class="member f inherited"><a href="Ext.form.field.Checkbox.html#config-activeError" rel="config-activeError" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-activeError" class="viewSource">view source</a></div><a name="activeError"></a><a name="config-activeError"></a><a href="Ext.form.field.Checkbox.html#" rel="config-activeError" class="cls expand">activeError</a><span> : String</span></div><div class="description"><div class="short">If specified, then the component will be displayed with this value as its active error when
184 first rendered. Defaults ...</div><div class="long"><p>If specified, then the component will be displayed with this value as its active error when
185 first rendered. Defaults to undefined. Use <a href="Ext.form.field.Checkbox.html#setActiveError" rel="Ext.form.field.Checkbox#setActiveError" class="docClass">setActiveError</a> or <a href="Ext.form.field.Checkbox.html#unsetActiveError" rel="Ext.form.field.Checkbox#unsetActiveError" class="docClass">unsetActiveError</a> to
186 change it after component creation.</p>
187 </div></div></div><div id="config-activeErrorsTpl" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-activeErrorsTpl" rel="config-activeErrorsTpl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-activeErrorsTpl" class="viewSource">view source</a></div><a name="activeErrorsTpl"></a><a name="config-activeErrorsTpl"></a><a href="Ext.form.field.Checkbox.html#" rel="config-activeErrorsTpl" class="cls expand">activeErrorsTpl</a><span> : Ext.XTemplate</span></div><div class="description"><div class="short">The template used to format the Array of error messages passed to setActiveErrors
188 into a single HTML string. By defau...</div><div class="long"><p>The template used to format the Array of error messages passed to <a href="Ext.form.field.Checkbox.html#setActiveErrors" rel="Ext.form.field.Checkbox#setActiveErrors" class="docClass">setActiveErrors</a>
189 into a single HTML string. By default this renders each message as an item in an unordered list.</p>
190 </div></div></div><div id="config-autoEl" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-autoEl" rel="config-autoEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-autoEl" class="viewSource">view source</a></div><a name="autoEl"></a><a name="config-autoEl"></a><a href="Ext.form.field.Checkbox.html#" rel="config-autoEl" class="cls expand">autoEl</a><span> : Mixed</span></div><div class="description"><div class="short">A tag name or DomHelper spec used to create the Element which will
191 encapsulate this Component.
192
193
194 You do not normally ...</div><div class="long"><p>A tag name or <a href="Ext.core.DomHelper.html" rel="Ext.core.DomHelper" class="docClass">DomHelper</a> spec used to create the <a href="Ext.form.field.Checkbox.html#getEl" rel="Ext.form.field.Checkbox#getEl" class="docClass">Element</a> which will
195 encapsulate this Component.</p>
196
197
198 <p>You do not normally need to specify this. For the base classes <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> and <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a>,
199 this defaults to <b><tt>'div'</tt></b>. The more complex Sencha classes use a more complex
200 DOM structure specified by their own <a href="Ext.form.field.Checkbox.html#renderTpl" rel="Ext.form.field.Checkbox#renderTpl" class="docClass">renderTpl</a>s.</p>
201
202
203 <p>This is intended to allow the developer to create application-specific utility Components encapsulated by
204 different DOM elements. Example usage:</p>
205
206
207 <pre><code>{
208     xtype: 'component',
209     autoEl: {
210         tag: 'img',
211         src: 'http://www.example.com/example.jpg'
212     }
213 }, {
214     xtype: 'component',
215     autoEl: {
216         tag: 'blockquote',
217         html: 'autoEl is cool!'
218     }
219 }, {
220     xtype: 'container',
221     autoEl: 'ul',
222     cls: 'ux-unordered-list',
223     items: {
224         xtype: 'component',
225         autoEl: 'li',
226         html: 'First list item'
227     }
228 }
229 </code></pre>
230
231 </div></div></div><div id="config-autoFitErrors" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-autoFitErrors" rel="config-autoFitErrors" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-autoFitErrors" class="viewSource">view source</a></div><a name="autoFitErrors"></a><a name="config-autoFitErrors"></a><a href="Ext.form.field.Checkbox.html#" rel="config-autoFitErrors" class="cls expand">autoFitErrors</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Whether to adjust the component's body area to make room for 'side' or 'under'
232 <a href="Ext.form.field.Checkbox.html#msgTarget" rel="Ext.form.field.Checkbox#msgTarget" class="docClass">error messages</a>. Defaults to <tt>true</tt>.</p>
233 </div><div class="long"><p>Whether to adjust the component's body area to make room for 'side' or 'under'
234 <a href="Ext.form.field.Checkbox.html#msgTarget" rel="Ext.form.field.Checkbox#msgTarget" class="docClass">error messages</a>. Defaults to <tt>true</tt>.</p>
235 </div></div></div><div id="config-autoRender" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-autoRender" rel="config-autoRender" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-autoRender" class="viewSource">view source</a></div><a name="autoRender"></a><a name="config-autoRender"></a><a href="Ext.form.field.Checkbox.html#" rel="config-autoRender" class="cls expand">autoRender</a><span> : Mixed</span></div><div class="description"><div class="short">This config is intended mainly for floating Components which may or may not be shown. Instead
236 of using renderTo in th...</div><div class="long"><p>This config is intended mainly for <a href="Ext.form.field.Checkbox.html#floating" rel="Ext.form.field.Checkbox#floating" class="docClass">floating</a> Components which may or may not be shown. Instead
237 of using <a href="Ext.form.field.Checkbox.html#renderTo" rel="Ext.form.field.Checkbox#renderTo" class="docClass">renderTo</a> in the configuration, and rendering upon construction, this allows a Component
238 to render itself upon first <i><a href="Ext.form.field.Checkbox.html#show" rel="Ext.form.field.Checkbox#show" class="docClass">show</a></i>.</p>
239
240
241 <p>Specify as <code>true</code> to have this Component render to the document body upon first show.</p>
242
243
244 <p>Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.</p>
245
246
247 <p><b>This defaults to <code>true</code> for the <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Window</a> class.</b></p>
248
249 </div></div></div><div id="config-autoScroll" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-autoScroll" rel="config-autoScroll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-autoScroll" class="viewSource">view source</a></div><a name="autoScroll"></a><a name="config-autoScroll"></a><a href="Ext.form.field.Checkbox.html#" rel="config-autoScroll" class="cls expand">autoScroll</a><span> : Boolean</span></div><div class="description"><div class="short">true to use overflow:'auto' on the components layout element and show scroll bars automatically when
250 necessary, false...</div><div class="long"><p><code>true</code> to use overflow:'auto' on the components layout element and show scroll bars automatically when
251 necessary, <code>false</code> to clip any overflowing content (defaults to <code>false</code>).</p>
252 </div></div></div><div id="config-autoShow" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-autoShow" rel="config-autoShow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-autoShow" class="viewSource">view source</a></div><a name="autoShow"></a><a name="config-autoShow"></a><a href="Ext.form.field.Checkbox.html#" rel="config-autoShow" class="cls expand">autoShow</a><span> : Boolean</span></div><div class="description"><div class="short">True to automatically show the component upon creation.
253 This config option may only be used for floating components o...</div><div class="long"><p>True to automatically show the component upon creation.
254 This config option may only be used for <a href="Ext.form.field.Checkbox.html#floating" rel="Ext.form.field.Checkbox#floating" class="docClass">floating</a> components or components
255 that use <a href="Ext.form.field.Checkbox.html#autoRender" rel="Ext.form.field.Checkbox#autoRender" class="docClass">autoRender</a>. Defaults to <tt>false</tt>.</p>
256 </div></div></div><div id="config-baseBodyCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-baseBodyCls" rel="config-baseBodyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-baseBodyCls" class="viewSource">view source</a></div><a name="baseBodyCls"></a><a name="config-baseBodyCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-baseBodyCls" class="cls expand">baseBodyCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'.</p>
257 </div><div class="long"><p>The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'.</p>
258 </div></div></div><div id="config-baseCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-baseCls" rel="config-baseCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-baseCls" class="viewSource">view source</a></div><a name="baseCls"></a><a name="config-baseCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-baseCls" class="cls expand">baseCls</a><span> : String</span></div><div class="description"><div class="short">The base CSS class to apply to this components's element. This will also be prepended to
259 elements within this compone...</div><div class="long"><p>The base CSS class to apply to this components's element. This will also be prepended to
260 elements within this component like Panel's body will get a class x-panel-body. This means
261 that if you create a subclass of Panel, and you want it to get all the Panels styling for the
262 element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this
263 component.</p>
264 </div></div></div><div id="config-border" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-border" rel="config-border" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-border" class="viewSource">view source</a></div><a name="border"></a><a name="config-border"></a><a href="Ext.form.field.Checkbox.html#" rel="config-border" class="cls expand">border</a><span> : Number/String</span></div><div class="description"><div class="short">Specifies the border for this component. The border can be a single numeric value to apply to all sides or
265 it can be ...</div><div class="long"><p>Specifies the border for this component. The border can be a single numeric value to apply to all sides or
266 it can be a CSS style specification for each style, for example: '10 5 3 10'.</p>
267 </div></div></div><div id="config-boxLabel" class="member ni"><a href="Ext.form.field.Checkbox.html#config-boxLabel" rel="config-boxLabel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-boxLabel" class="viewSource">view source</a></div><a name="boxLabel"></a><a name="config-boxLabel"></a><a href="Ext.form.field.Checkbox.html#" rel="config-boxLabel" class="cls expand">boxLabel</a><span> : String</span></div><div class="description"><div class="short">An optional text label that will appear next to the checkbox. Whether it appears before
268 or after the checkbox is dete...</div><div class="long"><p>An optional text label that will appear next to the checkbox. Whether it appears before
269 or after the checkbox is determined by the <a href="Ext.form.field.Checkbox.html#boxLabelAlign" rel="Ext.form.field.Checkbox#boxLabelAlign" class="docClass">boxLabelAlign</a> config (defaults to after).</p>
270 </div></div></div><div id="config-boxLabelAlign" class="member ni"><a href="Ext.form.field.Checkbox.html#config-boxLabelAlign" rel="config-boxLabelAlign" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-boxLabelAlign" class="viewSource">view source</a></div><a name="boxLabelAlign"></a><a name="config-boxLabelAlign"></a><a href="Ext.form.field.Checkbox.html#" rel="config-boxLabelAlign" class="cls expand">boxLabelAlign</a><span> : String</span></div><div class="description"><div class="short">The position relative to the checkbox where the boxLabel should
271 appear. Recognized values are 'before' and 'after'. D...</div><div class="long"><p>The position relative to the checkbox where the <a href="Ext.form.field.Checkbox.html#boxLabel" rel="Ext.form.field.Checkbox#boxLabel" class="docClass">boxLabel</a> should
272 appear. Recognized values are <tt>'before'</tt> and <tt>'after'</tt>. Defaults to <tt>'after'</tt>.</p>
273 </div></div></div><div id="config-boxLabelCls" class="member ni"><a href="Ext.form.field.Checkbox.html#config-boxLabelCls" rel="config-boxLabelCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-boxLabelCls" class="viewSource">view source</a></div><a name="boxLabelCls"></a><a name="config-boxLabelCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-boxLabelCls" class="cls expand">boxLabelCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the <a href="Ext.form.field.Checkbox.html#boxLabel" rel="Ext.form.field.Checkbox#boxLabel" class="docClass">boxLabel</a> element</p>
274 </div><div class="long"><p>The CSS class to be applied to the <a href="Ext.form.field.Checkbox.html#boxLabel" rel="Ext.form.field.Checkbox#boxLabel" class="docClass">boxLabel</a> element</p>
275 </div></div></div><div id="config-checkChangeBuffer" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-checkChangeBuffer" rel="config-checkChangeBuffer" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-checkChangeBuffer" class="viewSource">view source</a></div><a name="checkChangeBuffer"></a><a name="config-checkChangeBuffer"></a><a href="Ext.form.field.Checkbox.html#" rel="config-checkChangeBuffer" class="cls expand">checkChangeBuffer</a><span> : Number</span></div><div class="description"><div class="short">Defines a timeout in milliseconds for buffering checkChangeEvents that fire in rapid succession.
276 Defaults to 50 milli...</div><div class="long"><p>Defines a timeout in milliseconds for buffering <a href="Ext.form.field.Checkbox.html#checkChangeEvents" rel="Ext.form.field.Checkbox#checkChangeEvents" class="docClass">checkChangeEvents</a> that fire in rapid succession.
277 Defaults to 50 milliseconds.</p>
278 </div></div></div><div id="config-checkChangeEvents" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-checkChangeEvents" rel="config-checkChangeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-checkChangeEvents" class="viewSource">view source</a></div><a name="checkChangeEvents"></a><a name="config-checkChangeEvents"></a><a href="Ext.form.field.Checkbox.html#" rel="config-checkChangeEvents" class="cls expand">checkChangeEvents</a><span> : Array</span></div><div class="description"><div class="short">A list of event names that will be listened for on the field's input element, which
279 will cause the field's value to b...</div><div class="long"><p>A list of event names that will be listened for on the field's <a href="Ext.form.field.Checkbox.html#inputEl" rel="Ext.form.field.Checkbox#inputEl" class="docClass">input element</a>, which
280 will cause the field's value to be checked for changes. If a change is detected, the
281 <a href="Ext.form.field.Checkbox.html#change" rel="Ext.form.field.Checkbox#change" class="docClass">change event</a> will be fired, followed by validation if the <a href="Ext.form.field.Checkbox.html#validateOnChange" rel="Ext.form.field.Checkbox#validateOnChange" class="docClass">validateOnChange</a>
282 option is enabled.</p>
283
284
285 <p>Defaults to <tt>['change', 'propertychange']</tt> in Internet Explorer, and <tt>['change', 'input',
286 'textInput', 'keyup', 'dragdrop']</tt> in other browsers. This catches all the ways that field values
287 can be changed in most supported browsers; the only known exceptions at the time of writing are:</p>
288
289
290 <ul>
291 <li>Safari 3.2 and older: cut/paste in textareas via the context menu, and dragging text into textareas</li>
292 <li>Opera 10 and 11: dragging text into text fields and textareas, and cut via the context menu in text
293 fields and textareas</li>
294 <li>Opera 9: Same as Opera 10 and 11, plus paste from context menu in text fields and textareas</li>
295 </ul>
296
297
298 <p>If you need to guarantee on-the-fly change notifications including these edge cases, you can call the
299 <a href="Ext.form.field.Checkbox.html#checkChange" rel="Ext.form.field.Checkbox#checkChange" class="docClass">checkChange</a> method on a repeating interval, e.g. using <a href="Ext.TaskManager.html" rel="Ext.TaskManager" class="docClass">Ext.TaskManager</a>, or if the field is
300 within a <a href="Ext.form.Panel.html" rel="Ext.form.Panel" class="docClass">Ext.form.Panel</a>, you can use the FormPanel's <a href="Ext.form.Panel.html#pollForChanges" rel="Ext.form.Panel#pollForChanges" class="docClass">Ext.form.Panel.pollForChanges</a>
301 configuration to set up such a task automatically.</p>
302
303 </div></div></div><div id="config-checked" class="member ni"><a href="Ext.form.field.Checkbox.html#config-checked" rel="config-checked" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-checked" class="viewSource">view source</a></div><a name="checked"></a><a name="config-checked"></a><a href="Ext.form.field.Checkbox.html#" rel="config-checked" class="cls expand">checked</a><span> : Boolean</span></div><div class="description"><div class="short"><p><tt>true</tt> if the checkbox should render initially checked (defaults to <tt>false</tt>)</p>
304 </div><div class="long"><p><tt>true</tt> if the checkbox should render initially checked (defaults to <tt>false</tt>)</p>
305 </div></div></div><div id="config-checkedCls" class="member ni"><a href="Ext.form.field.Checkbox.html#config-checkedCls" rel="config-checkedCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-checkedCls" class="viewSource">view source</a></div><a name="checkedCls"></a><a name="config-checkedCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-checkedCls" class="cls expand">checkedCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class added to the component's main element when it is in the checked state.</p>
306 </div><div class="long"><p>The CSS class added to the component's main element when it is in the checked state.</p>
307 </div></div></div><div id="config-clearCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-clearCls" rel="config-clearCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-clearCls" class="viewSource">view source</a></div><a name="clearCls"></a><a name="config-clearCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-clearCls" class="cls expand">clearCls</a><span> : String</span></div><div class="description"><div class="short">The CSS class to be applied to the special clearing div rendered directly after the field
308 contents wrapper to provide...</div><div class="long"><p>The CSS class to be applied to the special clearing div rendered directly after the field
309 contents wrapper to provide field clearing (defaults to <tt>'x-clear'</tt>).</p>
310 </div></div></div><div id="config-cls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-cls" rel="config-cls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-cls" class="viewSource">view source</a></div><a name="cls"></a><a name="config-cls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-cls" class="cls expand">cls</a><span> : String</span></div><div class="description"><div class="short">An optional extra CSS class that will be added to this component's Element (defaults to '').  This can be
311 useful for ...</div><div class="long"><p>An optional extra CSS class that will be added to this component's Element (defaults to '').  This can be
312 useful for adding customized styles to the component or any of its children using standard CSS rules.</p>
313 </div></div></div><div id="config-componentCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-componentCls" rel="config-componentCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-componentCls" class="viewSource">view source</a></div><a name="componentCls"></a><a name="config-componentCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-componentCls" class="cls expand">componentCls</a><span> : String</span></div><div class="description"><div class="short"><p>CSS Class to be added to a components root level element to give distinction to it
314 via styling.</p>
315 </div><div class="long"><p>CSS Class to be added to a components root level element to give distinction to it
316 via styling.</p>
317 </div></div></div><div id="config-componentLayout" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-componentLayout" rel="config-componentLayout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-componentLayout" class="viewSource">view source</a></div><a name="componentLayout"></a><a name="config-componentLayout"></a><a href="Ext.form.field.Checkbox.html#" rel="config-componentLayout" class="cls expand">componentLayout</a><span> : String/Object</span></div><div class="description"><div class="short">The sizing and positioning of a Component's internal Elements is the responsibility of
318 the Component's layout manager...</div><div class="long"><p>The sizing and positioning of a Component's internal Elements is the responsibility of
319 the Component's layout manager which sizes a Component's internal structure in response to the Component being sized.</p>
320
321
322 <p>Generally, developers will not use this configuration as all provided Components which need their internal
323 elements sizing (Such as <a href="Ext.form.field.Base.html" rel="Ext.form.field.Base" class="docClass">input fields</a>) come with their own componentLayout managers.</p>
324
325
326 <p>The <a href="Ext.layout.container.Auto.html" rel="Ext.layout.container.Auto" class="docClass">default layout manager</a> will be used on instances of the base <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> class
327 which simply sizes the Component's encapsulating element to the height and width specified in the <a href="Ext.form.field.Checkbox.html#setSize" rel="Ext.form.field.Checkbox#setSize" class="docClass">setSize</a> method.</p>
328
329 </div></div></div><div id="config-contentEl" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-contentEl" rel="config-contentEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-contentEl" class="viewSource">view source</a></div><a name="contentEl"></a><a name="config-contentEl"></a><a href="Ext.form.field.Checkbox.html#" rel="config-contentEl" class="cls expand">contentEl</a><span> : String</span></div><div class="description"><div class="short">Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
330 for this comp...</div><div class="long"><p>Optional. Specify an existing HTML element, or the <code>id</code> of an existing HTML element to use as the content
331 for this component.</p>
332
333
334 <ul>
335 <li><b>Description</b> :
336 <div class="sub-desc">This config option is used to take an existing HTML element and place it in the layout element
337 of a new component (it simply moves the specified DOM element <i>after the Component is rendered</i> to use as the content.</div></li>
338 <li><b>Notes</b> :
339 <div class="sub-desc">The specified HTML element is appended to the layout element of the component <i>after any configured
340 <a href="Ext.form.field.Checkbox.html#html" rel="Ext.form.field.Checkbox#html" class="docClass">HTML</a> has been inserted</i>, and so the document will not contain this element at the time the <a href="Ext.form.field.Checkbox.html#render" rel="Ext.form.field.Checkbox#render" class="docClass">render</a> event is fired.</div>
341 <div class="sub-desc">The specified HTML element used will not participate in any <code><b><a href="Ext.container.Container.html#layout" rel="Ext.container.Container#layout" class="docClass">layout</a></b></code>
342 scheme that the Component may use. It is just HTML. Layouts operate on child <code><b><a href="Ext.container.Container.html#items" rel="Ext.container.Container#items" class="docClass">items</a></b></code>.</div>
343 <div class="sub-desc">Add either the <code>x-hidden</code> or the <code>x-hide-display</code> CSS class to
344 prevent a brief flicker of the content before it is rendered to the panel.</div></li>
345 </ul>
346
347 </div></div></div><div id="config-data" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-data" rel="config-data" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-data" class="viewSource">view source</a></div><a name="data"></a><a name="config-data"></a><a href="Ext.form.field.Checkbox.html#" rel="config-data" class="cls expand">data</a><span> : Mixed</span></div><div class="description"><div class="short"><p>The initial set of data to apply to the <code><a href="Ext.form.field.Checkbox.html#tpl" rel="Ext.form.field.Checkbox#tpl" class="docClass">tpl</a></code> to
348 update the content area of the Component.</p>
349 </div><div class="long"><p>The initial set of data to apply to the <code><a href="Ext.form.field.Checkbox.html#tpl" rel="Ext.form.field.Checkbox#tpl" class="docClass">tpl</a></code> to
350 update the content area of the Component.</p>
351 </div></div></div><div id="config-dirtyCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-dirtyCls" rel="config-dirtyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-dirtyCls" class="viewSource">view source</a></div><a name="dirtyCls"></a><a name="config-dirtyCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-dirtyCls" class="cls expand">dirtyCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to use when the field value <a href="Ext.form.field.Checkbox.html#isDirty" rel="Ext.form.field.Checkbox#isDirty" class="docClass">is dirty</a>.</p>
352 </div><div class="long"><p>The CSS class to use when the field value <a href="Ext.form.field.Checkbox.html#isDirty" rel="Ext.form.field.Checkbox#isDirty" class="docClass">is dirty</a>.</p>
353 </div></div></div><div id="config-disabled" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-disabled" rel="config-disabled" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-cfg-disabled" class="viewSource">view source</a></div><a name="disabled"></a><a name="config-disabled"></a><a href="Ext.form.field.Checkbox.html#" rel="config-disabled" class="cls expand">disabled</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to disable the field (defaults to false). Disabled Fields will not be
354 <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submitted</a>.</p></p>
355 </div><div class="long"><p>True to disable the field (defaults to false). Disabled Fields will not be
356 <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submitted</a>.</p></p>
357 </div></div></div><div id="config-disabledCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-disabledCls" rel="config-disabledCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-disabledCls" class="viewSource">view source</a></div><a name="disabledCls"></a><a name="config-disabledCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-disabledCls" class="cls expand">disabledCls</a><span> : String</span></div><div class="description"><div class="short"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
358 </div><div class="long"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
359 </div></div></div><div id="config-draggable" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-draggable" rel="config-draggable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-draggable" class="viewSource">view source</a></div><a name="draggable"></a><a name="config-draggable"></a><a href="Ext.form.field.Checkbox.html#" rel="config-draggable" class="cls expand">draggable</a><span> : Mixed</span></div><div class="description"><div class="short">Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle...</div><div class="long"><p>Specify as true to make a <a href="Ext.form.field.Checkbox.html#floating" rel="Ext.form.field.Checkbox#floating" class="docClass">floating</a> Component draggable using the Component's encapsulating element as the drag handle.</p>
360
361
362 <p>This may also be specified as a config object for the <a href="Ext.util.ComponentDragger.html" rel="Ext.util.ComponentDragger" class="docClass">ComponentDragger</a> which is instantiated to perform dragging.</p>
363
364
365 <p>For example to create a Component which may only be dragged around using a certain internal element as the drag handle,
366 use the delegate option:</p>
367
368
369 <p><code></p>
370
371 <pre>new Ext.Component({
372     constrain: true,
373     floating:true,
374     style: {
375         backgroundColor: '#fff',
376         border: '1px solid black'
377     },
378     html: '&lt;h1 style="cursor:move"&gt;The title&lt;/h1&gt;&lt;p&gt;The content&lt;/p&gt;',
379     draggable: {
380         delegate: 'h1'
381     }
382 }).show();
383 </pre>
384
385
386 <p></code></p>
387 </div></div></div><div id="config-errorMsgCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-errorMsgCls" rel="config-errorMsgCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-errorMsgCls" class="viewSource">view source</a></div><a name="errorMsgCls"></a><a name="config-errorMsgCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-errorMsgCls" class="cls expand">errorMsgCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'.</p>
388 </div><div class="long"><p>The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'.</p>
389 </div></div></div><div id="config-fieldBodyCls" class="member ni"><a href="Ext.form.field.Checkbox.html#config-fieldBodyCls" rel="config-fieldBodyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-fieldBodyCls" class="viewSource">view source</a></div><a name="fieldBodyCls"></a><a name="config-fieldBodyCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-fieldBodyCls" class="cls expand">fieldBodyCls</a><span> : String</span></div><div class="description"><div class="short"><p>An extra CSS class to be applied to the body content element in addition to <a href="Ext.form.field.Checkbox.html#fieldBodyCls" rel="Ext.form.field.Checkbox#fieldBodyCls" class="docClass">fieldBodyCls</a>.
390 Defaults to 'x-form-cb-wrap.</p>
391 </div><div class="long"><p>An extra CSS class to be applied to the body content element in addition to <a href="Ext.form.field.Checkbox.html#fieldBodyCls" rel="Ext.form.field.Checkbox#fieldBodyCls" class="docClass">fieldBodyCls</a>.
392 Defaults to 'x-form-cb-wrap.</p>
393 </div></div></div><div id="config-fieldCls" class="member ni"><a href="Ext.form.field.Checkbox.html#config-fieldCls" rel="config-fieldCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-fieldCls" class="viewSource">view source</a></div><a name="fieldCls"></a><a name="config-fieldCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-fieldCls" class="cls expand">fieldCls</a><span> : String</span></div><div class="description"><div class="short"><p>The default CSS class for the checkbox (defaults to <tt>'x-form-field'</tt>)</p>
394 </div><div class="long"><p>The default CSS class for the checkbox (defaults to <tt>'x-form-field'</tt>)</p>
395 </div></div></div><div id="config-fieldLabel" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-fieldLabel" rel="config-fieldLabel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-fieldLabel" class="viewSource">view source</a></div><a name="fieldLabel"></a><a name="config-fieldLabel"></a><a href="Ext.form.field.Checkbox.html#" rel="config-fieldLabel" class="cls expand">fieldLabel</a><span> : String</span></div><div class="description"><div class="short">The label for the field. It gets appended with the labelSeparator, and its position
396 and sizing is determined by the l...</div><div class="long"><p>The label for the field. It gets appended with the <a href="Ext.form.field.Checkbox.html#labelSeparator" rel="Ext.form.field.Checkbox#labelSeparator" class="docClass">labelSeparator</a>, and its position
397 and sizing is determined by the <a href="Ext.form.field.Checkbox.html#labelAlign" rel="Ext.form.field.Checkbox#labelAlign" class="docClass">labelAlign</a>, <a href="Ext.form.field.Checkbox.html#labelWidth" rel="Ext.form.field.Checkbox#labelWidth" class="docClass">labelWidth</a>, and <a href="Ext.form.field.Checkbox.html#labelPad" rel="Ext.form.field.Checkbox#labelPad" class="docClass">labelPad</a>
398 configs. Defaults to undefined.</p>
399 </div></div></div><div id="config-fieldStyle" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-fieldStyle" rel="config-fieldStyle" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-fieldStyle" class="viewSource">view source</a></div><a name="fieldStyle"></a><a name="config-fieldStyle"></a><a href="Ext.form.field.Checkbox.html#" rel="config-fieldStyle" class="cls expand">fieldStyle</a><span> : String</span></div><div class="description"><div class="short">Optional CSS style(s) to be applied to the field input element.
400 Should be a valid argument to Ext.core.Element.applyS...</div><div class="long"><p>Optional CSS style(s) to be applied to the <a href="Ext.form.field.Checkbox.html#inputEl" rel="Ext.form.field.Checkbox#inputEl" class="docClass">field input element</a>.
401 Should be a valid argument to <a href="Ext.core.Element.html#applyStyles" rel="Ext.core.Element#applyStyles" class="docClass">Ext.core.Element.applyStyles</a>. Defaults to undefined. See also the
402 <a href="Ext.form.field.Checkbox.html#setFieldStyle" rel="Ext.form.field.Checkbox#setFieldStyle" class="docClass">setFieldStyle</a> method for changing the style after initialization.</p>
403 </div></div></div><div id="config-floating" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-floating" rel="config-floating" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-floating" class="viewSource">view source</a></div><a name="floating"></a><a name="config-floating"></a><a href="Ext.form.field.Checkbox.html#" rel="config-floating" class="cls expand">floating</a><span> : Boolean</span></div><div class="description"><div class="short">Specify as true to float the Component outside of the document flow using CSS absolute positioning.
404
405
406 Components such...</div><div class="long"><p>Specify as true to float the Component outside of the document flow using CSS absolute positioning.</p>
407
408
409 <p>Components such as <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Window</a>s and <a href="Ext.menu.Menu.html" rel="Ext.menu.Menu" class="docClass">Menu</a>s are floating
410 by default.</p>
411
412
413 <p>Floating Components that are programatically <a href="Ext.Component.html#render" rel="Ext.Component#render" class="docClass">rendered</a> will register themselves with the global
414 <a href="Ext.WindowManager.html" rel="Ext.WindowManager" class="docClass">ZIndexManager</a></p>
415
416
417 <h3 class="pa">Floating Components as child items of a Container</h3>
418
419
420 <p>A floating Component may be used as a child item of a Container. This just allows the floating Component to seek a ZIndexManager by
421 examining the ownerCt chain.</p>
422
423
424 <p>When configured as floating, Components acquire, at render time, a <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">ZIndexManager</a> which manages a stack
425 of related floating Components. The ZIndexManager brings a single floating Component to the top of its stack when
426 the Component's <a href="Ext.form.field.Checkbox.html#toFront" rel="Ext.form.field.Checkbox#toFront" class="docClass">toFront</a> method is called.</p>
427
428
429 <p>The ZIndexManager is found by traversing up the <a href="Ext.form.field.Checkbox.html#ownerCt" rel="Ext.form.field.Checkbox#ownerCt" class="docClass">ownerCt</a> chain to find an ancestor which itself is floating. This is so that
430 descendant floating Components of floating <i>Containers</i> (Such as a ComboBox dropdown within a Window) can have its zIndex managed relative
431 to any siblings, but always <b>above</b> that floating ancestor Container.</p>
432
433
434 <p>If no floating ancestor is found, a floating Component registers itself with the default <a href="Ext.WindowManager.html" rel="Ext.WindowManager" class="docClass">ZIndexManager</a>.</p>
435
436
437 <p>Floating components <i>do not participate in the Container's layout</i>. Because of this, they are not rendered until you explicitly
438 <a href="Ext.form.field.Checkbox.html#show" rel="Ext.form.field.Checkbox#show" class="docClass">show</a> them.</p>
439
440
441 <p>After rendering, the ownerCt reference is deleted, and the <a href="Ext.form.field.Checkbox.html#floatParent" rel="Ext.form.field.Checkbox#floatParent" class="docClass">floatParent</a> property is set to the found floating ancestor Container.
442 If no floating ancestor Container was found the <a href="Ext.form.field.Checkbox.html#floatParent" rel="Ext.form.field.Checkbox#floatParent" class="docClass">floatParent</a> property will not be set.</p>
443
444 </div></div></div><div id="config-focusCls" class="member ni"><a href="Ext.form.field.Checkbox.html#config-focusCls" rel="config-focusCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-focusCls" class="viewSource">view source</a></div><a name="focusCls"></a><a name="config-focusCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-focusCls" class="cls expand">focusCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to use when the checkbox receives focus
445 (defaults to <tt>'x-form-cb-focus'</tt>)</p>
446 </div><div class="long"><p>The CSS class to use when the checkbox receives focus
447 (defaults to <tt>'x-form-cb-focus'</tt>)</p>
448 </div></div></div><div id="config-focusOnToFront" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-focusOnToFront" rel="config-focusOnToFront" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-cfg-focusOnToFront" class="viewSource">view source</a></div><a name="focusOnToFront"></a><a name="config-focusOnToFront"></a><a href="Ext.form.field.Checkbox.html#" rel="config-focusOnToFront" class="cls expand">focusOnToFront</a><span> : Boolean</span></div><div class="description"><div class="short">Specifies whether the floated component should be automatically focused when it is
449 brought to the front. Defaults to ...</div><div class="long"><p>Specifies whether the floated component should be automatically <a href="Ext.form.field.Checkbox.html#focus" rel="Ext.form.field.Checkbox#focus" class="docClass">focused</a> when it is
450 <a href="Ext.form.field.Checkbox.html#toFront" rel="Ext.form.field.Checkbox#toFront" class="docClass">brought to the front</a>. Defaults to true.</p>
451 </div></div></div><div id="config-formItemCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-formItemCls" rel="config-formItemCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-formItemCls" class="viewSource">view source</a></div><a name="formItemCls"></a><a name="config-formItemCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-formItemCls" class="cls expand">formItemCls</a><span> : String</span></div><div class="description"><div class="short">A CSS class to be applied to the outermost element to denote that it is participating in the form
452 field layout. Defau...</div><div class="long"><p>A CSS class to be applied to the outermost element to denote that it is participating in the form
453 field layout. Defaults to 'x-form-item'.</p>
454 </div></div></div><div id="config-frame" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-frame" rel="config-frame" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-frame" class="viewSource">view source</a></div><a name="frame"></a><a name="config-frame"></a><a href="Ext.form.field.Checkbox.html#" rel="config-frame" class="cls expand">frame</a><span> : Boolean</span></div><div class="description"><div class="short">Specify as true to have the Component inject framing elements within the Component at render time to
455 provide a graphi...</div><div class="long"><p>Specify as <code>true</code> to have the Component inject framing elements within the Component at render time to
456 provide a graphical rounded frame around the Component content.</p>
457
458
459 <p>This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet Explorer
460 prior to version 9 which do not support rounded corners natively.</p>
461
462
463 <p>The extra space taken up by this framing is available from the read only property <a href="Ext.form.field.Checkbox.html#frameSize" rel="Ext.form.field.Checkbox#frameSize" class="docClass">frameSize</a>.</p>
464
465 </div></div></div><div id="config-handler" class="member ni"><a href="Ext.form.field.Checkbox.html#config-handler" rel="config-handler" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-handler" class="viewSource">view source</a></div><a name="handler"></a><a name="config-handler"></a><a href="Ext.form.field.Checkbox.html#" rel="config-handler" class="cls expand">handler</a><span> : Function</span></div><div class="description"><div class="short">A function called when the checked value changes (can be used instead of
466 handling the change event). The handler is p...</div><div class="long"><p>A function called when the <a href="Ext.form.field.Checkbox.html#checked" rel="Ext.form.field.Checkbox#checked" class="docClass">checked</a> value changes (can be used instead of
467 handling the <a href="Ext.form.field.Checkbox.html#change" rel="Ext.form.field.Checkbox#change" class="docClass">change event</a>). The handler is passed the following parameters:</p>
468
469 <div class="mdetail-params"><ul>
470 <li><b>checkbox</b> : Ext.form.field.Checkbox<div class="sub-desc">The Checkbox being toggled.</div></li>
471 <li><b>checked</b> : Boolean<div class="sub-desc">The new checked state of the checkbox.</div></li>
472 </ul></div>
473
474 </div></div></div><div id="config-height" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-height" rel="config-height" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-height" class="viewSource">view source</a></div><a name="height"></a><a name="config-height"></a><a href="Ext.form.field.Checkbox.html#" rel="config-height" class="cls expand">height</a><span> : Number</span></div><div class="description"><div class="short"><p>The height of this component in pixels.</p>
475 </div><div class="long"><p>The height of this component in pixels.</p>
476 </div></div></div><div id="config-hidden" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-hidden" rel="config-hidden" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-hidden" class="viewSource">view source</a></div><a name="hidden"></a><a name="config-hidden"></a><a href="Ext.form.field.Checkbox.html#" rel="config-hidden" class="cls expand">hidden</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Defaults to false.</p>
477 </div><div class="long"><p>Defaults to false.</p>
478 </div></div></div><div id="config-hideEmptyLabel" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-hideEmptyLabel" rel="config-hideEmptyLabel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-hideEmptyLabel" class="viewSource">view source</a></div><a name="hideEmptyLabel"></a><a name="config-hideEmptyLabel"></a><a href="Ext.form.field.Checkbox.html#" rel="config-hideEmptyLabel" class="cls expand">hideEmptyLabel</a><span> : Boolean</span></div><div class="description"><div class="short">When set to true, the label element (fieldLabel and labelSeparator) will be
479 automatically hidden if the fieldLabel is...</div><div class="long"><p>When set to <tt>true</tt>, the label element (<a href="Ext.form.field.Checkbox.html#fieldLabel" rel="Ext.form.field.Checkbox#fieldLabel" class="docClass">fieldLabel</a> and <a href="Ext.form.field.Checkbox.html#labelSeparator" rel="Ext.form.field.Checkbox#labelSeparator" class="docClass">labelSeparator</a>) will be
480 automatically hidden if the <a href="Ext.form.field.Checkbox.html#fieldLabel" rel="Ext.form.field.Checkbox#fieldLabel" class="docClass">fieldLabel</a> is empty. Setting this to <tt>false</tt> will cause the empty
481 label element to be rendered and space to be reserved for it; this is useful if you want a field without a label
482 to line up with other labeled fields in the same form. Defaults to <tt>true</tt>.</p>
483
484
485 <p>If you wish to unconditionall hide the label even if a non-empty fieldLabel is configured, then set
486 the <a href="Ext.form.field.Checkbox.html#hideLabel" rel="Ext.form.field.Checkbox#hideLabel" class="docClass">hideLabel</a> config to <tt>true</tt>.</p>
487
488 </div></div></div><div id="config-hideLabel" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-hideLabel" rel="config-hideLabel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-hideLabel" class="viewSource">view source</a></div><a name="hideLabel"></a><a name="config-hideLabel"></a><a href="Ext.form.field.Checkbox.html#" rel="config-hideLabel" class="cls expand">hideLabel</a><span> : Boolean</span></div><div class="description"><div class="short">Set to true to completely hide the label element (fieldLabel and labelSeparator).
489 Defaults to false.
490
491
492 Also see hideE...</div><div class="long"><p>Set to <tt>true</tt> to completely hide the label element (<a href="Ext.form.field.Checkbox.html#fieldLabel" rel="Ext.form.field.Checkbox#fieldLabel" class="docClass">fieldLabel</a> and <a href="Ext.form.field.Checkbox.html#labelSeparator" rel="Ext.form.field.Checkbox#labelSeparator" class="docClass">labelSeparator</a>).
493 Defaults to <tt>false</tt>.</p>
494
495
496 <p>Also see <a href="Ext.form.field.Checkbox.html#hideEmptyLabel" rel="Ext.form.field.Checkbox#hideEmptyLabel" class="docClass">hideEmptyLabel</a>, which controls whether space will be reserved for an empty fieldLabel.</p>
497
498 </div></div></div><div id="config-hideMode" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-hideMode" rel="config-hideMode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-hideMode" class="viewSource">view source</a></div><a name="hideMode"></a><a name="config-hideMode"></a><a href="Ext.form.field.Checkbox.html#" rel="config-hideMode" class="cls expand">hideMode</a><span> : String</span></div><div class="description"><div class="short">A String which specifies how this Component's encapsulating DOM element will be hidden.
499 Values may be
500 'display' : The...</div><div class="long"><p>A String which specifies how this Component's encapsulating DOM element will be hidden.
501 Values may be<div class="mdetail-params"><ul>
502 <li><code>'display'</code> : The Component will be hidden using the <code>display: none</code> style.</li>
503 <li><code>'visibility'</code> : The Component will be hidden using the <code>visibility: hidden</code> style.</li>
504 <li><code>'offsets'</code> : The Component will be hidden by absolutely positioning it out of the visible area of the document. This
505 is useful when a hidden Component must maintain measurable dimensions. Hiding using <code>display</code> results
506 in a Component having zero dimensions.</li></ul></div>
507 Defaults to <code>'display'</code>.</p>
508 </div></div></div><div id="config-html" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-html" rel="config-html" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-html" class="viewSource">view source</a></div><a name="html"></a><a name="config-html"></a><a href="Ext.form.field.Checkbox.html#" rel="config-html" class="cls expand">html</a><span> : String/Object</span></div><div class="description"><div class="short">An HTML fragment, or a DomHelper specification to use as the layout element
509 content (defaults to ''). The HTML conten...</div><div class="long"><p>An HTML fragment, or a <a href="Ext.core.DomHelper.html" rel="Ext.core.DomHelper" class="docClass">DomHelper</a> specification to use as the layout element
510 content (defaults to ''). The HTML content is added after the component is rendered,
511 so the document will not contain this HTML at the time the <a href="Ext.form.field.Checkbox.html#render" rel="Ext.form.field.Checkbox#render" class="docClass">render</a> event is fired.
512 This content is inserted into the body <i>before</i> any configured <a href="Ext.form.field.Checkbox.html#contentEl" rel="Ext.form.field.Checkbox#contentEl" class="docClass">contentEl</a> is appended.</p>
513 </div></div></div><div id="config-id" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-id" rel="config-id" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-id" class="viewSource">view source</a></div><a name="id"></a><a name="config-id"></a><a href="Ext.form.field.Checkbox.html#" rel="config-id" class="cls expand">id</a><span> : String</span></div><div class="description"><div class="short">The unique id of this component instance (defaults to an auto-assigned id).
514
515
516 It should not be necessary to use this ...</div><div class="long"><p>The <b><u>unique id of this component instance</u></b> (defaults to an <a href="Ext.form.field.Checkbox.html#getId" rel="Ext.form.field.Checkbox#getId" class="docClass">auto-assigned id</a>).</p>
517
518
519 <p>It should not be necessary to use this configuration except for singleton objects in your application.
520 Components created with an id may be accessed globally using <a href="Ext.html#getCmp" rel="Ext#getCmp" class="docClass">Ext.getCmp</a>.</p>
521
522
523 <p>Instead of using assigned ids, use the <a href="Ext.form.field.Checkbox.html#itemId" rel="Ext.form.field.Checkbox#itemId" class="docClass">itemId</a> config, and <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> which
524 provides selector-based searching for Sencha Components analogous to DOM querying. The <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a>
525 class contains <a href="Ext.container.Container.html#down" rel="Ext.container.Container#down" class="docClass">shortcut methods</a> to query its descendant Components by selector.</p>
526
527
528 <p>Note that this id will also be used as the element id for the containing HTML element
529 that is rendered to the page for this component. This allows you to write id-based CSS
530 rules to style the specific instance of this component uniquely, and also to select
531 sub-elements using this component's id as the parent.</p>
532
533
534 <p><b>Note</b>: to avoid complications imposed by a unique <tt>id</tt> also see <code><a href="Ext.form.field.Checkbox.html#itemId" rel="Ext.form.field.Checkbox#itemId" class="docClass">itemId</a></code>.</p>
535
536
537 <p><b>Note</b>: to access the container of a Component see <code><a href="Ext.form.field.Checkbox.html#ownerCt" rel="Ext.form.field.Checkbox#ownerCt" class="docClass">ownerCt</a></code>.</p>
538
539 </div></div></div><div id="config-inputId" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-inputId" rel="config-inputId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-inputId" class="viewSource">view source</a></div><a name="inputId"></a><a name="config-inputId"></a><a href="Ext.form.field.Checkbox.html#" rel="config-inputId" class="cls expand">inputId</a><span> : String</span></div><div class="description"><div class="short">The id that will be given to the generated input DOM element. Defaults to an automatically generated id.
540 If you confi...</div><div class="long"><p>The id that will be given to the generated input DOM element. Defaults to an automatically generated id.
541 If you configure this manually, you must make sure it is unique in the document.</p>
542 </div></div></div><div id="config-inputType" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-inputType" rel="config-inputType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-inputType" class="viewSource">view source</a></div><a name="inputType"></a><a name="config-inputType"></a><a href="Ext.form.field.Checkbox.html#" rel="config-inputType" class="cls expand">inputType</a><span> : String</span></div><div class="description"><div class="short">The type attribute for input fields -- e.g. radio, text, password, file (defaults to 'text').
543 The extended types supp...</div><div class="long"><p>The type attribute for input fields -- e.g. radio, text, password, file (defaults to <tt>'text'</tt>).
544 The extended types supported by HTML5 inputs (url, email, etc.) may also be used, though using them
545 will cause older browsers to fall back to 'text'.</p>
546
547
548 <p>The type 'password' must be used to render that field type currently -- there is no separate <a href="Ext.html" rel="Ext" class="docClass">Ext</a>
549 component for that. You can use <a href="Ext.form.field.File.html" rel="Ext.form.field.File" class="docClass">Ext.form.field.File</a> which creates a custom-rendered file upload
550 field, but if you want a plain unstyled file input you can use a BaseField with inputType:'file'.</p>
551
552 </div></div></div><div id="config-inputValue" class="member ni"><a href="Ext.form.field.Checkbox.html#config-inputValue" rel="config-inputValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-inputValue" class="viewSource">view source</a></div><a name="inputValue"></a><a name="config-inputValue"></a><a href="Ext.form.field.Checkbox.html#" rel="config-inputValue" class="cls expand">inputValue</a><span> : String</span></div><div class="description"><div class="short">The value that should go into the generated input element's value attribute and
553 should be used as the parameter value...</div><div class="long"><p>The value that should go into the generated input element's value attribute and
554 should be used as the parameter value when submitting as part of a form. Defaults to <tt>"on"</tt>.</p>
555 </div></div></div><div id="config-invalidCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-invalidCls" rel="config-invalidCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-invalidCls" class="viewSource">view source</a></div><a name="invalidCls"></a><a name="config-invalidCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-invalidCls" class="cls expand">invalidCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to use when marking the component invalid (defaults to 'x-form-invalid')</p>
556 </div><div class="long"><p>The CSS class to use when marking the component invalid (defaults to 'x-form-invalid')</p>
557 </div></div></div><div id="config-invalidText" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-invalidText" rel="config-invalidText" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-invalidText" class="viewSource">view source</a></div><a name="invalidText"></a><a name="config-invalidText"></a><a href="Ext.form.field.Checkbox.html#" rel="config-invalidText" class="cls expand">invalidText</a><span> : String</span></div><div class="description"><div class="short">The error text to use when marking a field invalid and no message is provided
558 (defaults to 'The value in this field i...</div><div class="long"><p>The error text to use when marking a field invalid and no message is provided
559 (defaults to 'The value in this field is invalid')</p>
560 </div></div></div><div id="config-itemId" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-itemId" rel="config-itemId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-itemId" class="viewSource">view source</a></div><a name="itemId"></a><a name="config-itemId"></a><a href="Ext.form.field.Checkbox.html#" rel="config-itemId" class="cls expand">itemId</a><span> : String</span></div><div class="description"><div class="short">An itemId can be used as an alternative way to get a reference to a component
561 when no object reference is available. ...</div><div class="long"><p>An <tt>itemId</tt> can be used as an alternative way to get a reference to a component
562 when no object reference is available.  Instead of using an <code><a href="Ext.form.field.Checkbox.html#id" rel="Ext.form.field.Checkbox#id" class="docClass">id</a></code> with
563 <a href="Ext.html" rel="Ext" class="docClass">Ext</a>.<a href="Ext.html#getCmp" rel="Ext#getCmp" class="docClass">getCmp</a>, use <code>itemId</code> with
564 <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a>.<a href="Ext.container.Container.html#getComponent" rel="Ext.container.Container#getComponent" class="docClass">getComponent</a> which will retrieve
565 <code>itemId</code>'s or <tt><a href="Ext.form.field.Checkbox.html#id" rel="Ext.form.field.Checkbox#id" class="docClass">id</a></tt>'s. Since <code>itemId</code>'s are an index to the
566 container's internal MixedCollection, the <code>itemId</code> is scoped locally to the container --
567 avoiding potential conflicts with <a href="Ext.ComponentManager.html" rel="Ext.ComponentManager" class="docClass">Ext.ComponentManager</a> which requires a <b>unique</b>
568 <code><a href="Ext.form.field.Checkbox.html#id" rel="Ext.form.field.Checkbox#id" class="docClass">id</a></code>.</p>
569
570
571 <pre><code>var c = new Ext.panel.Panel({ //
572     <a href="Ext.Component.html#height" rel="Ext.Component#height" class="docClass">height</a>: 300,
573     <a href="Ext.form.field.Checkbox.html#renderTo" rel="Ext.form.field.Checkbox#renderTo" class="docClass">renderTo</a>: document.body,
574     <a href="Ext.container.Container.html#layout" rel="Ext.container.Container#layout" class="docClass">layout</a>: 'auto',
575     <a href="Ext.container.Container.html#items" rel="Ext.container.Container#items" class="docClass">items</a>: [
576         {
577             itemId: 'p1',
578             <a href="Ext.panel.Panel.html#title" rel="Ext.panel.Panel#title" class="docClass">title</a>: 'Panel 1',
579             <a href="Ext.Component.html#height" rel="Ext.Component#height" class="docClass">height</a>: 150
580         },
581         {
582             itemId: 'p2',
583             <a href="Ext.panel.Panel.html#title" rel="Ext.panel.Panel#title" class="docClass">title</a>: 'Panel 2',
584             <a href="Ext.Component.html#height" rel="Ext.Component#height" class="docClass">height</a>: 150
585         }
586     ]
587 })
588 p1 = c.<a href="Ext.container.Container.html#getComponent" rel="Ext.container.Container#getComponent" class="docClass">getComponent</a>('p1'); // not the same as <a href="Ext.html#getCmp" rel="Ext#getCmp" class="docClass">Ext.getCmp()</a>
589 p2 = p1.<a href="Ext.form.field.Checkbox.html#ownerCt" rel="Ext.form.field.Checkbox#ownerCt" class="docClass">ownerCt</a>.<a href="Ext.container.Container.html#getComponent" rel="Ext.container.Container#getComponent" class="docClass">getComponent</a>('p2'); // reference via a sibling
590 </code></pre>
591
592
593 <p>Also see <tt><a href="Ext.form.field.Checkbox.html#id" rel="Ext.form.field.Checkbox#id" class="docClass">id</a></tt>, <code><a href="Ext.form.field.Checkbox.html#query" rel="Ext.form.field.Checkbox#query" class="docClass">query</a></code>, <code><a href="Ext.form.field.Checkbox.html#down" rel="Ext.form.field.Checkbox#down" class="docClass">down</a></code> and <code><a href="Ext.form.field.Checkbox.html#child" rel="Ext.form.field.Checkbox#child" class="docClass">child</a></code>.</p>
594
595
596 <p><b>Note</b>: to access the container of an item see <tt><a href="Ext.form.field.Checkbox.html#ownerCt" rel="Ext.form.field.Checkbox#ownerCt" class="docClass">ownerCt</a></tt>.</p>
597
598 </div></div></div><div id="config-labelAlign" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-labelAlign" rel="config-labelAlign" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelAlign" class="viewSource">view source</a></div><a name="labelAlign"></a><a name="config-labelAlign"></a><a href="Ext.form.field.Checkbox.html#" rel="config-labelAlign" class="cls expand">labelAlign</a><span> : String</span></div><div class="description"><div class="short">Controls the position and alignment of the fieldLabel. Valid values are:
599
600
601
602 "left" (the default) - The label is posit...</div><div class="long"><p>Controls the position and alignment of the <a href="Ext.form.field.Checkbox.html#fieldLabel" rel="Ext.form.field.Checkbox#fieldLabel" class="docClass">fieldLabel</a>. Valid values are:</p>
603
604
605 <ul>
606 <li><tt>"left"</tt> (the default) - The label is positioned to the left of the field, with its text
607 aligned to the left. Its width is determined by the <a href="Ext.form.field.Checkbox.html#labelWidth" rel="Ext.form.field.Checkbox#labelWidth" class="docClass">labelWidth</a> config.</li>
608 <li><tt>"top"</tt> - The label is positioned above the field.</li>
609 <li><tt>"right"</tt> - The label is positioned to the left of the field, with its text aligned
610 to the right. Its width is determined by the <a href="Ext.form.field.Checkbox.html#labelWidth" rel="Ext.form.field.Checkbox#labelWidth" class="docClass">labelWidth</a> config.</li>
611 </ul>
612
613 </div></div></div><div id="config-labelCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-labelCls" rel="config-labelCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelCls" class="viewSource">view source</a></div><a name="labelCls"></a><a name="config-labelCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-labelCls" class="cls expand">labelCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the label element. Defaults to 'x-form-item-label'.</p>
614 </div><div class="long"><p>The CSS class to be applied to the label element. Defaults to 'x-form-item-label'.</p>
615 </div></div></div><div id="config-labelPad" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-labelPad" rel="config-labelPad" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelPad" class="viewSource">view source</a></div><a name="labelPad"></a><a name="config-labelPad"></a><a href="Ext.form.field.Checkbox.html#" rel="config-labelPad" class="cls expand">labelPad</a><span> : Number</span></div><div class="description"><div class="short"><p>The amount of space in pixels between the <a href="Ext.form.field.Checkbox.html#fieldLabel" rel="Ext.form.field.Checkbox#fieldLabel" class="docClass">fieldLabel</a> and the input field. Defaults to <tt>5</tt>.</p>
616 </div><div class="long"><p>The amount of space in pixels between the <a href="Ext.form.field.Checkbox.html#fieldLabel" rel="Ext.form.field.Checkbox#fieldLabel" class="docClass">fieldLabel</a> and the input field. Defaults to <tt>5</tt>.</p>
617 </div></div></div><div id="config-labelSeparator" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-labelSeparator" rel="config-labelSeparator" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelSeparator" class="viewSource">view source</a></div><a name="labelSeparator"></a><a name="config-labelSeparator"></a><a href="Ext.form.field.Checkbox.html#" rel="config-labelSeparator" class="cls expand">labelSeparator</a><span> : String</span></div><div class="description"><div class="short"><p>Character(s) to be inserted at the end of the <a href="Ext.form.field.Checkbox.html#fieldLabel" rel="Ext.form.field.Checkbox#fieldLabel" class="docClass">label text</a>.</p>
618 </div><div class="long"><p>Character(s) to be inserted at the end of the <a href="Ext.form.field.Checkbox.html#fieldLabel" rel="Ext.form.field.Checkbox#fieldLabel" class="docClass">label text</a>.</p>
619 </div></div></div><div id="config-labelStyle" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-labelStyle" rel="config-labelStyle" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelStyle" class="viewSource">view source</a></div><a name="labelStyle"></a><a name="config-labelStyle"></a><a href="Ext.form.field.Checkbox.html#" rel="config-labelStyle" class="cls expand">labelStyle</a><span> : String</span></div><div class="description"><div class="short"><p>A CSS style specification string to apply directly to this field's label. Defaults to undefined.</p>
620
621 </div><div class="long"><p>A CSS style specification string to apply directly to this field's label. Defaults to undefined.</p>
622
623 </div></div></div><div id="config-labelWidth" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-labelWidth" rel="config-labelWidth" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelWidth" class="viewSource">view source</a></div><a name="labelWidth"></a><a name="config-labelWidth"></a><a href="Ext.form.field.Checkbox.html#" rel="config-labelWidth" class="cls expand">labelWidth</a><span> : Number</span></div><div class="description"><div class="short"><p>The width of the <a href="Ext.form.field.Checkbox.html#fieldLabel" rel="Ext.form.field.Checkbox#fieldLabel" class="docClass">fieldLabel</a> in pixels. Only applicable if the <a href="Ext.form.field.Checkbox.html#labelAlign" rel="Ext.form.field.Checkbox#labelAlign" class="docClass">labelAlign</a> is set
624 to "left" or "right". Defaults to <tt>100</tt>.</p>
625 </div><div class="long"><p>The width of the <a href="Ext.form.field.Checkbox.html#fieldLabel" rel="Ext.form.field.Checkbox#fieldLabel" class="docClass">fieldLabel</a> in pixels. Only applicable if the <a href="Ext.form.field.Checkbox.html#labelAlign" rel="Ext.form.field.Checkbox#labelAlign" class="docClass">labelAlign</a> is set
626 to "left" or "right". Defaults to <tt>100</tt>.</p>
627 </div></div></div><div id="config-labelableRenderTpl" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-labelableRenderTpl" rel="config-labelableRenderTpl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelableRenderTpl" class="viewSource">view source</a></div><a name="labelableRenderTpl"></a><a name="config-labelableRenderTpl"></a><a href="Ext.form.field.Checkbox.html#" rel="config-labelableRenderTpl" class="cls expand">labelableRenderTpl</a><span> : Array/String/Ext.XTemplate</span></div><div class="description"><div class="short">The rendering template for the field decorations. Component classes using this mixin should include
628 logic to use this...</div><div class="long"><p>The rendering template for the field decorations. Component classes using this mixin should include
629 logic to use this as their <a href="Ext.AbstractComponent.html#renderTpl" rel="Ext.AbstractComponent#renderTpl" class="docClass">renderTpl</a>, and implement the
630 <a href="Ext.form.field.Checkbox.html#getSubTplMarkup" rel="Ext.form.field.Checkbox#getSubTplMarkup" class="docClass">getSubTplMarkup</a> method to generate the field body content.</p>
631 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.form.field.Checkbox.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
632 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
633 object during initialization.  This should be a valid listeners config object as specified in the
634 <a href="Ext.form.field.Checkbox.html#addListener" rel="Ext.form.field.Checkbox#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
635
636 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
637
638
639 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
640
641
642 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
643 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
644 events directly from a child element of a Component, we need to specify the <code>element</code> option to
645 identify the Component property to add a DOM listener to:</p>
646
647 <pre><code>new Ext.panel.Panel({
648     width: 400,
649     height: 200,
650     dockedItems: [{
651         xtype: 'toolbar'
652     }],
653     listeners: {
654         click: {
655             element: 'el', //bind to the underlying el property on the panel
656             fn: function(){ console.log('click el'); }
657         },
658         dblclick: {
659             element: 'body', //bind to the underlying body property on the panel
660             fn: function(){ console.log('dblclick body'); }
661         }
662     }
663 });
664 </code></pre>
665
666
667 <p></p></p>
668 </div></div></div><div id="config-loader" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-loader" rel="config-loader" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-loader" class="viewSource">view source</a></div><a name="loader"></a><a name="config-loader"></a><a href="Ext.form.field.Checkbox.html#" rel="config-loader" class="cls expand">loader</a><span> : Ext.ComponentLoader/Object</span></div><div class="description"><div class="short"><p>A configuration object or an instance of a <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> to load remote
669 content for this Component.</p>
670 </div><div class="long"><p>A configuration object or an instance of a <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> to load remote
671 content for this Component.</p>
672 </div></div></div><div id="config-maintainFlex" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-maintainFlex" rel="config-maintainFlex" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-maintainFlex" class="viewSource">view source</a></div><a name="maintainFlex"></a><a name="config-maintainFlex"></a><a href="Ext.form.field.Checkbox.html#" rel="config-maintainFlex" class="cls expand">maintainFlex</a><span> : Boolean</span></div><div class="description"><div class="short">Only valid when a sibling element of a Splitter within a VBox or
673 HBox layout.
674
675
676 Specifies that if an immediate siblin...</div><div class="long"><p><b>Only valid when a sibling element of a <a href="Ext.resizer.Splitter.html" rel="Ext.resizer.Splitter" class="docClass">Splitter</a> within a <a href="Ext.layout.container.VBox.html" rel="Ext.layout.container.VBox" class="docClass">VBox</a> or
677 <a href="Ext.layout.container.HBox.html" rel="Ext.layout.container.HBox" class="docClass">HBox</a> layout.</b></p>
678
679
680 <p>Specifies that if an immediate sibling Splitter is moved, the Component on the <i>other</i> side is resized, and this
681 Component maintains its configured <a href="Ext.layout.container.Box.html#flex" rel="Ext.layout.container.Box#flex" class="docClass">flex</a> value.</p>
682
683 </div></div></div><div id="config-margin" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-margin" rel="config-margin" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-margin" class="viewSource">view source</a></div><a name="margin"></a><a name="config-margin"></a><a href="Ext.form.field.Checkbox.html#" rel="config-margin" class="cls expand">margin</a><span> : Number/String</span></div><div class="description"><div class="short">Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or
684 it can be ...</div><div class="long"><p>Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or
685 it can be a CSS style specification for each style, for example: '10 5 3 10'.</p>
686 </div></div></div><div id="config-maxHeight" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-maxHeight" rel="config-maxHeight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-maxHeight" class="viewSource">view source</a></div><a name="maxHeight"></a><a name="config-maxHeight"></a><a href="Ext.form.field.Checkbox.html#" rel="config-maxHeight" class="cls expand">maxHeight</a><span> : Number</span></div><div class="description"><div class="short">The maximum value in pixels which this Component will set its height to.
687
688
689 Warning: This will override any size manag...</div><div class="long"><p>The maximum value in pixels which this Component will set its height to.</p>
690
691
692 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
693
694 </div></div></div><div id="config-maxWidth" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-maxWidth" rel="config-maxWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-maxWidth" class="viewSource">view source</a></div><a name="maxWidth"></a><a name="config-maxWidth"></a><a href="Ext.form.field.Checkbox.html#" rel="config-maxWidth" class="cls expand">maxWidth</a><span> : Number</span></div><div class="description"><div class="short">The maximum value in pixels which this Component will set its width to.
695
696
697 Warning: This will override any size manage...</div><div class="long"><p>The maximum value in pixels which this Component will set its width to.</p>
698
699
700 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
701
702 </div></div></div><div id="config-minHeight" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-minHeight" rel="config-minHeight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-minHeight" class="viewSource">view source</a></div><a name="minHeight"></a><a name="config-minHeight"></a><a href="Ext.form.field.Checkbox.html#" rel="config-minHeight" class="cls expand">minHeight</a><span> : Number</span></div><div class="description"><div class="short">The minimum value in pixels which this Component will set its height to.
703
704
705 Warning: This will override any size manag...</div><div class="long"><p>The minimum value in pixels which this Component will set its height to.</p>
706
707
708 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
709
710 </div></div></div><div id="config-minWidth" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-minWidth" rel="config-minWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-minWidth" class="viewSource">view source</a></div><a name="minWidth"></a><a name="config-minWidth"></a><a href="Ext.form.field.Checkbox.html#" rel="config-minWidth" class="cls expand">minWidth</a><span> : Number</span></div><div class="description"><div class="short">The minimum value in pixels which this Component will set its width to.
711
712
713 Warning: This will override any size manage...</div><div class="long"><p>The minimum value in pixels which this Component will set its width to.</p>
714
715
716 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
717
718 </div></div></div><div id="config-msgTarget" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-msgTarget" rel="config-msgTarget" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-msgTarget" class="viewSource">view source</a></div><a name="msgTarget"></a><a name="config-msgTarget"></a><a href="Ext.form.field.Checkbox.html#" rel="config-msgTarget" class="cls expand">msgTarget</a><span> : String</span></div><div class="description"><div class="short">The location where the error message text should display.
719 Must be one of the following values:
720
721
722
723 qtip Display a quic...</div><div class="long"><p>The location where the error message text should display.
724 Must be one of the following values:</p>
725
726
727 <div class="mdetail-params"><ul>
728 <li><code>qtip</code> Display a quick tip containing the message when the user hovers over the field. This is the default.
729 <div class="subdesc"><b><a href="Ext.tip.QuickTipManager.html#init" rel="Ext.tip.QuickTipManager#init" class="docClass">Ext.tip.QuickTipManager.init</a> must have been called for this setting to work.</b></div></li>
730 <li><code>title</code> Display the message in a default browser title attribute popup.</li>
731 <li><code>under</code> Add a block div beneath the field containing the error message.</li>
732 <li><code>side</code> Add an error icon to the right of the field, displaying the message in a popup on hover.</li>
733 <li><code>none</code> Don't display any error message. This might be useful if you are implementing custom error display.</li>
734 <li><code>[element id]</code> Add the error message directly to the innerHTML of the specified element.</li>
735 </ul></div>
736
737 </div></div></div><div id="config-name" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-name" rel="config-name" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-cfg-name" class="viewSource">view source</a></div><a name="name"></a><a name="config-name"></a><a href="Ext.form.field.Checkbox.html#" rel="config-name" class="cls expand">name</a><span> : String</span></div><div class="description"><div class="short">The name of the field (defaults to undefined). By default this is used as the parameter
738 name when including the field...</div><div class="long"><p>The name of the field (defaults to undefined). By default this is used as the parameter
739 name when including the <a href="Ext.form.field.Checkbox.html#getSubmitData" rel="Ext.form.field.Checkbox#getSubmitData" class="docClass">field value</a> in a <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">form submit()</a>.
740 To prevent the field from being included in the form submit, set <a href="Ext.form.field.Checkbox.html#submitValue" rel="Ext.form.field.Checkbox#submitValue" class="docClass">submitValue</a> to <tt>false</tt>.</p>
741 </div></div></div><div id="config-overCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-overCls" rel="config-overCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-overCls" class="viewSource">view source</a></div><a name="overCls"></a><a name="config-overCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-overCls" class="cls expand">overCls</a><span> : String</span></div><div class="description"><div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves
742 over the Element, and...</div><div class="long"><p>An optional extra CSS class that will be added to this component's Element when the mouse moves
743 over the Element, and removed when the mouse moves out. (defaults to '').  This can be
744 useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.</p>
745 </div></div></div><div id="config-padding" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-padding" rel="config-padding" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-padding" class="viewSource">view source</a></div><a name="padding"></a><a name="config-padding"></a><a href="Ext.form.field.Checkbox.html#" rel="config-padding" class="cls expand">padding</a><span> : Number/String</span></div><div class="description"><div class="short">Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or
746 it can b...</div><div class="long"><p>Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or
747 it can be a CSS style specification for each style, for example: '10 5 3 10'.</p>
748 </div></div></div><div id="config-plugins" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-plugins" rel="config-plugins" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-plugins" class="viewSource">view source</a></div><a name="plugins"></a><a name="config-plugins"></a><a href="Ext.form.field.Checkbox.html#" rel="config-plugins" class="cls expand">plugins</a><span> : Object/Array</span></div><div class="description"><div class="short">An object or array of objects that will provide custom functionality for this component.  The only
749 requirement for a ...</div><div class="long"><p>An object or array of objects that will provide custom functionality for this component.  The only
750 requirement for a valid plugin is that it contain an init method that accepts a reference of type <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a>.
751 When a component is created, if any plugins are available, the component will call the init method on each
752 plugin, passing a reference to itself.  Each plugin can then call methods or respond to events on the
753 component as needed to provide its functionality.</p>
754 </div></div></div><div id="config-preventMark" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-preventMark" rel="config-preventMark" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-preventMark" class="viewSource">view source</a></div><a name="preventMark"></a><a name="config-preventMark"></a><a href="Ext.form.field.Checkbox.html#" rel="config-preventMark" class="cls expand">preventMark</a><span> : Boolean</span></div><div class="description"><div class="short"><p><tt>true</tt> to disable displaying any <a href="Ext.form.field.Checkbox.html#setActiveError" rel="Ext.form.field.Checkbox#setActiveError" class="docClass">error message</a> set on this object.
755 Defaults to <tt>false</tt>.</p>
756 </div><div class="long"><p><tt>true</tt> to disable displaying any <a href="Ext.form.field.Checkbox.html#setActiveError" rel="Ext.form.field.Checkbox#setActiveError" class="docClass">error message</a> set on this object.
757 Defaults to <tt>false</tt>.</p>
758 </div></div></div><div id="config-readOnly" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-readOnly" rel="config-readOnly" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-readOnly" class="viewSource">view source</a></div><a name="readOnly"></a><a name="config-readOnly"></a><a href="Ext.form.field.Checkbox.html#" rel="config-readOnly" class="cls expand">readOnly</a><span> : Boolean</span></div><div class="description"><div class="short">true to mark the field as readOnly in HTML
759 (defaults to false).
760
761 Note: this only sets the element's readOnly DOM attr...</div><div class="long"><p><tt>true</tt> to mark the field as readOnly in HTML
762 (defaults to <tt>false</tt>).</p>
763
764 <br><p><b>Note</b>: this only sets the element's readOnly DOM attribute.
765
766
767 <p>Setting <code>readOnly=true</code>, for example, will not disable triggering a
768 ComboBox or Date; it gives you the option of forcing the user to choose
769 via the trigger without typing in the text box. To hide the trigger use
770 <code><a href="Ext.form.field.Trigger.html#hideTrigger" rel="Ext.form.field.Trigger#hideTrigger" class="docClass">hideTrigger</a></code>.</p></p>
771 </div></div></div><div id="config-readOnlyCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-readOnlyCls" rel="config-readOnlyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-readOnlyCls" class="viewSource">view source</a></div><a name="readOnlyCls"></a><a name="config-readOnlyCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-readOnlyCls" class="cls expand">readOnlyCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class applied to the component's main element when it is <a href="Ext.form.field.Checkbox.html#readOnly" rel="Ext.form.field.Checkbox#readOnly" class="docClass">readOnly</a>.</p>
772 </div><div class="long"><p>The CSS class applied to the component's main element when it is <a href="Ext.form.field.Checkbox.html#readOnly" rel="Ext.form.field.Checkbox#readOnly" class="docClass">readOnly</a>.</p>
773 </div></div></div><div id="config-renderSelectors" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-renderSelectors" rel="config-renderSelectors" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-renderSelectors" class="viewSource">view source</a></div><a name="renderSelectors"></a><a name="config-renderSelectors"></a><a href="Ext.form.field.Checkbox.html#" rel="config-renderSelectors" class="cls expand">renderSelectors</a><span> : Object</span></div><div class="description"><div class="short">An object containing properties specifying DomQuery selectors which identify child elements
774 created by the render pro...</div><div class="long"><p>An object containing properties specifying <a href="Ext.DomQuery.html" rel="Ext.DomQuery" class="docClass">DomQuery</a> selectors which identify child elements
775 created by the render process.</p>
776
777 <p>After the Component's internal structure is rendered according to the <a href="Ext.form.field.Checkbox.html#renderTpl" rel="Ext.form.field.Checkbox#renderTpl" class="docClass">renderTpl</a>, this object is iterated through,
778 and the found Elements are added as properties to the Component using the <code>renderSelector</code> property name.</p>
779
780 <p>For example, a Component which rendered an image, and description into its element might use the following properties
781 coded into its prototype:</p>
782
783 <pre><code>renderTpl: '&amp;lt;img src="{imageUrl}" class="x-image-component-img"&gt;&amp;lt;div class="x-image-component-desc"&gt;{description}&amp;gt;/div&amp;lt;',
784
785 renderSelectors: {
786     image: 'img.x-image-component-img',
787     descEl: 'div.x-image-component-desc'
788 }
789 </code></pre>
790
791 <p>After rendering, the Component would have a property <code>image</code> referencing its child <code>img</code> Element,
792 and a property <code>descEl</code> referencing the <code>div</code> Element which contains the description.</p>
793 </div></div></div><div id="config-renderTo" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-renderTo" rel="config-renderTo" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-renderTo" class="viewSource">view source</a></div><a name="renderTo"></a><a name="config-renderTo"></a><a href="Ext.form.field.Checkbox.html#" rel="config-renderTo" class="cls expand">renderTo</a><span> : Mixed</span></div><div class="description"><div class="short">Specify the id of the element, a DOM element or an existing Element that this component
794 will be rendered into.
795
796
797
798 Not...</div><div class="long"><p>Specify the id of the element, a DOM element or an existing Element that this component
799 will be rendered into.</p>
800
801
802 <div><ul>
803 <li><b>Notes</b> : <ul>
804 <div class="sub-desc">Do <u>not</u> use this option if the Component is to be a child item of
805 a <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a>. It is the responsibility of the
806 <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a>'s <a href="Ext.container.Container.html#layout" rel="Ext.container.Container#layout" class="docClass">layout manager</a>
807 to render and manage its child items.</div>
808 <div class="sub-desc">When using this config, a call to render() is not required.</div>
809 </ul></li>
810 </ul></div>
811
812
813 <p>See <code><a href="Ext.form.field.Checkbox.html#render" rel="Ext.form.field.Checkbox#render" class="docClass">render</a></code> also.</p>
814
815 </div></div></div><div id="config-renderTpl" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-renderTpl" rel="config-renderTpl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-renderTpl" class="viewSource">view source</a></div><a name="renderTpl"></a><a name="config-renderTpl"></a><a href="Ext.form.field.Checkbox.html#" rel="config-renderTpl" class="cls expand">renderTpl</a><span> : Mixed</span></div><div class="description"><div class="short">An XTemplate used to create the internal structure inside this Component's
816 encapsulating Element.
817
818
819 You do not normal...</div><div class="long"><p>An <a href="Ext.XTemplate.html" rel="Ext.XTemplate" class="docClass">XTemplate</a> used to create the internal structure inside this Component's
820 encapsulating <a href="Ext.form.field.Checkbox.html#getEl" rel="Ext.form.field.Checkbox#getEl" class="docClass">Element</a>.</p>
821
822
823 <p>You do not normally need to specify this. For the base classes <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a>
824 and <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a>, this defaults to <b><code>null</code></b> which means that they will be initially rendered
825 with no internal structure; they render their <a href="Ext.form.field.Checkbox.html#getEl" rel="Ext.form.field.Checkbox#getEl" class="docClass">Element</a> empty. The more specialized ExtJS and Touch classes
826 which use a more complex DOM structure, provide their own template definitions.</p>
827
828
829 <p>This is intended to allow the developer to create application-specific utility Components with customized
830 internal structure.</p>
831
832
833 <p>Upon rendering, any created child elements may be automatically imported into object properties using the
834 <a href="Ext.form.field.Checkbox.html#renderSelectors" rel="Ext.form.field.Checkbox#renderSelectors" class="docClass">renderSelectors</a> option.</p>
835
836 </div></div></div><div id="config-resizable" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-resizable" rel="config-resizable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-resizable" class="viewSource">view source</a></div><a name="resizable"></a><a name="config-resizable"></a><a href="Ext.form.field.Checkbox.html#" rel="config-resizable" class="cls expand">resizable</a><span> : Mixed</span></div><div class="description"><div class="short">Specify as true to apply a Resizer to this Component
837 after rendering.
838
839
840 May also be specified as a config object to b...</div><div class="long"><p>Specify as <code>true</code> to apply a <a href="Ext.resizer.Resizer.html" rel="Ext.resizer.Resizer" class="docClass">Resizer</a> to this Component
841 after rendering.</p>
842
843
844 <p>May also be specified as a config object to be passed to the constructor of <a href="Ext.resizer.Resizer.html" rel="Ext.resizer.Resizer" class="docClass">Resizer</a>
845 to override any defaults. By default the Component passes its minimum and maximum size, and uses
846 <code><a href="Ext.resizer.Resizer.html#dynamic" rel="Ext.resizer.Resizer#dynamic" class="docClass">Ext.resizer.Resizer.dynamic</a>: false</code></p>
847
848 </div></div></div><div id="config-resizeHandles" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-resizeHandles" rel="config-resizeHandles" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-resizeHandles" class="viewSource">view source</a></div><a name="resizeHandles"></a><a name="config-resizeHandles"></a><a href="Ext.form.field.Checkbox.html#" rel="config-resizeHandles" class="cls expand">resizeHandles</a><span> : String</span></div><div class="description"><div class="short"><p>A valid <a href="Ext.resizer.Resizer.html" rel="Ext.resizer.Resizer" class="docClass">Ext.resizer.Resizer</a> handles config string (defaults to 'all').  Only applies when resizable = true.</p>
849 </div><div class="long"><p>A valid <a href="Ext.resizer.Resizer.html" rel="Ext.resizer.Resizer" class="docClass">Ext.resizer.Resizer</a> handles config string (defaults to 'all').  Only applies when resizable = true.</p>
850 </div></div></div><div id="config-saveBuffer" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-saveBuffer" rel="config-saveBuffer" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-cfg-saveBuffer" class="viewSource">view source</a></div><a name="saveBuffer"></a><a name="config-saveBuffer"></a><a href="Ext.form.field.Checkbox.html#" rel="config-saveBuffer" class="cls expand">saveBuffer</a><span> : Number</span></div><div class="description"><div class="short"><p>A buffer to be applied if many state events are fired within
851 a short period. Defaults to 100.</p>
852 </div><div class="long"><p>A buffer to be applied if many state events are fired within
853 a short period. Defaults to 100.</p>
854 </div></div></div><div id="config-scope" class="member ni"><a href="Ext.form.field.Checkbox.html#config-scope" rel="config-scope" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-scope" class="viewSource">view source</a></div><a name="scope"></a><a name="config-scope"></a><a href="Ext.form.field.Checkbox.html#" rel="config-scope" class="cls expand">scope</a><span> : Object</span></div><div class="description"><div class="short"><p>An object to use as the scope ('this' reference) of the <a href="Ext.form.field.Checkbox.html#handler" rel="Ext.form.field.Checkbox#handler" class="docClass">handler</a> function
855 (defaults to this Checkbox).</p>
856 </div><div class="long"><p>An object to use as the scope ('this' reference) of the <a href="Ext.form.field.Checkbox.html#handler" rel="Ext.form.field.Checkbox#handler" class="docClass">handler</a> function
857 (defaults to this Checkbox).</p>
858 </div></div></div><div id="config-shadow" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-shadow" rel="config-shadow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-cfg-shadow" class="viewSource">view source</a></div><a name="shadow"></a><a name="config-shadow"></a><a href="Ext.form.field.Checkbox.html#" rel="config-shadow" class="cls expand">shadow</a><span> : String/Boolean</span></div><div class="description"><div class="short">Specifies whether the floating component should be given a shadow. Set to
859 true to automatically create an Ext.Shadow,...</div><div class="long"><p>Specifies whether the floating component should be given a shadow. Set to
860 <tt>true</tt> to automatically create an <a href="Ext.Shadow.html" rel="Ext.Shadow" class="docClass">Ext.Shadow</a>, or a string indicating the
861 shadow's display <a href="Ext.Shadow.html#mode" rel="Ext.Shadow#mode" class="docClass">Ext.Shadow.mode</a>. Set to <tt>false</tt> to disable the shadow.
862 (Defaults to <tt>'sides'</tt>.)</p>
863 </div></div></div><div id="config-stateEvents" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-stateEvents" rel="config-stateEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-cfg-stateEvents" class="viewSource">view source</a></div><a name="stateEvents"></a><a name="config-stateEvents"></a><a href="Ext.form.field.Checkbox.html#" rel="config-stateEvents" class="cls expand">stateEvents</a><span> : Array</span></div><div class="description"><div class="short">An array of events that, when fired, should trigger this object to
864 save its state (defaults to none). stateEvents may...</div><div class="long"><p>An array of events that, when fired, should trigger this object to
865 save its state (defaults to none). <code>stateEvents</code> may be any type
866 of event supported by this object, including browser or custom events
867 (e.g., <tt>['click', 'customerchange']</tt>).</p>
868
869
870 <p>See <code><a href="Ext.form.field.Checkbox.html#stateful" rel="Ext.form.field.Checkbox#stateful" class="docClass">stateful</a></code> for an explanation of saving and
871 restoring object state.</p>
872
873 </div></div></div><div id="config-stateId" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-stateId" rel="config-stateId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-cfg-stateId" class="viewSource">view source</a></div><a name="stateId"></a><a name="config-stateId"></a><a href="Ext.form.field.Checkbox.html#" rel="config-stateId" class="cls expand">stateId</a><span> : String</span></div><div class="description"><div class="short">The unique id for this object to use for state management purposes.
874
875 See stateful for an explanation of saving and re...</div><div class="long"><p>The unique id for this object to use for state management purposes.</p>
876
877 <p>See <a href="Ext.form.field.Checkbox.html#stateful" rel="Ext.form.field.Checkbox#stateful" class="docClass">stateful</a> for an explanation of saving and restoring state.</p>
878
879 </div></div></div><div id="config-stateful" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-stateful" rel="config-stateful" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-cfg-stateful" class="viewSource">view source</a></div><a name="stateful"></a><a name="config-stateful"></a><a href="Ext.form.field.Checkbox.html#" rel="config-stateful" class="cls expand">stateful</a><span> : Boolean</span></div><div class="description"><div class="short">A flag which causes the object to attempt to restore the state of
880 internal properties from a saved state on startup. ...</div><div class="long"><p>A flag which causes the object to attempt to restore the state of
881 internal properties from a saved state on startup. The object must have
882 a <code><a href="Ext.form.field.Checkbox.html#stateId" rel="Ext.form.field.Checkbox#stateId" class="docClass">stateId</a></code> for state to be managed. 
883 Auto-generated ids are not guaranteed to be stable across page loads and 
884 cannot be relied upon to save and restore the same state for a object.<p>
885 <p>For state saving to work, the state manager's provider must have been
886 set to an implementation of <a href="Ext.state.Provider.html" rel="Ext.state.Provider" class="docClass">Ext.state.Provider</a> which overrides the
887 <a href="Ext.state.Provider.html#set" rel="Ext.state.Provider#set" class="docClass">set</a> and <a href="Ext.state.Provider.html#get" rel="Ext.state.Provider#get" class="docClass">get</a>
888 methods to save and recall name/value pairs. A built-in implementation,
889 <a href="Ext.state.CookieProvider.html" rel="Ext.state.CookieProvider" class="docClass">Ext.state.CookieProvider</a> is available.</p>
890 <p>To set the state provider for the current page:</p>
891 <pre><code>Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
892     expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now
893 }));
894 </code></pre>
895 <p>A stateful object attempts to save state when one of the events
896 listed in the <code><a href="Ext.form.field.Checkbox.html#stateEvents" rel="Ext.form.field.Checkbox#stateEvents" class="docClass">stateEvents</a></code> configuration fires.</p>
897 <p>To save state, a stateful object first serializes its state by
898 calling <b><code><a href="Ext.form.field.Checkbox.html#getState" rel="Ext.form.field.Checkbox#getState" class="docClass">getState</a></code></b>. By default, this function does
899 nothing. The developer must provide an implementation which returns an
900 object hash which represents the restorable state of the object.</p>
901 <p>The value yielded by getState is passed to <a href="Ext.state.Manager.html#set" rel="Ext.state.Manager#set" class="docClass">Ext.state.Manager.set</a>
902 which uses the configured <a href="Ext.state.Provider.html" rel="Ext.state.Provider" class="docClass">Ext.state.Provider</a> to save the object
903 keyed by the <code><a href="stateId.html" rel="stateId" class="docClass">stateId</a></code></p>.
904 <p>During construction, a stateful object attempts to <i>restore</i>
905 its state by calling <a href="Ext.state.Manager.html#get" rel="Ext.state.Manager#get" class="docClass">Ext.state.Manager.get</a> passing the
906 <code><a href="Ext.form.field.Checkbox.html#stateId" rel="Ext.form.field.Checkbox#stateId" class="docClass">stateId</a></code></p>
907 <p>The resulting object is passed to <b><code><a href="Ext.form.field.Checkbox.html#applyState" rel="Ext.form.field.Checkbox#applyState" class="docClass">applyState</a></code></b>.
908 The default implementation of <code><a href="Ext.form.field.Checkbox.html#applyState" rel="Ext.form.field.Checkbox#applyState" class="docClass">applyState</a></code> simply copies
909 properties into the object, but a developer may override this to support
910 more behaviour.</p>
911 <p>You can perform extra processing on state save and restore by attaching
912 handlers to the <a href="Ext.form.field.Checkbox.html#beforestaterestore" rel="Ext.form.field.Checkbox#beforestaterestore" class="docClass">beforestaterestore</a>, <a href="Ext.form.field.Checkbox.html#staterestore" rel="Ext.form.field.Checkbox#staterestore" class="docClass">staterestore</a>,
913 <a href="Ext.form.field.Checkbox.html#beforestatesave" rel="Ext.form.field.Checkbox#beforestatesave" class="docClass">beforestatesave</a> and <a href="Ext.form.field.Checkbox.html#statesave" rel="Ext.form.field.Checkbox#statesave" class="docClass">statesave</a> events.</p>
914
915 </div></div></div><div id="config-style" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-style" rel="config-style" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-style" class="viewSource">view source</a></div><a name="style"></a><a name="config-style"></a><a href="Ext.form.field.Checkbox.html#" rel="config-style" class="cls expand">style</a><span> : String</span></div><div class="description"><div class="short">A custom style specification to be applied to this component's Element.  Should be a valid argument to
916 Ext.core.Eleme...</div><div class="long"><p>A custom style specification to be applied to this component's Element.  Should be a valid argument to
917 <a href="Ext.core.Element.html#applyStyles" rel="Ext.core.Element#applyStyles" class="docClass">Ext.core.Element.applyStyles</a>.</p>
918
919 <pre><code>        new Ext.panel.Panel({
920             title: 'Some Title',
921             renderTo: Ext.getBody(),
922             width: 400, height: 300,
923             layout: 'form',
924             items: [{
925                 xtype: 'textarea',
926                 style: {
927                     width: '95%',
928                     marginBottom: '10px'
929                 }
930             },
931             new Ext.button.Button({
932                 text: 'Send',
933                 minWidth: '100',
934                 style: {
935                     marginBottom: '10px'
936                 }
937             })
938             ]
939         });
940      </code></pre>
941
942 </div></div></div><div id="config-styleHtmlCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-styleHtmlCls" rel="config-styleHtmlCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlCls" class="viewSource">view source</a></div><a name="styleHtmlCls"></a><a name="config-styleHtmlCls"></a><a href="Ext.form.field.Checkbox.html#" rel="config-styleHtmlCls" class="cls expand">styleHtmlCls</a><span> : String</span></div><div class="description"><div class="short"><p>The class that is added to the content target when you set styleHtmlContent to true.
943 Defaults to 'x-html'</p>
944 </div><div class="long"><p>The class that is added to the content target when you set styleHtmlContent to true.
945 Defaults to 'x-html'</p>
946 </div></div></div><div id="config-styleHtmlContent" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-styleHtmlContent" rel="config-styleHtmlContent" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlContent" class="viewSource">view source</a></div><a name="styleHtmlContent"></a><a name="config-styleHtmlContent"></a><a href="Ext.form.field.Checkbox.html#" rel="config-styleHtmlContent" class="cls expand">styleHtmlContent</a><span> : String</span></div><div class="description"><div class="short"><p>True to automatically style the html inside the content target of this component (body for panels).
947 Defaults to false.</p>
948 </div><div class="long"><p>True to automatically style the html inside the content target of this component (body for panels).
949 Defaults to false.</p>
950 </div></div></div><div id="config-submitValue" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-submitValue" rel="config-submitValue" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-cfg-submitValue" class="viewSource">view source</a></div><a name="submitValue"></a><a name="config-submitValue"></a><a href="Ext.form.field.Checkbox.html#" rel="config-submitValue" class="cls expand">submitValue</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Setting this to <tt>false</tt> will prevent the field from being
951 <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submitted</a> even when it is not disabled. Defaults to <tt>true</tt>.</p>
952 </div><div class="long"><p>Setting this to <tt>false</tt> will prevent the field from being
953 <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submitted</a> even when it is not disabled. Defaults to <tt>true</tt>.</p>
954 </div></div></div><div id="config-tabIndex" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-tabIndex" rel="config-tabIndex" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-tabIndex" class="viewSource">view source</a></div><a name="tabIndex"></a><a name="config-tabIndex"></a><a href="Ext.form.field.Checkbox.html#" rel="config-tabIndex" class="cls expand">tabIndex</a><span> : Number</span></div><div class="description"><div class="short">The tabIndex for this field. Note this only applies to fields that are rendered,
955 not those which are built via applyT...</div><div class="long"><p>The tabIndex for this field. Note this only applies to fields that are rendered,
956 not those which are built via applyTo (defaults to undefined).</p>
957 </div></div></div><div id="config-toFrontOnShow" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-toFrontOnShow" rel="config-toFrontOnShow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-toFrontOnShow" class="viewSource">view source</a></div><a name="toFrontOnShow"></a><a name="config-toFrontOnShow"></a><a href="Ext.form.field.Checkbox.html#" rel="config-toFrontOnShow" class="cls expand">toFrontOnShow</a><span> : Boolean</span></div><div class="description"><div class="short">True to automatically call toFront when the show method is called
958 on an already visible, floating component (default ...</div><div class="long"><p>True to automatically call <a href="Ext.form.field.Checkbox.html#toFront" rel="Ext.form.field.Checkbox#toFront" class="docClass">toFront</a> when the <a href="Ext.form.field.Checkbox.html#show" rel="Ext.form.field.Checkbox#show" class="docClass">show</a> method is called
959 on an already visible, floating component (default is <code>true</code>).</p>
960
961 </div></div></div><div id="config-tpl" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-tpl" rel="config-tpl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-tpl" class="viewSource">view source</a></div><a name="tpl"></a><a name="config-tpl"></a><a href="Ext.form.field.Checkbox.html#" rel="config-tpl" class="cls expand">tpl</a><span> : Mixed</span></div><div class="description"><div class="short">An Ext.Template, Ext.XTemplate
962 or an array of strings to form an Ext.XTemplate.
963 Used in conjunction with the data and...</div><div class="long"><p>An <bold><a href="Ext.Template.html" rel="Ext.Template" class="docClass">Ext.Template</a></bold>, <bold><a href="Ext.XTemplate.html" rel="Ext.XTemplate" class="docClass">Ext.XTemplate</a></bold>
964 or an array of strings to form an <a href="Ext.XTemplate.html" rel="Ext.XTemplate" class="docClass">Ext.XTemplate</a>.
965 Used in conjunction with the <code><a href="Ext.form.field.Checkbox.html#data" rel="Ext.form.field.Checkbox#data" class="docClass">data</a></code> and
966 <code><a href="Ext.form.field.Checkbox.html#tplWriteMode" rel="Ext.form.field.Checkbox#tplWriteMode" class="docClass">tplWriteMode</a></code> configurations.</p>
967 </div></div></div><div id="config-tplWriteMode" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-tplWriteMode" rel="config-tplWriteMode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-tplWriteMode" class="viewSource">view source</a></div><a name="tplWriteMode"></a><a name="config-tplWriteMode"></a><a href="Ext.form.field.Checkbox.html#" rel="config-tplWriteMode" class="cls expand">tplWriteMode</a><span> : String</span></div><div class="description"><div class="short">The Ext.(X)Template method to use when
968 updating the content area of the Component. Defaults to 'overwrite'
969 (see Ext.X...</div><div class="long"><p>The Ext.(X)Template method to use when
970 updating the content area of the Component. Defaults to <code>'overwrite'</code>
971 (see <code><a href="Ext.XTemplate.html#overwrite" rel="Ext.XTemplate#overwrite" class="docClass">Ext.XTemplate.overwrite</a></code>).</p>
972 </div></div></div><div id="config-ui" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-ui" rel="config-ui" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-ui" class="viewSource">view source</a></div><a name="ui"></a><a name="config-ui"></a><a href="Ext.form.field.Checkbox.html#" rel="config-ui" class="cls expand">ui</a><span> : String/Array</span></div><div class="description"><div class="short"><p>A set style for a component. Can be a string or an Array of multiple strings (UIs)</p>
973 </div><div class="long"><p>A set style for a component. Can be a string or an Array of multiple strings (UIs)</p>
974 </div></div></div><div id="config-uncheckedValue" class="member ni"><a href="Ext.form.field.Checkbox.html#config-uncheckedValue" rel="config-uncheckedValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-cfg-uncheckedValue" class="viewSource">view source</a></div><a name="uncheckedValue"></a><a name="config-uncheckedValue"></a><a href="Ext.form.field.Checkbox.html#" rel="config-uncheckedValue" class="cls expand">uncheckedValue</a><span> : String</span></div><div class="description"><div class="short">If configured, this will be submitted as the checkbox's value during form
975 submit if the checkbox is unchecked. By def...</div><div class="long"><p>If configured, this will be submitted as the checkbox's value during form
976 submit if the checkbox is unchecked. By default this is undefined, which results in nothing being
977 submitted for the checkbox field when the form is submitted (the default behavior of HTML checkboxes).</p>
978 </div></div></div><div id="config-validateOnBlur" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-validateOnBlur" rel="config-validateOnBlur" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-validateOnBlur" class="viewSource">view source</a></div><a name="validateOnBlur"></a><a name="config-validateOnBlur"></a><a href="Ext.form.field.Checkbox.html#" rel="config-validateOnBlur" class="cls expand">validateOnBlur</a><span> : Boolean</span></div><div class="description"><div class="short">Whether the field should validate when it loses focus (defaults to true). This will cause fields
979 to be validated as t...</div><div class="long"><p>Whether the field should validate when it loses focus (defaults to <tt>true</tt>). This will cause fields
980 to be validated as the user steps through the fields in the form regardless of whether they are making
981 changes to those fields along the way. See also <a href="Ext.form.field.Checkbox.html#validateOnChange" rel="Ext.form.field.Checkbox#validateOnChange" class="docClass">validateOnChange</a>.</p>
982 </div></div></div><div id="config-validateOnChange" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-validateOnChange" rel="config-validateOnChange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-cfg-validateOnChange" class="viewSource">view source</a></div><a name="validateOnChange"></a><a name="config-validateOnChange"></a><a href="Ext.form.field.Checkbox.html#" rel="config-validateOnChange" class="cls expand">validateOnChange</a><span> : Boolean</span></div><div class="description"><div class="short">Specifies whether this field should be validated immediately whenever a change in its value is detected.
983 Defaults to ...</div><div class="long"><p>Specifies whether this field should be validated immediately whenever a change in its value is detected.
984 Defaults to <tt>true</tt>. If the validation results in a change in the field's validity, a
985 <a href="Ext.form.field.Checkbox.html#validitychange" rel="Ext.form.field.Checkbox#validitychange" class="docClass">validitychange</a> event will be fired. This allows the field to show feedback about the
986 validity of its contents immediately as the user is typing.</p>
987
988
989 <p>When set to <tt>false</tt>, feedback will not be immediate. However the form will still be validated
990 before submitting if the <tt>clientValidation</tt> option to <a href="Ext.form.Basic.html#doAction" rel="Ext.form.Basic#doAction" class="docClass">Ext.form.Basic.doAction</a> is
991 enabled, or if the field or form are validated manually.</p>
992
993
994 <p>See also <a href="Ext.form.field.Base.html#checkChangeEvents" rel="Ext.form.field.Base#checkChangeEvents" class="docClass">Ext.form.field.Base.checkChangeEvents</a>for controlling how changes to the field's value are detected.</p>
995
996 </div></div></div><div id="config-value" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-value" rel="config-value" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-cfg-value" class="viewSource">view source</a></div><a name="value"></a><a name="config-value"></a><a href="Ext.form.field.Checkbox.html#" rel="config-value" class="cls expand">value</a><span> : Mixed</span></div><div class="description"><div class="short"><p>A value to initialize this field with (defaults to undefined).</p>
997 </div><div class="long"><p>A value to initialize this field with (defaults to undefined).</p>
998 </div></div></div><div id="config-width" class="member inherited"><a href="Ext.form.field.Checkbox.html#config-width" rel="config-width" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-width" class="viewSource">view source</a></div><a name="width"></a><a name="config-width"></a><a href="Ext.form.field.Checkbox.html#" rel="config-width" class="cls expand">width</a><span> : Number</span></div><div class="description"><div class="short"><p>The width of this component in pixels.</p>
999 </div><div class="long"><p>The width of this component in pixels.</p>
1000 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-bodyEl" class="member f inherited"><a href="Ext.form.field.Checkbox.html#property-bodyEl" rel="property-bodyEl" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-property-bodyEl" class="viewSource">view source</a></div><a name="bodyEl"></a><a name="property-bodyEl"></a><a href="Ext.form.field.Checkbox.html#" rel="property-bodyEl" class="cls expand">bodyEl</a><span> : Ext.core.Element</span></div><div class="description"><div class="short"><p>The div Element wrapping the component's contents. Only available after the component has been rendered.</p>
1001 </div><div class="long"><p>The div Element wrapping the component's contents. Only available after the component has been rendered.</p>
1002 </div></div></div><div id="property-boxLabelEl" class="member ni"><a href="Ext.form.field.Checkbox.html#property-boxLabelEl" rel="property-boxLabelEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-property-boxLabelEl" class="viewSource">view source</a></div><a name="boxLabelEl"></a><a name="property-boxLabelEl"></a><a href="Ext.form.field.Checkbox.html#" rel="property-boxLabelEl" class="cls expand">boxLabelEl</a><span> : Ext.core.Element</span></div><div class="description"><div class="short">A reference to the label element created for the boxLabel. Only present if the
1003 component has been rendered and has a ...</div><div class="long"><p>A reference to the label element created for the <a href="Ext.form.field.Checkbox.html#boxLabel" rel="Ext.form.field.Checkbox#boxLabel" class="docClass">boxLabel</a>. Only present if the
1004 component has been rendered and has a boxLabel configured.</p>
1005 </div></div></div><div id="property-clearInvalid" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-clearInvalid" rel="property-clearInvalid" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-property-clearInvalid" class="viewSource">view source</a></div><a name="clearInvalid"></a><a name="property-clearInvalid"></a><a href="Ext.form.field.Checkbox.html#" rel="property-clearInvalid" class="cls expand">clearInvalid</a><span> : Object</span></div><div class="description"><div class="short">Clear any invalid styles/messages for this field. Components using this mixin should implement
1006 this method to update ...</div><div class="long"><p>Clear any invalid styles/messages for this field. Components using this mixin should implement
1007 this method to update the components rendering to clear any existing messages.</p>
1008
1009
1010 <p><b>Note</b>: this method does not cause the Field's <a href="Ext.form.field.Checkbox.html#validate" rel="Ext.form.field.Checkbox#validate" class="docClass">validate</a> or <a href="Ext.form.field.Checkbox.html#isValid" rel="Ext.form.field.Checkbox#isValid" class="docClass">isValid</a> methods to
1011 return <code>true</code> if the value does not <i>pass</i> validation. So simply clearing a field's errors
1012 will not necessarily allow submission of forms submitted with the <a href="Ext.form.action.Submit.html#clientValidation" rel="Ext.form.action.Submit#clientValidation" class="docClass">Ext.form.action.Submit.clientValidation</a>
1013 option set.</p>
1014
1015 </div></div></div><div id="property-draggable" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-draggable" rel="property-draggable" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-draggable" class="viewSource">view source</a></div><a name="draggable"></a><a name="property-draggable"></a><a href="Ext.form.field.Checkbox.html#" rel="property-draggable" class="cls expand">draggable</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Read-only property indicating whether or not the component can be dragged</p>
1016 </div><div class="long"><p>Read-only property indicating whether or not the component can be dragged</p>
1017 </div></div></div><div id="property-errorEl" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-errorEl" rel="property-errorEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-property-errorEl" class="viewSource">view source</a></div><a name="errorEl"></a><a name="property-errorEl"></a><a href="Ext.form.field.Checkbox.html#" rel="property-errorEl" class="cls expand">errorEl</a><span> : Ext.core.Element</span></div><div class="description"><div class="short">The div Element that will contain the component's error message(s). Note that depending on the
1018 configured msgTarget, ...</div><div class="long"><p>The div Element that will contain the component's error message(s). Note that depending on the
1019 configured <a href="Ext.form.field.Checkbox.html#msgTarget" rel="Ext.form.field.Checkbox#msgTarget" class="docClass">msgTarget</a>, this element may be hidden in favor of some other form of
1020 presentation, but will always be present in the DOM for use by assistive technologies.</p>
1021 </div></div></div><div id="property-floatParent" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-floatParent" rel="property-floatParent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-property-floatParent" class="viewSource">view source</a></div><a name="floatParent"></a><a name="property-floatParent"></a><a href="Ext.form.field.Checkbox.html#" rel="property-floatParent" class="cls expand">floatParent</a><span> : Ext.Container</span></div><div class="description"><div class="short">Optional. Only present for floating Components which were inserted as descendant items of floating Containers.
1022
1023
1024 Floa...</div><div class="long"><p>Optional. Only present for <a href="Ext.form.field.Checkbox.html#floating" rel="Ext.form.field.Checkbox#floating" class="docClass">floating</a> Components which were inserted as descendant items of floating Containers.</p>
1025
1026
1027 <p>Floating Components that are programatically <a href="Ext.Component.html#render" rel="Ext.Component#render" class="docClass">rendered</a> will not have a <code>floatParent</code> property.</p>
1028
1029
1030 <p>For <a href="Ext.form.field.Checkbox.html#floating" rel="Ext.form.field.Checkbox#floating" class="docClass">floating</a> Components which are child items of a Container, the floatParent will be the floating ancestor Container which is
1031 responsible for the base z-index value of all its floating descendants. It provides a <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">ZIndexManager</a> which provides
1032 z-indexing services for all its descendant floating Components.</p>
1033
1034
1035 <p>For example, the dropdown <a href="Ext.view.BoundList.html" rel="Ext.view.BoundList" class="docClass">BoundList</a> of a ComboBox which is in a Window will have the Window as its
1036 <code>floatParent</code></p>
1037
1038
1039 <p>See <a href="Ext.form.field.Checkbox.html#floating" rel="Ext.form.field.Checkbox#floating" class="docClass">floating</a> and <a href="Ext.form.field.Checkbox.html#zIndexManager" rel="Ext.form.field.Checkbox#zIndexManager" class="docClass">zIndexManager</a></p>
1040
1041 </div></div></div><div id="property-frameSize" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-frameSize" rel="property-frameSize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-frameSize" class="viewSource">view source</a></div><a name="frameSize"></a><a name="property-frameSize"></a><a href="Ext.form.field.Checkbox.html#" rel="property-frameSize" class="cls expand">frameSize</a><span> : Object</span></div><div class="description"><div class="short">Read-only property indicating the width of any framing elements which were added within the encapsulating element
1042 to ...</div><div class="long"><p>Read-only property indicating the width of any framing elements which were added within the encapsulating element
1043 to provide graphical, rounded borders. See the <a href="Ext.form.field.Checkbox.html#frame" rel="Ext.form.field.Checkbox#frame" class="docClass">frame</a> config.</p>
1044
1045
1046 <p> This is an object containing the frame width in pixels for all four sides of the Component containing
1047 the following properties:</p>
1048
1049
1050 <div class="mdetail-params"><ul>
1051 <li><code>top</code> The width of the top framing element in pixels.</li>
1052 <li><code>right</code> The width of the right framing element in pixels.</li>
1053 <li><code>bottom</code> The width of the bottom framing element in pixels.</li>
1054 <li><code>left</code> The width of the left framing element in pixels.</li>
1055 </ul></div>
1056
1057 </div></div></div><div id="property-hasActiveFx" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-hasActiveFx" rel="property-hasActiveFx" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-property-hasActiveFx" class="viewSource">view source</a></div><a name="hasActiveFx"></a><a name="property-hasActiveFx"></a><a href="Ext.form.field.Checkbox.html#" rel="property-hasActiveFx" class="cls expand">hasActiveFx</a><span> : Object</span></div><div class="description"><div class="short">@deprecated 4.0 Replaced by getActiveAnimation
1058 Returns thq current animation if this object has any effects actively ...</div><div class="long"><p>@deprecated 4.0 Replaced by <a href="Ext.form.field.Checkbox.html#getActiveAnimation" rel="Ext.form.field.Checkbox#getActiveAnimation" class="docClass">getActiveAnimation</a>
1059 Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>
1060 </div></div></div><div id="property-inputEl" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-inputEl" rel="property-inputEl" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-property-inputEl" class="viewSource">view source</a></div><a name="inputEl"></a><a name="property-inputEl"></a><a href="Ext.form.field.Checkbox.html#" rel="property-inputEl" class="cls expand">inputEl</a><span> : Ext.core.Element</span></div><div class="description"><div class="short"><p>The input Element for this Field. Only available after the field has been rendered.</p>
1061 </div><div class="long"><p>The input Element for this Field. Only available after the field has been rendered.</p>
1062 </div></div></div><div id="property-isFieldLabelable" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-isFieldLabelable" rel="property-isFieldLabelable" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-property-isFieldLabelable" class="viewSource">view source</a></div><a name="isFieldLabelable"></a><a name="property-isFieldLabelable"></a><a href="Ext.form.field.Checkbox.html#" rel="property-isFieldLabelable" class="cls expand">isFieldLabelable</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Flag denoting that this object is labelable as a field. Always true.</p>
1063 </div><div class="long"><p>Flag denoting that this object is labelable as a field. Always true.</p>
1064 </div></div></div><div id="property-isFormField" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-isFormField" rel="property-isFormField" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-property-isFormField" class="viewSource">view source</a></div><a name="isFormField"></a><a name="property-isFormField"></a><a href="Ext.form.field.Checkbox.html#" rel="property-isFormField" class="cls expand">isFormField</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Flag denoting that this component is a Field. Always true.</p>
1065 </div><div class="long"><p>Flag denoting that this component is a Field. Always true.</p>
1066 </div></div></div><div id="property-labelEl" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-labelEl" rel="property-labelEl" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-property-labelEl" class="viewSource">view source</a></div><a name="labelEl"></a><a name="property-labelEl"></a><a href="Ext.form.field.Checkbox.html#" rel="property-labelEl" class="cls expand">labelEl</a><span> : Ext.core.Element</span></div><div class="description"><div class="short"><p>The label Element for this component. Only available after the component has been rendered.</p>
1067 </div><div class="long"><p>The label Element for this component. Only available after the component has been rendered.</p>
1068 </div></div></div><div id="property-markInvalid" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-markInvalid" rel="property-markInvalid" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-property-markInvalid" class="viewSource">view source</a></div><a name="markInvalid"></a><a name="property-markInvalid"></a><a href="Ext.form.field.Checkbox.html#" rel="property-markInvalid" class="cls expand">markInvalid</a><span> : Object</span></div><div class="description"><div class="short">Associate one or more error messages with this field. Components using this mixin should implement
1069 this method to upd...</div><div class="long"><p>Associate one or more error messages with this field. Components using this mixin should implement
1070 this method to update the component's rendering to display the messages.</p>
1071
1072
1073 <p><b>Note</b>: this method does not cause the Field's <a href="Ext.form.field.Checkbox.html#validate" rel="Ext.form.field.Checkbox#validate" class="docClass">validate</a> or <a href="Ext.form.field.Checkbox.html#isValid" rel="Ext.form.field.Checkbox#isValid" class="docClass">isValid</a> methods to
1074 return <code>false</code> if the value does <i>pass</i> validation. So simply marking a Field as invalid
1075 will not prevent submission of forms submitted with the <a href="Ext.form.action.Submit.html#clientValidation" rel="Ext.form.action.Submit#clientValidation" class="docClass">Ext.form.action.Submit.clientValidation</a>
1076 option set.</p>
1077
1078 </div></div></div><div id="property-maskOnDisable" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-maskOnDisable" rel="property-maskOnDisable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-maskOnDisable" class="viewSource">view source</a></div><a name="maskOnDisable"></a><a name="property-maskOnDisable"></a><a href="Ext.form.field.Checkbox.html#" rel="property-maskOnDisable" class="cls expand">maskOnDisable</a><span> : Boolean</span></div><div class="description"><div class="short">This is an internal flag that you use when creating custom components.
1079 By default this is set to true which means tha...</div><div class="long"><p>This is an internal flag that you use when creating custom components.
1080 By default this is set to true which means that every component gets a mask when its disabled.
1081 Components like FieldContainer, FieldSet, Field, Button, Tab override this property to false
1082 since they want to implement custom disable logic.</p>
1083 </div></div></div><div id="property-originalValue" class="member ni"><a href="Ext.form.field.Checkbox.html#property-originalValue" rel="property-originalValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-property-originalValue" class="viewSource">view source</a></div><a name="originalValue"></a><a name="property-originalValue"></a><a href="Ext.form.field.Checkbox.html#" rel="property-originalValue" class="cls expand">originalValue</a><span> : Mixed</span></div><div class="description"><div class="short">The original value of the field as configured in the checked configuration, or
1084 as loaded by the last form load operat...</div><div class="long"><p>The original value of the field as configured in the <a href="Ext.form.field.Checkbox.html#checked" rel="Ext.form.field.Checkbox#checked" class="docClass">checked</a> configuration, or
1085 as loaded by the last form load operation if the form's <a href="Ext.form.Basic.html#trackResetOnLoad" rel="Ext.form.Basic#trackResetOnLoad" class="docClass">trackResetOnLoad</a>
1086 setting is <code>true</code>.</p>
1087 </div></div></div><div id="property-ownerCt" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-ownerCt" rel="property-ownerCt" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-ownerCt" class="viewSource">view source</a></div><a name="ownerCt"></a><a name="property-ownerCt"></a><a href="Ext.form.field.Checkbox.html#" rel="property-ownerCt" class="cls expand">ownerCt</a><span> : Ext.Container</span></div><div class="description"><div class="short">This Component's owner Container (defaults to undefined, and is set automatically when
1088 this Component is added to a C...</div><div class="long"><p>This Component's owner <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a> (defaults to undefined, and is set automatically when
1089 this Component is added to a Container).  Read-only.</p>
1090
1091 <p><b>Note</b>: to access items within the Container see <tt><a href="Ext.form.field.Checkbox.html#itemId" rel="Ext.form.field.Checkbox#itemId" class="docClass">itemId</a></tt>.</p>
1092
1093 </div></div></div><div id="property-rendered" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-rendered" rel="property-rendered" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-rendered" class="viewSource">view source</a></div><a name="rendered"></a><a name="property-rendered"></a><a href="Ext.form.field.Checkbox.html#" rel="property-rendered" class="cls expand">rendered</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Read-only property indicating whether or not the component has been rendered.</p>
1094 </div><div class="long"><p>Read-only property indicating whether or not the component has been rendered.</p>
1095 </div></div></div><div id="property-stopFx" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-stopFx" rel="property-stopFx" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-property-stopFx" class="viewSource">view source</a></div><a name="stopFx"></a><a name="property-stopFx"></a><a href="Ext.form.field.Checkbox.html#" rel="property-stopFx" class="cls expand">stopFx</a><span> : Object</span></div><div class="description"><div class="short">Stops any running effects and clears this object's internal effects queue if it contains
1096 any additional effects that ...</div><div class="long"><p>Stops any running effects and clears this object's internal effects queue if it contains
1097 any additional effects that haven't started yet.</p>
1098 </div></div></div><div id="property-zIndexManager" class="member inherited"><a href="Ext.form.field.Checkbox.html#property-zIndexManager" rel="property-zIndexManager" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-property-zIndexManager" class="viewSource">view source</a></div><a name="zIndexManager"></a><a name="property-zIndexManager"></a><a href="Ext.form.field.Checkbox.html#" rel="property-zIndexManager" class="cls expand">zIndexManager</a><span> : Ext.ZIndexManager</span></div><div class="description"><div class="short">Optional. Only present for floating Components after they have been rendered.
1099
1100
1101 A reference to the ZIndexManager whic...</div><div class="long"><p>Optional. Only present for <a href="Ext.form.field.Checkbox.html#floating" rel="Ext.form.field.Checkbox#floating" class="docClass">floating</a> Components after they have been rendered.</p>
1102
1103
1104 <p>A reference to the ZIndexManager which is managing this Component's z-index.</p>
1105
1106
1107 <p>The <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">ZIndexManager</a> maintains a stack of floating Component z-indices, and also provides a single modal
1108 mask which is insert just beneath the topmost visible modal floating Component.</p>
1109
1110
1111 <p>Floating Components may be <a href="Ext.form.field.Checkbox.html#toFront" rel="Ext.form.field.Checkbox#toFront" class="docClass">brought to the front</a> or <a href="Ext.form.field.Checkbox.html#toBack" rel="Ext.form.field.Checkbox#toBack" class="docClass">sent to the back</a> of the z-index stack.</p>
1112
1113
1114 <p>This defaults to the global <a href="Ext.WindowManager.html" rel="Ext.WindowManager" class="docClass">ZIndexManager</a> for floating Components that are programatically
1115 <a href="Ext.Component.html#render" rel="Ext.Component#render" class="docClass">rendered</a>.</p>
1116
1117
1118 <p>For <a href="Ext.form.field.Checkbox.html#floating" rel="Ext.form.field.Checkbox#floating" class="docClass">floating</a> Components which are added to a Container, the ZIndexManager is acquired from the first ancestor Container found
1119 which is floating, or if not found the global <a href="Ext.WindowManager.html" rel="Ext.WindowManager" class="docClass">ZIndexManager</a> is used.</p>
1120
1121
1122 <p>See <a href="Ext.form.field.Checkbox.html#floating" rel="Ext.form.field.Checkbox#floating" class="docClass">floating</a> and <a href="Ext.form.field.Checkbox.html#floatParent" rel="Ext.form.field.Checkbox#floatParent" class="docClass">floatParent</a></p>
1123
1124 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-Checkbox" class="member f ni"><a href="Ext.form.field.Checkbox.html#method-Checkbox" rel="method-Checkbox" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-method-constructor" class="viewSource">view source</a></div><a name="Checkbox"></a><a name="method-Checkbox"></a><a href="Ext.form.field.Checkbox.html#" rel="method-Checkbox" class="cls expand">Checkbox</a>(
1125 <span class="pre">Object config</span>)
1126  : void</div><div class="description"><div class="short"><p>Creates a new Checkbox</p>
1127 </div><div class="long"><p>Creates a new Checkbox</p>
1128 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>Configuration options</p>
1129 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1130 </li></ul></div></div></div><div id="method-addClass" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-addClass" rel="method-addClass" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-addClass" class="viewSource">view source</a></div><a name="addClass"></a><a name="method-addClass"></a><a href="Ext.form.field.Checkbox.html#" rel="method-addClass" class="cls expand">addClass</a>(
1131 <span class="pre">String cls</span>)
1132  : Ext.Component</div><div class="description"><div class="short"><p>@deprecated 4.0 Replaced by {link:#addCls}
1133 Adds a CSS class to the top level element representing this component.</p>
1134 </div><div class="long"><p>@deprecated 4.0 Replaced by {link:#addCls}
1135 Adds a CSS class to the top level element representing this component.</p>
1136 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String<div class="sub-desc"><p>The CSS class name to add</p>
1137 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>Returns the Component to allow method chaining.</p>
1138 </li></ul></div></div></div><div id="method-addCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-addCls" rel="method-addCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-addCls" class="viewSource">view source</a></div><a name="addCls"></a><a name="method-addCls"></a><a href="Ext.form.field.Checkbox.html#" rel="method-addCls" class="cls expand">addCls</a>(
1139 <span class="pre">String cls</span>)
1140  : Ext.Component</div><div class="description"><div class="short"><p>Adds a CSS class to the top level element representing this component.</p>
1141 </div><div class="long"><p>Adds a CSS class to the top level element representing this component.</p>
1142 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String<div class="sub-desc"><p>The CSS class name to add</p>
1143 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>Returns the Component to allow method chaining.</p>
1144 </li></ul></div></div></div><div id="method-addClsWithUI" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-addClsWithUI" rel="method-addClsWithUI" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-addClsWithUI" class="viewSource">view source</a></div><a name="addClsWithUI"></a><a name="method-addClsWithUI"></a><a href="Ext.form.field.Checkbox.html#" rel="method-addClsWithUI" class="cls expand">addClsWithUI</a>(
1145 <span class="pre">String/Array cls</span>)
1146  : void</div><div class="description"><div class="short"><p>Adds a cls to the uiCls array, which will also call <a href="Ext.form.field.Checkbox.html#addUIClsToElement" rel="Ext.form.field.Checkbox#addUIClsToElement" class="docClass">addUIClsToElement</a> and adds
1147 to all elements of this component.</p>
1148 </div><div class="long"><p>Adds a cls to the uiCls array, which will also call <a href="Ext.form.field.Checkbox.html#addUIClsToElement" rel="Ext.form.field.Checkbox#addUIClsToElement" class="docClass">addUIClsToElement</a> and adds
1149 to all elements of this component.</p>
1150 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String/Array<div class="sub-desc"><p>A string or an array of strings to add to the uiCls</p>
1151 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1152 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.form.field.Checkbox.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
1153 <span class="pre">Object/String o, String </span>)
1154  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
1155 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
1156 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
1157 or the first event name string if multiple event names are being passed as separate parameters.</p>
1158 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
1159 Usage:</p>
1160
1161 <pre><code>this.addEvents('storeloaded', 'storecleared');
1162 </code></pre>
1163
1164 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1165 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.form.field.Checkbox.html#" rel="method-addListener" class="cls expand">addListener</a>(
1166 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
1167  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
1168 </div><div class="long"><p>Appends an event handler to this object.</p>
1169 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
1170 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
1171 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
1172 <b>If omitted, defaults to the object which fired the event.</b></p>
1173 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
1174 properties. This may contain any of the following properties:<ul>
1175 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
1176 <b>If omitted, defaults to the object which fired the event.</b></div></li>
1177 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
1178 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
1179 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
1180 by the specified number of milliseconds. If the event fires again within that time, the original
1181 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
1182 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
1183 if the event was bubbled up from a child Observable.</div></li>
1184 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
1185 The name of a Component property which references an element to add a listener to.</p>
1186
1187 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
1188 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
1189 <pre><code>new Ext.panel.Panel({
1190     title: 'The title',
1191     listeners: {
1192         click: this.handlePanelClick,
1193         element: 'body'
1194     }
1195 });
1196 </code></pre></p>
1197
1198
1199 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
1200
1201
1202 <p></div></li>
1203 </ul><br></p>
1204
1205 <p>
1206 <b>Combining Options</b><br>
1207 Using the options argument, it is possible to combine different types of listeners:<br>
1208 <br>
1209 A delayed, one-time listener.
1210 <pre><code>myPanel.on('hide', this.handleClick, this, {
1211 single: true,
1212 delay: 100
1213 });</code></pre>
1214 <p>
1215 <b>Attaching multiple handlers in 1 call</b><br>
1216 The method also allows for a single argument to be passed which is a config object containing properties
1217 which specify multiple events. For example:
1218 <pre><code>myGridPanel.on({
1219     cellClick: this.onCellClick,
1220     mouseover: this.onMouseOver,
1221     mouseout: this.onMouseOut,
1222     scope: this // Important. Ensure "this" is correct during handler execution
1223 });
1224 </code></pre>.
1225 <p>
1226
1227 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1228 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.form.field.Checkbox.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
1229 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
1230  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
1231 is destroyed.
1232
1233 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
1234 is destroyed.
1235
1236 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
1237 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
1238 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
1239 is the handler function.</p>
1240 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
1241 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
1242 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
1243 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
1244 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1245 </li></ul></div></div></div><div id="method-addStateEvents" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-addStateEvents" rel="method-addStateEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-addStateEvents" class="viewSource">view source</a></div><a name="addStateEvents"></a><a name="method-addStateEvents"></a><a href="Ext.form.field.Checkbox.html#" rel="method-addStateEvents" class="cls expand">addStateEvents</a>(
1246 <span class="pre">String/Array events</span>)
1247  : void</div><div class="description"><div class="short"><p>Add events that will trigger the state to be saved.</p>
1248 </div><div class="long"><p>Add events that will trigger the state to be saved.</p>
1249 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name or an array of event names.</p>
1250 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1251 </li></ul></div></div></div><div id="method-afterComponentLayout" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-afterComponentLayout" rel="method-afterComponentLayout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-afterComponentLayout" class="viewSource">view source</a></div><a name="afterComponentLayout"></a><a name="method-afterComponentLayout"></a><a href="Ext.form.field.Checkbox.html#" rel="method-afterComponentLayout" class="cls expand">afterComponentLayout</a>(
1252 <span class="pre">Number adjWidth, Number adjHeight, Boolean isSetSize, Ext.Component layoutOwner</span>)
1253  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
1254 <h3 class="pa">Parameters</h3><ul><li><span class="pre">adjWidth</span> : Number<div class="sub-desc"><p>The box-adjusted width that was set</p>
1255 </div></li><li><span class="pre">adjHeight</span> : Number<div class="sub-desc"><p>The box-adjusted height that was set</p>
1256 </div></li><li><span class="pre">isSetSize</span> : Boolean<div class="sub-desc"><p>Whether or not the height/width are stored on the component permanently</p>
1257 </div></li><li><span class="pre">layoutOwner</span> : Ext.Component<div class="sub-desc"><p>Component which sent the layout. Only used when isSetSize is false.</p>
1258 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1259 </li></ul></div></div></div><div id="method-alignTo" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-alignTo" rel="method-alignTo" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-alignTo" class="viewSource">view source</a></div><a name="alignTo"></a><a name="method-alignTo"></a><a href="Ext.form.field.Checkbox.html#" rel="method-alignTo" class="cls expand">alignTo</a>(
1260 <span class="pre">Mixed element, String position, [Array offsets]</span>)
1261  : Component</div><div class="description"><div class="short"><p>Aligns this floating Component to the specified element</p>
1262 </div><div class="long"><p>Aligns this floating Component to the specified element</p>
1263 <h3 class="pa">Parameters</h3><ul><li><span class="pre">element</span> : Mixed<div class="sub-desc"><p>The element or <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> to align to. If passing a component, it must
1264 be a omponent instance. If a string id is passed, it will be used as an element id.</p>
1265 </div></li><li><span class="pre">position</span> : String<div class="sub-desc"><p>(optional, defaults to "tl-bl?") The position to align to (see <a href="Ext.core.Element.html#alignTo" rel="Ext.core.Element#alignTo" class="docClass">Ext.core.Element.alignTo</a> for more details).</p>
1266 </div></li><li><span class="pre">offsets</span> : Array<div class="sub-desc"><p>(optional) Offset the positioning by [x, y]</p>
1267 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
1268 </li></ul></div></div></div><div id="method-animate" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-animate" rel="method-animate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-animate" class="viewSource">view source</a></div><a name="animate"></a><a name="method-animate"></a><a href="Ext.form.field.Checkbox.html#" rel="method-animate" class="cls expand">animate</a>(
1269 <span class="pre">Object config</span>)
1270  : Object</div><div class="description"><div class="short">Perform custom animation on this object.
1271 This method is applicable to both the the Component class and the Element cl...</div><div class="long"><p>Perform custom animation on this object.<p>
1272 <p>This method is applicable to both the the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Component</a> class and the <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Element</a> class.
1273 It performs animated transitions of certain properties of this object over a specified timeline.</p>
1274 <p>The sole parameter is an object which specifies start property values, end property values, and properties which
1275 describe the timeline. Of the properties listed below, only <b><code>to</code></b> is mandatory.</p>
1276 <p>Properties include<ul>
1277 <li><code>from</code> <div class="sub-desc">An object which specifies start values for the properties being animated.
1278 If not supplied, properties are animated from current settings. The actual properties which may be animated depend upon
1279 ths object being animated. See the sections below on Element and Component animation.<div></li>
1280 <li><code>to</code> <div class="sub-desc">An object which specifies end values for the properties being animated.</div></li>
1281 <li><code>duration</code><div class="sub-desc">The duration <b>in milliseconds</b> for which the animation will run.</div></li>
1282 <li><code>easing</code> <div class="sub-desc">A string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:<code><ul>
1283 <li>ease</li>
1284 <li>easeIn</li>
1285 <li>easeOut</li>
1286 <li>easeInOut</li>
1287 <li>backIn</li>
1288 <li>backOut</li>
1289 <li>elasticIn</li>
1290 <li>elasticOut</li>
1291 <li>bounceIn</li>
1292 <li>bounceOut</li>
1293 </ul></code></div></li>
1294 <li><code>keyframes</code> <div class="sub-desc">This is an object which describes the state of animated properties at certain points along the timeline.
1295 it is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.</div></li>
1296 <li><code>listeners</code> <div class="sub-desc">This is a standard <a href="Ext.util.Observable.html#listeners" rel="Ext.util.Observable#listeners" class="docClass">listeners</a> configuration object which may be used
1297 to inject behaviour at either the <code>beforeanimate</code> event or the <code>afteranimate</code> event.</div></li>
1298 </ul></p>
1299 <h3>Animating an <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Element</a></h3>
1300 When animating an Element, the following properties may be specified in <code>from</code>, <code>to</code>, and <code>keyframe</code> objects:<ul>
1301 <li><code>x</code> <div class="sub-desc">The page X position in pixels.</div></li>
1302 <li><code>y</code> <div class="sub-desc">The page Y position in pixels</div></li>
1303 <li><code>left</code> <div class="sub-desc">The element's CSS <code>left</code> value. Units must be supplied.</div></li>
1304 <li><code>top</code> <div class="sub-desc">The element's CSS <code>top</code> value. Units must be supplied.</div></li>
1305 <li><code>width</code> <div class="sub-desc">The element's CSS <code>width</code> value. Units must be supplied.</div></li>
1306 <li><code>height</code> <div class="sub-desc">The element's CSS <code>height</code> value. Units must be supplied.</div></li>
1307 <li><code>scrollLeft</code> <div class="sub-desc">The element's <code>scrollLeft</code> value.</div></li>
1308 <li><code>scrollTop</code> <div class="sub-desc">The element's <code>scrollLeft</code> value.</div></li>
1309 <li><code>opacity</code> <div class="sub-desc">The element's <code>opacity</code> value. This must be a value between <code>0</code> and <code>1</code>.</div></li>
1310 </ul>
1311 <p><b>Be aware than animating an Element which is being used by an <a href="Ext.html" rel="Ext" class="docClass">Ext</a> Component without in some way informing the Component about the changed element state
1312 will result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to
1313 directly animate certain properties of Components.</b></p>
1314 <h3>Animating a <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Component</a></h3>
1315 When animating an Element, the following properties may be specified in <code>from</code>, <code>to</code>, and <code>keyframe</code> objects:<ul>
1316 <li><code>x</code> <div class="sub-desc">The Component's page X position in pixels.</div></li>
1317 <li><code>y</code> <div class="sub-desc">The Component's page Y position in pixels</div></li>
1318 <li><code>left</code> <div class="sub-desc">The Component's <code>left</code> value in pixels.</div></li>
1319 <li><code>top</code> <div class="sub-desc">The Component's <code>top</code> value in pixels.</div></li>
1320 <li><code>width</code> <div class="sub-desc">The Component's <code>width</code> value in pixels.</div></li>
1321 <li><code>width</code> <div class="sub-desc">The Component's <code>width</code> value in pixels.</div></li>
1322 <li><code>dynamic</code> <div class="sub-desc">Specify as true to update the Component's layout (if it is a Container) at every frame
1323 of the animation. <i>Use sparingly as laying out on every intermediate size change is an expensive operation</i>.</div></li>
1324 </ul>
1325 <p>For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:</p>
1326 <pre><code>myWindow = Ext.create('Ext.window.Window', {
1327     title: 'Test Component animation',
1328     width: 500,
1329     height: 300,
1330     layout: {
1331         type: 'hbox',
1332         align: 'stretch'
1333     },
1334     items: [{
1335         title: 'Left: 33%',
1336         margins: '5 0 5 5',
1337         flex: 1
1338     }, {
1339         title: 'Left: 66%',
1340         margins: '5 5 5 5',
1341         flex: 2
1342     }]
1343 });
1344 myWindow.show();
1345 myWindow.header.el.on('click', function() {
1346     myWindow.animate({
1347         to: {
1348             width: (myWindow.getWidth() == 500) ? 700 : 500,
1349             height: (myWindow.getHeight() == 300) ? 400 : 300,
1350         }
1351     });
1352 });
1353 </code></pre>
1354 <p>For performance reasons, by default, the internal layout is only updated when the Window reaches its final <code>"to"</code> size. If dynamic updating of the Window's child
1355 Components is required, then configure the animation with <code>dynamic: true</code> and the two child items will maintain their proportions during the animation.</p>
1356
1357 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>An object containing properties which describe the animation's start and end states, and the timeline of the animation.</p>
1358 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>this</p>
1359 </li></ul></div></div></div><div id="method-applyState" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-applyState" rel="method-applyState" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-applyState" class="viewSource">view source</a></div><a name="applyState"></a><a name="method-applyState"></a><a href="Ext.form.field.Checkbox.html#" rel="method-applyState" class="cls expand">applyState</a>(
1360 <span class="pre">Object state</span>)
1361  : void</div><div class="description"><div class="short">Applies the state to the object. This should be overridden in subclasses to do
1362 more complex state operations. By defa...</div><div class="long"><p>Applies the state to the object. This should be overridden in subclasses to do
1363 more complex state operations. By default it applies the state properties onto
1364 the current object.</p>
1365 <h3 class="pa">Parameters</h3><ul><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The state</p>
1366 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1367 </li></ul></div></div></div><div id="method-batchChanges" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-batchChanges" rel="method-batchChanges" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-batchChanges" class="viewSource">view source</a></div><a name="batchChanges"></a><a name="method-batchChanges"></a><a href="Ext.form.field.Checkbox.html#" rel="method-batchChanges" class="cls expand">batchChanges</a>(
1368 <span class="pre">Object fn</span>)
1369  : void</div><div class="description"><div class="short">A utility for grouping a set of modifications which may trigger value changes into a single
1370 transaction, to prevent e...</div><div class="long"><p>A utility for grouping a set of modifications which may trigger value changes into a single
1371 transaction, to prevent excessive firing of <a href="Ext.form.field.Checkbox.html#change" rel="Ext.form.field.Checkbox#change" class="docClass">change</a> events. This is useful for instance
1372 if the field has sub-fields which are being updated as a group; you don't want the container
1373 field to check its own changed state for each subfield change.</p>
1374 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Object<div class="sub-desc"><p>A function containing the transaction code</p>
1375 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1376 </li></ul></div></div></div><div id="method-beforeComponentLayout" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-beforeComponentLayout" rel="method-beforeComponentLayout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-beforeComponentLayout" class="viewSource">view source</a></div><a name="beforeComponentLayout"></a><a name="method-beforeComponentLayout"></a><a href="Ext.form.field.Checkbox.html#" rel="method-beforeComponentLayout" class="cls expand">beforeComponentLayout</a>(
1377 <span class="pre">Number adjWidth, Number adjHeight, Boolean isSetSize, Ext.Component layoutOwner</span>)
1378  : void</div><div class="description"><div class="short">Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout
1379 from being ex...</div><div class="long"><p>Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout
1380 from being executed.</p>
1381 <h3 class="pa">Parameters</h3><ul><li><span class="pre">adjWidth</span> : Number<div class="sub-desc"><p>The box-adjusted width that was set</p>
1382 </div></li><li><span class="pre">adjHeight</span> : Number<div class="sub-desc"><p>The box-adjusted height that was set</p>
1383 </div></li><li><span class="pre">isSetSize</span> : Boolean<div class="sub-desc"><p>Whether or not the height/width are stored on the component permanently</p>
1384 </div></li><li><span class="pre">layoutOwner</span> : Ext.Component<div class="sub-desc"><p>Component which sent the layout. Only used when isSetSize is false.</p>
1385 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1386 </li></ul></div></div></div><div id="method-bubble" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-bubble" rel="method-bubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-bubble" class="viewSource">view source</a></div><a name="bubble"></a><a name="method-bubble"></a><a href="Ext.form.field.Checkbox.html#" rel="method-bubble" class="cls expand">bubble</a>(
1387 <span class="pre">Function fn, [Object scope], [Array args]</span>)
1388  : Ext.Component</div><div class="description"><div class="short">Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...</div><div class="long"><p>Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (<i>this</i>) of
1389 function call will be the scope provided or the current component. The arguments to the function
1390 will be the args provided or the current component. If the function returns false at any point,
1391 the bubble is stopped.</p>
1392 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call</p>
1393 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope of the function (defaults to current node)</p>
1394 </div></li><li><span class="pre">args</span> : Array<div class="sub-desc"><p>(optional) The args to call the function with (default to passing the current component)</p>
1395 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1396 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.form.field.Checkbox.html#" rel="method-capture" class="cls expand">capture</a>(
1397 <span class="pre">Observable o, Function fn, [Object scope]</span>)
1398  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
1399 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
1400 to the supplied function with the event name + standard signature of the event
1401 <b>before</b> the event is fired. If the supplied function returns false,
1402 the event will not fire.</p>
1403 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
1404 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
1405 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
1406 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1407 </li></ul></div></div></div><div id="method-center" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-center" rel="method-center" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-center" class="viewSource">view source</a></div><a name="center"></a><a name="method-center"></a><a href="Ext.form.field.Checkbox.html#" rel="method-center" class="cls expand">center</a> : Component</div><div class="description"><div class="short"><p>Center this Component in its container.</p>
1408 </div><div class="long"><p>Center this Component in its container.</p>
1409 <h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
1410 </li></ul></div></div></div><div id="method-checkChange" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-checkChange" rel="method-checkChange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-checkChange" class="viewSource">view source</a></div><a name="checkChange"></a><a name="method-checkChange"></a><a href="Ext.form.field.Checkbox.html#" rel="method-checkChange" class="cls expand">checkChange</a> : void</div><div class="description"><div class="short">Checks whether the value of the field has changed since the last time it was checked. If the value
1411 has changed, it:
1412
1413 ...</div><div class="long"><p>Checks whether the value of the field has changed since the last time it was checked. If the value
1414 has changed, it:</p>
1415
1416
1417 <ol>
1418 <li>Fires the <a href="Ext.form.field.Checkbox.html#change" rel="Ext.form.field.Checkbox#change" class="docClass">change event</a>,</li>
1419 <li>Performs validation if the <a href="Ext.form.field.Checkbox.html#validateOnChange" rel="Ext.form.field.Checkbox#validateOnChange" class="docClass">validateOnChange</a> config is enabled, firing the
1420 <a href="Ext.form.field.Checkbox.html#validationchange" rel="Ext.form.field.Checkbox#validationchange" class="docClass">validationchange event</a> if the validity has changed, and</li>
1421 <li>Checks the <a href="Ext.form.field.Checkbox.html#isDirty" rel="Ext.form.field.Checkbox#isDirty" class="docClass">dirty state</a> of the field and fires the <a href="Ext.form.field.Checkbox.html#dirtychange" rel="Ext.form.field.Checkbox#dirtychange" class="docClass">dirtychange event</a>
1422 if it has changed.</li>
1423 </ol>
1424
1425 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1426 </li></ul></div></div></div><div id="method-checkDirty" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-checkDirty" rel="method-checkDirty" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-checkDirty" class="viewSource">view source</a></div><a name="checkDirty"></a><a name="method-checkDirty"></a><a href="Ext.form.field.Checkbox.html#" rel="method-checkDirty" class="cls expand">checkDirty</a> : void</div><div class="description"><div class="short">Checks the isDirty state of the field and if it has changed since the last time
1427 it was checked, fires the dirtychange...</div><div class="long"><p>Checks the <a href="Ext.form.field.Checkbox.html#isDirty" rel="Ext.form.field.Checkbox#isDirty" class="docClass">isDirty</a> state of the field and if it has changed since the last time
1428 it was checked, fires the <a href="Ext.form.field.Checkbox.html#dirtychange" rel="Ext.form.field.Checkbox#dirtychange" class="docClass">dirtychange</a> event.</p>
1429 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1430 </li></ul></div></div></div><div id="method-clearInvalid" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-clearInvalid" rel="method-clearInvalid" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-clearInvalid" class="viewSource">view source</a></div><a name="clearInvalid"></a><a name="method-clearInvalid"></a><a href="Ext.form.field.Checkbox.html#" rel="method-clearInvalid" class="cls expand">clearInvalid</a> : void</div><div class="description"><div class="short">Clear any invalid styles/messages for this field.
1431
1432
1433 Note: this method does not cause the Field's validate or isValid ...</div><div class="long"><p>Clear any invalid styles/messages for this field.</p>
1434
1435
1436 <p><b>Note</b>: this method does not cause the Field's <a href="Ext.form.field.Checkbox.html#validate" rel="Ext.form.field.Checkbox#validate" class="docClass">validate</a> or <a href="Ext.form.field.Checkbox.html#isValid" rel="Ext.form.field.Checkbox#isValid" class="docClass">isValid</a> methods to
1437 return <code>true</code> if the value does not <i>pass</i> validation. So simply clearing a field's errors
1438 will not necessarily allow submission of forms submitted with the <a href="Ext.form.action.Submit.html#clientValidation" rel="Ext.form.action.Submit#clientValidation" class="docClass">Ext.form.action.Submit.clientValidation</a>
1439 option set.</p>
1440
1441 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1442 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.form.field.Checkbox.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
1443 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
1444 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1445 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.form.field.Checkbox.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
1446 </div><div class="long"><p>Removes all managed listeners for this object.</p>
1447 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1448 </li></ul></div></div></div><div id="method-cloneConfig" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-cloneConfig" rel="method-cloneConfig" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-cloneConfig" class="viewSource">view source</a></div><a name="cloneConfig"></a><a name="method-cloneConfig"></a><a href="Ext.form.field.Checkbox.html#" rel="method-cloneConfig" class="cls expand">cloneConfig</a>(
1449 <span class="pre">Object overrides</span>)
1450  : Ext.Component</div><div class="description"><div class="short"><p>Clone the current component using the original config values passed into this instance by default.</p>
1451 </div><div class="long"><p>Clone the current component using the original config values passed into this instance by default.</p>
1452 <h3 class="pa">Parameters</h3><ul><li><span class="pre">overrides</span> : Object<div class="sub-desc"><p>A new config containing any properties to override in the cloned version.
1453 An id property can be passed on this object, otherwise one will be generated to avoid duplicates.</p>
1454 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>clone The cloned copy of this component</p>
1455 </li></ul></div></div></div><div id="method-destroy" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-destroy" rel="method-destroy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-destroy" class="viewSource">view source</a></div><a name="destroy"></a><a name="method-destroy"></a><a href="Ext.form.field.Checkbox.html#" rel="method-destroy" class="cls expand">destroy</a> : void</div><div class="description"><div class="short"><p>Destroys this stateful object.</p>
1456 </div><div class="long"><p>Destroys this stateful object.</p>
1457 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1458 </li></ul></div></div></div><div id="method-disable" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-disable" rel="method-disable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-disable" class="viewSource">view source</a></div><a name="disable"></a><a name="method-disable"></a><a href="Ext.form.field.Checkbox.html#" rel="method-disable" class="cls expand">disable</a>(
1459 <span class="pre">Boolean silent</span>)
1460  : void</div><div class="description"><div class="short"><p>Disable the component.</p>
1461 </div><div class="long"><p>Disable the component.</p>
1462 <h3 class="pa">Parameters</h3><ul><li><span class="pre">silent</span> : Boolean<div class="sub-desc"><p>Passing true, will supress the 'disable' event from being fired.</p>
1463 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1464 </li></ul></div></div></div><div id="method-doAutoRender" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-doAutoRender" rel="method-doAutoRender" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-doAutoRender" class="viewSource">view source</a></div><a name="doAutoRender"></a><a name="method-doAutoRender"></a><a href="Ext.form.field.Checkbox.html#" rel="method-doAutoRender" class="cls expand">doAutoRender</a> : void</div><div class="description"><div class="short">Handles autoRender.
1465 Floating Components may have an ownerCt. If they are asking to be constrained, constrain them wit...</div><div class="long"><p>Handles autoRender.
1466 Floating Components may have an ownerCt. If they are asking to be constrained, constrain them within that
1467 ownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body</p>
1468 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1469 </li></ul></div></div></div><div id="method-doComponentLayout" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-doComponentLayout" rel="method-doComponentLayout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-doComponentLayout" class="viewSource">view source</a></div><a name="doComponentLayout"></a><a name="method-doComponentLayout"></a><a href="Ext.form.field.Checkbox.html#" rel="method-doComponentLayout" class="cls expand">doComponentLayout</a>(
1470 <span class="pre">Object width, Object height, Object isSetSize, Object ownerCt</span>)
1471  : Ext.container.Container</div><div class="description"><div class="short">This method needs to be called whenever you change something on this component that requires the Component's
1472 layout t...</div><div class="long"><p>This method needs to be called whenever you change something on this component that requires the Component's
1473 layout to be recalculated.</p>
1474 <h3 class="pa">Parameters</h3><ul><li><span class="pre">width</span> : Object<div class="sub-desc">
1475 </div></li><li><span class="pre">height</span> : Object<div class="sub-desc">
1476 </div></li><li><span class="pre">isSetSize</span> : Object<div class="sub-desc">
1477 </div></li><li><span class="pre">ownerCt</span> : Object<div class="sub-desc">
1478 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>this</p>
1479 </li></ul></div></div></div><div id="method-doConstrain" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-doConstrain" rel="method-doConstrain" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-doConstrain" class="viewSource">view source</a></div><a name="doConstrain"></a><a name="method-doConstrain"></a><a href="Ext.form.field.Checkbox.html#" rel="method-doConstrain" class="cls expand">doConstrain</a>(
1480 <span class="pre">Mixed constrainTo</span>)
1481  : void</div><div class="description"><div class="short">Moves this floating Component into a constrain region.
1482
1483
1484 By default, this Component is constrained to be within the c...</div><div class="long"><p>Moves this floating Component into a constrain region.</p>
1485
1486
1487 <p>By default, this Component is constrained to be within the container it was added to, or the element
1488 it was rendered to.</p>
1489
1490
1491 <p>An alternative constraint may be passed.</p>
1492
1493 <h3 class="pa">Parameters</h3><ul><li><span class="pre">constrainTo</span> : Mixed<div class="sub-desc"><p>Optional. The Element or <a href="Ext.util.Region.html" rel="Ext.util.Region" class="docClass">Region</a> into which this Component is to be constrained.</p>
1494 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1495 </li></ul></div></div></div><div id="method-enable" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-enable" rel="method-enable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-enable" class="viewSource">view source</a></div><a name="enable"></a><a name="method-enable"></a><a href="Ext.form.field.Checkbox.html#" rel="method-enable" class="cls expand">enable</a>(
1496 <span class="pre">Boolean silent</span>)
1497  : void</div><div class="description"><div class="short"><p>Enable the component</p>
1498 </div><div class="long"><p>Enable the component</p>
1499 <h3 class="pa">Parameters</h3><ul><li><span class="pre">silent</span> : Boolean<div class="sub-desc"><p>Passing false will supress the 'enable' event from being fired.</p>
1500 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1501 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.form.field.Checkbox.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
1502 <span class="pre">String/Array events</span>)
1503  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
1504 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
1505 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
1506
1507
1508 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
1509 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
1510 access the required target more quickly.</p>
1511
1512
1513 <p>Example:</p>
1514
1515
1516 <pre><code>Ext.override(Ext.form.field.Base, {
1517 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
1518 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
1519     this.enableBubble('change');
1520 }),
1521
1522 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
1523 getBubbleTarget : function() {
1524     if (!this.formPanel) {
1525         this.formPanel = this.findParentByType('form');
1526     }
1527     return this.formPanel;
1528 }
1529 });
1530
1531 var myForm = new Ext.formPanel({
1532 title: 'User Details',
1533 items: [{
1534     ...
1535 }],
1536 listeners: {
1537     change: function() {
1538         // Title goes red if form has been modified.
1539         myForm.header.setStyle('color', 'red');
1540     }
1541 }
1542 });
1543 </code></pre>
1544
1545 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
1546 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1547 </li></ul></div></div></div><div id="method-extractFileInput" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-extractFileInput" rel="method-extractFileInput" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-extractFileInput" class="viewSource">view source</a></div><a name="extractFileInput"></a><a name="method-extractFileInput"></a><a href="Ext.form.field.Checkbox.html#" rel="method-extractFileInput" class="cls expand">extractFileInput</a> : HTMLInputElement</div><div class="description"><div class="short">Only relevant if the instance's isFileUpload method returns true. Returns a reference
1548 to the file input DOM element h...</div><div class="long"><p>Only relevant if the instance's <a href="Ext.form.field.Checkbox.html#isFileUpload" rel="Ext.form.field.Checkbox#isFileUpload" class="docClass">isFileUpload</a> method returns true. Returns a reference
1549 to the file input DOM element holding the user's selected file. The input will be appended into
1550 the submission form and will not be returned, so this method should also create a replacement.</p>
1551 <h3 class="pa">Returns</h3><ul><li><span class="pre">HTMLInputElement</span>&nbsp; &nbsp;
1552 </li></ul></div></div></div><div id="method-findLayoutController" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-findLayoutController" rel="method-findLayoutController" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-findLayoutController" class="viewSource">view source</a></div><a name="findLayoutController"></a><a name="method-findLayoutController"></a><a href="Ext.form.field.Checkbox.html#" rel="method-findLayoutController" class="cls expand">findLayoutController</a> : void</div><div class="description"><div class="short">This method finds the topmost active layout who's processing will eventually determine the size and position of this
1553 ...</div><div class="long"><p>This method finds the topmost active layout who's processing will eventually determine the size and position of this
1554 Component.<p>
1555 <p>This method is useful when dynamically adding Components into Containers, and some processing must take place after the
1556 final sizing and positioning of the Component has been performed.</p>
1557
1558 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1559 </li></ul></div></div></div><div id="method-findParentBy" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-findParentBy" rel="method-findParentBy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-findParentBy" class="viewSource">view source</a></div><a name="findParentBy"></a><a name="method-findParentBy"></a><a href="Ext.form.field.Checkbox.html#" rel="method-findParentBy" class="cls expand">findParentBy</a>(
1560 <span class="pre">Function fn</span>)
1561  : Ext.container.Container</div><div class="description"><div class="short">Find a container above this component at any level by a custom function. If the passed function returns
1562 true, the con...</div><div class="long"><p>Find a container above this component at any level by a custom function. If the passed function returns
1563 true, the container will be returned.</p>
1564 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The custom function to call with the arguments (container, this component).</p>
1565 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>The first Container for which the custom function returns true</p>
1566 </li></ul></div></div></div><div id="method-findParentByType" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-findParentByType" rel="method-findParentByType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-findParentByType" class="viewSource">view source</a></div><a name="findParentByType"></a><a name="method-findParentByType"></a><a href="Ext.form.field.Checkbox.html#" rel="method-findParentByType" class="cls expand">findParentByType</a>(
1567 <span class="pre">String/Class xtype</span>)
1568  : Ext.container.Container</div><div class="description"><div class="short"><p>Find a container above this component at any level by xtype or class</p>
1569
1570
1571 <p>See also the <a href="Ext.Component.html#up" rel="Ext.Component#up" class="docClass">up</a> method.</p>
1572
1573 </div><div class="long"><p>Find a container above this component at any level by xtype or class</p>
1574
1575
1576 <p>See also the <a href="Ext.Component.html#up" rel="Ext.Component#up" class="docClass">up</a> method.</p>
1577
1578 <h3 class="pa">Parameters</h3><ul><li><span class="pre">xtype</span> : String/Class<div class="sub-desc"><p>The xtype string for a component, or the class of the component directly</p>
1579 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>The first Container which matches the given xtype or class</p>
1580 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.form.field.Checkbox.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
1581 <span class="pre">String eventName, Object... args</span>)
1582  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
1583
1584
1585 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
1586
1587
1588 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
1589 by calling <a href="Ext.form.field.Checkbox.html#enableBubble" rel="Ext.form.field.Checkbox#enableBubble" class="docClass">enableBubble</a>.</p>
1590
1591 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
1592 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
1593 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
1594 </li></ul></div></div></div><div id="method-focus" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-focus" rel="method-focus" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-focus" class="viewSource">view source</a></div><a name="focus"></a><a name="method-focus"></a><a href="Ext.form.field.Checkbox.html#" rel="method-focus" class="cls expand">focus</a>(
1595 <span class="pre">[Boolean selectText], [Boolean/Number delay]</span>)
1596  : Ext.Component</div><div class="description"><div class="short"><p>Try to focus this component.</p>
1597 </div><div class="long"><p>Try to focus this component.</p>
1598 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selectText</span> : Boolean<div class="sub-desc"><p>(optional) If applicable, true to also select the text in this component</p>
1599 </div></li><li><span class="pre">delay</span> : Boolean/Number<div class="sub-desc"><p>(optional) Delay the focus this number of milliseconds (true for 10 milliseconds).</p>
1600 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1601 </li></ul></div></div></div><div id="method-getActiveAnimation" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getActiveAnimation" rel="method-getActiveAnimation" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-getActiveAnimation" class="viewSource">view source</a></div><a name="getActiveAnimation"></a><a name="method-getActiveAnimation"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getActiveAnimation" class="cls expand">getActiveAnimation</a> : Mixed</div><div class="description"><div class="short"><p>Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>
1602 </div><div class="long"><p>Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>
1603 <h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>anim if element has active effects, else false</p>
1604 </li></ul></div></div></div><div id="method-getActiveError" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getActiveError" rel="method-getActiveError" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-getActiveError" class="viewSource">view source</a></div><a name="getActiveError"></a><a name="method-getActiveError"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getActiveError" class="cls expand">getActiveError</a> : String</div><div class="description"><div class="short">Gets the active error message for this component, if any. This does not trigger
1605 validation on its own, it merely retu...</div><div class="long"><p>Gets the active error message for this component, if any. This does not trigger
1606 validation on its own, it merely returns any message that the component may already hold.</p>
1607 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The active error message on the component; if there is no error, an empty string is returned.</p>
1608 </li></ul></div></div></div><div id="method-getActiveErrors" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getActiveErrors" rel="method-getActiveErrors" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-getActiveErrors" class="viewSource">view source</a></div><a name="getActiveErrors"></a><a name="method-getActiveErrors"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getActiveErrors" class="cls expand">getActiveErrors</a> : Array</div><div class="description"><div class="short">Gets an Array of any active error messages currently applied to the field. This does not trigger
1609 validation on its ow...</div><div class="long"><p>Gets an Array of any active error messages currently applied to the field. This does not trigger
1610 validation on its own, it merely returns any messages that the component may already hold.</p>
1611 <h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The active error messages on the component; if there are no errors, an empty Array is returned.</p>
1612 </li></ul></div></div></div><div id="method-getBox" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getBox" rel="method-getBox" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-getBox" class="viewSource">view source</a></div><a name="getBox"></a><a name="method-getBox"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getBox" class="cls expand">getBox</a>(
1613 <span class="pre">[Boolean local]</span>)
1614  : Object</div><div class="description"><div class="short"><p>Gets the current box measurements of the component's underlying element.</p>
1615 </div><div class="long"><p>Gets the current box measurements of the component's underlying element.</p>
1616 <h3 class="pa">Parameters</h3><ul><li><span class="pre">local</span> : Boolean<div class="sub-desc"><p>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</p>
1617 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>box An object in the format {x, y, width, height}</p>
1618 </li></ul></div></div></div><div id="method-getBubbleTarget" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getBubbleTarget" rel="method-getBubbleTarget" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getBubbleTarget" class="viewSource">view source</a></div><a name="getBubbleTarget"></a><a name="method-getBubbleTarget"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getBubbleTarget" class="cls expand">getBubbleTarget</a> : Ext.container.Container</div><div class="description"><div class="short"><p>Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.</p>
1619 </div><div class="long"><p>Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.</p>
1620 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>the Container which owns this Component.</p>
1621 </li></ul></div></div></div><div id="method-getEl" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getEl" rel="method-getEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getEl" class="viewSource">view source</a></div><a name="getEl"></a><a name="method-getEl"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getEl" class="cls expand">getEl</a> : void</div><div class="description"><div class="short"><p>Retrieves the top level element representing this component.</p>
1622 </div><div class="long"><p>Retrieves the top level element representing this component.</p>
1623 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1624 </li></ul></div></div></div><div id="method-getErrors" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getErrors" rel="method-getErrors" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-getErrors" class="viewSource">view source</a></div><a name="getErrors"></a><a name="method-getErrors"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getErrors" class="cls expand">getErrors</a>(
1625 <span class="pre">Mixed value</span>)
1626  : Array</div><div class="description"><div class="short">Runs this field's validators and returns an array of error messages for any validation failures.
1627 This is called inter...</div><div class="long"><p>Runs this field's validators and returns an array of error messages for any validation failures.
1628 This is called internally during validation and would not usually need to be used manually.</p>
1629
1630
1631 <p>Each subclass should override or augment the return value to provide their own errors.</p>
1632
1633 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value</span> : Mixed<div class="sub-desc"><p>The value to get errors for (defaults to the current field value)</p>
1634 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>All error messages for this field; an empty Array if none.</p>
1635 </li></ul></div></div></div><div id="method-getFieldLabel" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getFieldLabel" rel="method-getFieldLabel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-getFieldLabel" class="viewSource">view source</a></div><a name="getFieldLabel"></a><a name="method-getFieldLabel"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getFieldLabel" class="cls expand">getFieldLabel</a> : String</div><div class="description"><div class="short"><p>Returns the label for the field. Defaults to simply returning the <a href="Ext.form.field.Checkbox.html#fieldLabel" rel="Ext.form.field.Checkbox#fieldLabel" class="docClass">fieldLabel</a> config. Can be
1636 overridden to provide</p>
1637 </div><div class="long"><p>Returns the label for the field. Defaults to simply returning the <a href="Ext.form.field.Checkbox.html#fieldLabel" rel="Ext.form.field.Checkbox#fieldLabel" class="docClass">fieldLabel</a> config. Can be
1638 overridden to provide</p>
1639 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The configured field label, or empty string if not defined</p>
1640 </li></ul></div></div></div><div id="method-getHeight" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getHeight" rel="method-getHeight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getHeight" class="viewSource">view source</a></div><a name="getHeight"></a><a name="method-getHeight"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getHeight" class="cls expand">getHeight</a> : Number</div><div class="description"><div class="short"><p>Gets the current height of the component's underlying element.</p>
1641 </div><div class="long"><p>Gets the current height of the component's underlying element.</p>
1642 <h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;
1643 </li></ul></div></div></div><div id="method-getId" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getId" rel="method-getId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getId" class="viewSource">view source</a></div><a name="getId"></a><a name="method-getId"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getId" class="cls expand">getId</a> : void</div><div class="description"><div class="short"><p>Retrieves the id of this component.
1644 Will autogenerate an id if one has not already been set.</p>
1645 </div><div class="long"><p>Retrieves the id of this component.
1646 Will autogenerate an id if one has not already been set.</p>
1647 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1648 </li></ul></div></div></div><div id="method-getInputId" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getInputId" rel="method-getInputId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-getInputId" class="viewSource">view source</a></div><a name="getInputId"></a><a name="method-getInputId"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getInputId" class="cls expand">getInputId</a> : String</div><div class="description"><div class="short">Get the input id, if any, for this component. This is used as the "for" attribute on the label element.
1649 Implementing ...</div><div class="long"><p>Get the input id, if any, for this component. This is used as the "for" attribute on the label element.
1650 Implementing subclasses may also use this as e.g. the id for their own <tt>input</tt> element.</p>
1651 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The input id</p>
1652 </li></ul></div></div></div><div id="method-getInsertPosition" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getInsertPosition" rel="method-getInsertPosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getInsertPosition" class="viewSource">view source</a></div><a name="getInsertPosition"></a><a name="method-getInsertPosition"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getInsertPosition" class="cls expand">getInsertPosition</a>(
1653 <span class="pre">String/Number/Element/HTMLElement position</span>)
1654  : HTMLElement</div><div class="description"><div class="short">This function takes the position argument passed to onRender and returns a
1655 DOM element that you can use in the insert...</div><div class="long"><p>This function takes the position argument passed to onRender and returns a
1656 DOM element that you can use in the insertBefore.</p>
1657 <h3 class="pa">Parameters</h3><ul><li><span class="pre">position</span> : String/Number/Element/HTMLElement<div class="sub-desc"><p>Index, element id or element you want
1658 to put this component before.</p>
1659 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">HTMLElement</span>&nbsp; &nbsp;<p>DOM element that you can use in the insertBefore</p>
1660 </li></ul></div></div></div><div id="method-getLoader" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getLoader" rel="method-getLoader" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getLoader" class="viewSource">view source</a></div><a name="getLoader"></a><a name="method-getLoader"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getLoader" class="cls expand">getLoader</a> : Ext.ComponentLoader</div><div class="description"><div class="short"><p>Gets the <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> for this Component.</p>
1661 </div><div class="long"><p>Gets the <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> for this Component.</p>
1662 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.ComponentLoader</span>&nbsp; &nbsp;<p>The loader instance, null if it doesn't exist.</p>
1663 </li></ul></div></div></div><div id="method-getModelData" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getModelData" rel="method-getModelData" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-getModelData" class="viewSource">view source</a></div><a name="getModelData"></a><a name="method-getModelData"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getModelData" class="cls expand">getModelData</a> : Object</div><div class="description"><div class="short">Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when
1664 Ext.form.Basic.updateRe...</div><div class="long"><p>Returns the value(s) that should be saved to the <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Ext.data.Model</a> instance for this field, when
1665 <a href="Ext.form.Basic.html#updateRecord" rel="Ext.form.Basic#updateRecord" class="docClass">Ext.form.Basic.updateRecord</a> is called. Typically this will be an object with a single name-value
1666 pair, the name being this field's <a href="Ext.form.field.Checkbox.html#getName" rel="Ext.form.field.Checkbox#getName" class="docClass">name</a> and the value being its current data value. More
1667 advanced field implementations may return more than one name-value pair. The returned values will be
1668 saved to the corresponding field names in the Model.</p>
1669
1670
1671 <p>Note that the values returned from this method are not guaranteed to have been successfully
1672 <a href="Ext.form.field.Checkbox.html#validate" rel="Ext.form.field.Checkbox#validate" class="docClass">validated</a>.</p>
1673
1674 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>A mapping of submit parameter names to values; each value should be a string, or an array
1675 of strings if that particular name has multiple values. It can also return <tt>null</tt> if there are no
1676 parameters to be submitted.</p>
1677 </li></ul></div></div></div><div id="method-getName" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getName" rel="method-getName" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-getName" class="viewSource">view source</a></div><a name="getName"></a><a name="method-getName"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getName" class="cls expand">getName</a> : String</div><div class="description"><div class="short">Returns the name attribute of the field. This is used as the parameter
1678 name when including the field value in a form ...</div><div class="long"><p>Returns the <a href="Ext.form.field.Field.html#name" rel="Ext.form.field.Field#name" class="docClass">name</a> attribute of the field. This is used as the parameter
1679 name when including the field value in a <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">form submit()</a>.</p>
1680 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>name The field <a href="Ext.form.field.Field.html#name" rel="Ext.form.field.Field#name" class="docClass">name</a></p>
1681 </li></ul></div></div></div><div id="method-getPlugin" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getPlugin" rel="method-getPlugin" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getPlugin" class="viewSource">view source</a></div><a name="getPlugin"></a><a name="method-getPlugin"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getPlugin" class="cls expand">getPlugin</a>(
1682 <span class="pre">Object pluginId</span>)
1683  : Ext.AbstractPlugin</div><div class="description"><div class="short"><p>Retrieves a plugin by its pluginId which has been bound to this
1684 component.</p>
1685 </div><div class="long"><p>Retrieves a plugin by its pluginId which has been bound to this
1686 component.</p>
1687 <h3 class="pa">Parameters</h3><ul><li><span class="pre">pluginId</span> : Object<div class="sub-desc">
1688 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.AbstractPlugin</span>&nbsp; &nbsp;<p>pluginInstance</p>
1689 </li></ul></div></div></div><div id="method-getPosition" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getPosition" rel="method-getPosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-getPosition" class="viewSource">view source</a></div><a name="getPosition"></a><a name="method-getPosition"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getPosition" class="cls expand">getPosition</a>(
1690 <span class="pre">[Boolean local]</span>)
1691  : Array</div><div class="description"><div class="short"><p>Gets the current XY position of the component's underlying element.</p>
1692 </div><div class="long"><p>Gets the current XY position of the component's underlying element.</p>
1693 <h3 class="pa">Parameters</h3><ul><li><span class="pre">local</span> : Boolean<div class="sub-desc"><p>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</p>
1694 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The XY position of the element (e.g., [100, 200])</p>
1695 </li></ul></div></div></div><div id="method-getRawValue" class="member ni"><a href="Ext.form.field.Checkbox.html#method-getRawValue" rel="method-getRawValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-method-getRawValue" class="viewSource">view source</a></div><a name="getRawValue"></a><a name="method-getRawValue"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getRawValue" class="cls expand">getRawValue</a> : Boolean</div><div class="description"><div class="short"><p>Returns the checked state of the checkbox.</p>
1696 </div><div class="long"><p>Returns the checked state of the checkbox.</p>
1697 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if checked, else false</p>
1698 </li></ul></div></div></div><div id="method-getSize" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getSize" rel="method-getSize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getSize" class="viewSource">view source</a></div><a name="getSize"></a><a name="method-getSize"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getSize" class="cls expand">getSize</a> : Object</div><div class="description"><div class="short"><p>Gets the current size of the component's underlying element.</p>
1699 </div><div class="long"><p>Gets the current size of the component's underlying element.</p>
1700 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>An object containing the element's size {width: (element width), height: (element height)}</p>
1701 </li></ul></div></div></div><div id="method-getState" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getState" rel="method-getState" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-getState" class="viewSource">view source</a></div><a name="getState"></a><a name="method-getState"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getState" class="cls expand">getState</a> : Object</div><div class="description"><div class="short">Gets the current state of the object. By default this function returns null,
1702 it should be overridden in subclasses to...</div><div class="long"><p>Gets the current state of the object. By default this function returns null,
1703 it should be overridden in subclasses to implement methods for getting the state.</p>
1704 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The current state</p>
1705 </li></ul></div></div></div><div id="method-getStateId" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getStateId" rel="method-getStateId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-getStateId" class="viewSource">view source</a></div><a name="getStateId"></a><a name="method-getStateId"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getStateId" class="cls expand">getStateId</a> : String</div><div class="description"><div class="short"><p>Gets the state id for this object.</p>
1706 </div><div class="long"><p>Gets the state id for this object.</p>
1707 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The state id, null if not found.</p>
1708 </li></ul></div></div></div><div id="method-getSubmitData" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getSubmitData" rel="method-getSubmitData" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-getSubmitData" class="viewSource">view source</a></div><a name="getSubmitData"></a><a name="method-getSubmitData"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getSubmitData" class="cls expand">getSubmitData</a> : Object</div><div class="description"><div class="short">Returns the parameter(s) that would be included in a standard form submit for this field. Typically this
1709 will be an o...</div><div class="long"><p>Returns the parameter(s) that would be included in a standard form submit for this field. Typically this
1710 will be an object with a single name-value pair, the name being this field's <a href="Ext.form.field.Checkbox.html#getName" rel="Ext.form.field.Checkbox#getName" class="docClass">name</a> and the
1711 value being its current stringified value. More advanced field implementations may return more than one
1712 name-value pair.</p>
1713
1714
1715 <p>Note that the values returned from this method are not guaranteed to have been successfully
1716 <a href="Ext.form.field.Checkbox.html#validate" rel="Ext.form.field.Checkbox#validate" class="docClass">validated</a>.</p>
1717
1718 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>A mapping of submit parameter names to values; each value should be a string, or an array
1719 of strings if that particular name has multiple values. It can also return <tt>null</tt> if there are no
1720 parameters to be submitted.</p>
1721 </li></ul></div></div></div><div id="method-getSubmitValue" class="member ni"><a href="Ext.form.field.Checkbox.html#method-getSubmitValue" rel="method-getSubmitValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-method-getSubmitValue" class="viewSource">view source</a></div><a name="getSubmitValue"></a><a name="method-getSubmitValue"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getSubmitValue" class="cls expand">getSubmitValue</a> : Boolean/null</div><div class="description"><div class="short"><p>Returns the submit value for the checkbox which can be used when submitting forms.</p>
1722 </div><div class="long"><p>Returns the submit value for the checkbox which can be used when submitting forms.</p>
1723 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean/null</span>&nbsp; &nbsp;<p>True if checked; otherwise either the <a href="Ext.form.field.Checkbox.html#uncheckedValue" rel="Ext.form.field.Checkbox#uncheckedValue" class="docClass">uncheckedValue</a> or null.</p>
1724 </li></ul></div></div></div><div id="method-getValue" class="member ni"><a href="Ext.form.field.Checkbox.html#method-getValue" rel="method-getValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-method-getValue" class="viewSource">view source</a></div><a name="getValue"></a><a name="method-getValue"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getValue" class="cls expand">getValue</a> : Boolean</div><div class="description"><div class="short"><p>Returns the checked state of the checkbox.</p>
1725 </div><div class="long"><p>Returns the checked state of the checkbox.</p>
1726 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if checked, else false</p>
1727 </li></ul></div></div></div><div id="method-getWidth" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getWidth" rel="method-getWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getWidth" class="viewSource">view source</a></div><a name="getWidth"></a><a name="method-getWidth"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getWidth" class="cls expand">getWidth</a> : Number</div><div class="description"><div class="short"><p>Gets the current width of the component's underlying element.</p>
1728 </div><div class="long"><p>Gets the current width of the component's underlying element.</p>
1729 <h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;
1730 </li></ul></div></div></div><div id="method-getXType" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getXType" rel="method-getXType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-getXType" class="viewSource">view source</a></div><a name="getXType"></a><a name="method-getXType"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getXType" class="cls expand">getXType</a> : String</div><div class="description"><div class="short">Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all
1731 available xtypes, see th...</div><div class="long"><p>Gets the xtype for this component as registered with <a href="Ext.ComponentManager.html" rel="Ext.ComponentManager" class="docClass">Ext.ComponentManager</a>. For a list of all
1732 available xtypes, see the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> header. Example usage:</p>
1733
1734 <pre><code>var t = new Ext.form.field.Text();
1735 alert(t.getXType());  // alerts 'textfield'
1736 </code></pre>
1737
1738 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The xtype</p>
1739 </li></ul></div></div></div><div id="method-getXTypes" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-getXTypes" rel="method-getXTypes" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getXTypes" class="viewSource">view source</a></div><a name="getXTypes"></a><a name="method-getXTypes"></a><a href="Ext.form.field.Checkbox.html#" rel="method-getXTypes" class="cls expand">getXTypes</a> : String</div><div class="description"><div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
1740 available xtypes, see the Ext...</div><div class="long"><p>Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
1741 available xtypes, see the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> header.</p>
1742
1743
1744 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1745 to participate in determination of inherited xtypes.</b></p>
1746
1747
1748 <p>Example usage:</p>
1749
1750
1751 <pre><code>var t = new Ext.form.field.Text();
1752 alert(t.getXTypes());  // alerts 'component/field/textfield'
1753 </code></pre>
1754
1755 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The xtype hierarchy string</p>
1756 </li></ul></div></div></div><div id="method-hasActiveError" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-hasActiveError" rel="method-hasActiveError" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-hasActiveError" class="viewSource">view source</a></div><a name="hasActiveError"></a><a name="method-hasActiveError"></a><a href="Ext.form.field.Checkbox.html#" rel="method-hasActiveError" class="cls expand">hasActiveError</a> : Boolean</div><div class="description"><div class="short">Tells whether the field currently has an active error message. This does not trigger
1757 validation on its own, it merely...</div><div class="long"><p>Tells whether the field currently has an active error message. This does not trigger
1758 validation on its own, it merely looks for any message that the component may already hold.</p>
1759 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;
1760 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.form.field.Checkbox.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
1761 <span class="pre">String eventName</span>)
1762  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
1763 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
1764 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
1765 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
1766 </li></ul></div></div></div><div id="method-hasUICls" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-hasUICls" rel="method-hasUICls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-hasUICls" class="viewSource">view source</a></div><a name="hasUICls"></a><a name="method-hasUICls"></a><a href="Ext.form.field.Checkbox.html#" rel="method-hasUICls" class="cls expand">hasUICls</a>(
1767 <span class="pre">String cls</span>)
1768  : void</div><div class="description"><div class="short"><p>Checks if there is currently a specified uiCls</p>
1769 </div><div class="long"><p>Checks if there is currently a specified uiCls</p>
1770 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String<div class="sub-desc"><p>The cls to check</p>
1771 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1772 </li></ul></div></div></div><div id="method-hide" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-hide" rel="method-hide" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-hide" class="viewSource">view source</a></div><a name="hide"></a><a name="method-hide"></a><a href="Ext.form.field.Checkbox.html#" rel="method-hide" class="cls expand">hide</a>(
1773 <span class="pre">String/Element/Component animateTarget, [Function callback], [Object scope]</span>)
1774  : Ext.Component</div><div class="description"><div class="short"><p>Hides this Component, setting it to invisible using the configured <a href="Ext.form.field.Checkbox.html#hideMode" rel="Ext.form.field.Checkbox#hideMode" class="docClass">hideMode</a>.</p>
1775 </div><div class="long"><p>Hides this Component, setting it to invisible using the configured <a href="Ext.form.field.Checkbox.html#hideMode" rel="Ext.form.field.Checkbox#hideMode" class="docClass">hideMode</a>.</p>
1776 <h3 class="pa">Parameters</h3><ul><li><span class="pre">animateTarget</span> : String/Element/Component<div class="sub-desc"><p>Optional, and <b>only valid for <a href="Ext.form.field.Checkbox.html#floating" rel="Ext.form.field.Checkbox#floating" class="docClass">floating</a> Components such as
1777 <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Window</a>s or <a href="Ext.tip.ToolTip.html" rel="Ext.tip.ToolTip" class="docClass">ToolTip</a>s, or regular Components which have been configured
1778 with <code>floating: true</code>.</b>.
1779 The target to which the Component should animate while hiding (defaults to null with no animation)</p>
1780 </div></li><li><span class="pre">callback</span> : Function<div class="sub-desc"><p>(optional) A callback function to call after the Component is hidden.</p>
1781 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to this Component.</p>
1782 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1783 </li></ul></div></div></div><div id="method-initField" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-initField" rel="method-initField" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-initField" class="viewSource">view source</a></div><a name="initField"></a><a name="method-initField"></a><a href="Ext.form.field.Checkbox.html#" rel="method-initField" class="cls expand">initField</a> : void</div><div class="description"><div class="short">Initializes this Field mixin on the current instance. Components using this mixin should call
1784 this method during thei...</div><div class="long"><p>Initializes this Field mixin on the current instance. Components using this mixin should call
1785 this method during their own initialization process.</p>
1786 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1787 </li></ul></div></div></div><div id="method-initLabelable" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-initLabelable" rel="method-initLabelable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-initLabelable" class="viewSource">view source</a></div><a name="initLabelable"></a><a name="method-initLabelable"></a><a href="Ext.form.field.Checkbox.html#" rel="method-initLabelable" class="cls expand">initLabelable</a> : void</div><div class="description"><div class="short">Performs initialization of this mixin. Component classes using this mixin should call this method
1788 during their own in...</div><div class="long"><p>Performs initialization of this mixin. Component classes using this mixin should call this method
1789 during their own initialization.</p>
1790 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1791 </li></ul></div></div></div><div id="method-is" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-is" rel="method-is" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-is" class="viewSource">view source</a></div><a name="is"></a><a name="method-is"></a><a href="Ext.form.field.Checkbox.html#" rel="method-is" class="cls expand">is</a>(
1792 <span class="pre">String selector</span>)
1793  : Boolean</div><div class="description"><div class="short"><p>Tests whether this Component matches the selector string.</p>
1794 </div><div class="long"><p>Tests whether this Component matches the selector string.</p>
1795 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>The selector string to test against.</p>
1796 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if this Component matches the selector.</p>
1797 </li></ul></div></div></div><div id="method-isDescendantOf" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-isDescendantOf" rel="method-isDescendantOf" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isDescendantOf" class="viewSource">view source</a></div><a name="isDescendantOf"></a><a name="method-isDescendantOf"></a><a href="Ext.form.field.Checkbox.html#" rel="method-isDescendantOf" class="cls expand">isDescendantOf</a>(
1798 <span class="pre">Ext.Container container</span>)
1799  : Boolean</div><div class="description"><div class="short"><p>Determines whether this component is the descendant of a particular container.</p>
1800 </div><div class="long"><p>Determines whether this component is the descendant of a particular container.</p>
1801 <h3 class="pa">Parameters</h3><ul><li><span class="pre">container</span> : Ext.Container<div class="sub-desc">
1802 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>isDescendant</p>
1803 </li></ul></div></div></div><div id="method-isDirty" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-isDirty" rel="method-isDirty" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-isDirty" class="viewSource">view source</a></div><a name="isDirty"></a><a name="method-isDirty"></a><a href="Ext.form.field.Checkbox.html#" rel="method-isDirty" class="cls expand">isDirty</a> : Boolean</div><div class="description"><div class="short">Returns true if the value of this Field has been changed from its originalValue.
1804 Will always return false if the fiel...</div><div class="long"><p>Returns true if the value of this Field has been changed from its <a href="Ext.form.field.Checkbox.html#originalValue" rel="Ext.form.field.Checkbox#originalValue" class="docClass">originalValue</a>.
1805 Will always return false if the field is disabled.</p>
1806
1807
1808 <p>Note that if the owning <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">form</a> was configured with
1809 <a href="Ext.form.Basic.html#trackResetOnLoad" rel="Ext.form.Basic#trackResetOnLoad" class="docClass">trackResetOnLoad</a>
1810 then the <a href="Ext.form.field.Checkbox.html#originalValue" rel="Ext.form.field.Checkbox#originalValue" class="docClass">originalValue</a> is updated when the values are loaded by
1811 <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">Ext.form.Basic</a>.<a href="Ext.form.Basic.html#setValues" rel="Ext.form.Basic#setValues" class="docClass">setValues</a>.</p>
1812
1813 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if this field has been changed from its original value (and
1814 is not disabled), false otherwise.</p>
1815 </li></ul></div></div></div><div id="method-isDisabled" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-isDisabled" rel="method-isDisabled" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isDisabled" class="viewSource">view source</a></div><a name="isDisabled"></a><a name="method-isDisabled"></a><a href="Ext.form.field.Checkbox.html#" rel="method-isDisabled" class="cls expand">isDisabled</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is currently disabled.</p>
1816 </div><div class="long"><p>Method to determine whether this Component is currently disabled.</p>
1817 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the disabled state of this Component.</p>
1818 </li></ul></div></div></div><div id="method-isDraggable" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-isDraggable" rel="method-isDraggable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isDraggable" class="viewSource">view source</a></div><a name="isDraggable"></a><a name="method-isDraggable"></a><a href="Ext.form.field.Checkbox.html#" rel="method-isDraggable" class="cls expand">isDraggable</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is draggable.</p>
1819 </div><div class="long"><p>Method to determine whether this Component is draggable.</p>
1820 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the draggable state of this component.</p>
1821 </li></ul></div></div></div><div id="method-isDroppable" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-isDroppable" rel="method-isDroppable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isDroppable" class="viewSource">view source</a></div><a name="isDroppable"></a><a name="method-isDroppable"></a><a href="Ext.form.field.Checkbox.html#" rel="method-isDroppable" class="cls expand">isDroppable</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is droppable.</p>
1822 </div><div class="long"><p>Method to determine whether this Component is droppable.</p>
1823 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the droppable state of this component.</p>
1824 </li></ul></div></div></div><div id="method-isEqual" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-isEqual" rel="method-isEqual" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-isEqual" class="viewSource">view source</a></div><a name="isEqual"></a><a name="method-isEqual"></a><a href="Ext.form.field.Checkbox.html#" rel="method-isEqual" class="cls expand">isEqual</a>(
1825 <span class="pre">Mixed value1, Mixed value2</span>)
1826  : Boolean</div><div class="description"><div class="short">Returns whether two field values are logically equal. Field implementations may override
1827 this to provide custom compa...</div><div class="long"><p>Returns whether two field <a href="Ext.form.field.Checkbox.html#getValue" rel="Ext.form.field.Checkbox#getValue" class="docClass">values</a> are logically equal. Field implementations may override
1828 this to provide custom comparison logic appropriate for the particular field's data type.</p>
1829 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value1</span> : Mixed<div class="sub-desc"><p>The first value to compare</p>
1830 </div></li><li><span class="pre">value2</span> : Mixed<div class="sub-desc"><p>The second value to compare</p>
1831 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the values are equal, false if inequal.</p>
1832 </li></ul></div></div></div><div id="method-isFileUpload" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-isFileUpload" rel="method-isFileUpload" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-isFileUpload" class="viewSource">view source</a></div><a name="isFileUpload"></a><a name="method-isFileUpload"></a><a href="Ext.form.field.Checkbox.html#" rel="method-isFileUpload" class="cls expand">isFileUpload</a> : Boolean</div><div class="description"><div class="short">Returns whether this Field is a file upload field; if it returns true, forms will use
1833 special techniques for submitti...</div><div class="long"><p>Returns whether this Field is a file upload field; if it returns true, forms will use
1834 special techniques for <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submitting the form</a> via AJAX. See
1835 <a href="Ext.form.Basic.html#hasUpload" rel="Ext.form.Basic#hasUpload" class="docClass">Ext.form.Basic.hasUpload</a> for details. If this returns true, the <a href="Ext.form.field.Checkbox.html#extractFileInput" rel="Ext.form.field.Checkbox#extractFileInput" class="docClass">extractFileInput</a>
1836 method must also be implemented to return the corresponding file input element.</p>
1837 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;
1838 </li></ul></div></div></div><div id="method-isFloating" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-isFloating" rel="method-isFloating" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isFloating" class="viewSource">view source</a></div><a name="isFloating"></a><a name="method-isFloating"></a><a href="Ext.form.field.Checkbox.html#" rel="method-isFloating" class="cls expand">isFloating</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is floating.</p>
1839 </div><div class="long"><p>Method to determine whether this Component is floating.</p>
1840 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the floating state of this component.</p>
1841 </li></ul></div></div></div><div id="method-isHidden" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-isHidden" rel="method-isHidden" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isHidden" class="viewSource">view source</a></div><a name="isHidden"></a><a name="method-isHidden"></a><a href="Ext.form.field.Checkbox.html#" rel="method-isHidden" class="cls expand">isHidden</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is currently set to hidden.</p>
1842 </div><div class="long"><p>Method to determine whether this Component is currently set to hidden.</p>
1843 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the hidden state of this Component.</p>
1844 </li></ul></div></div></div><div id="method-isValid" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-isValid" rel="method-isValid" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-isValid" class="viewSource">view source</a></div><a name="isValid"></a><a name="method-isValid"></a><a href="Ext.form.field.Checkbox.html#" rel="method-isValid" class="cls expand">isValid</a> : Boolean</div><div class="description"><div class="short">Returns whether or not the field value is currently valid by validating the
1845 field's current value. The validitychange...</div><div class="long"><p>Returns whether or not the field value is currently valid by <a href="Ext.form.field.Checkbox.html#getErrors" rel="Ext.form.field.Checkbox#getErrors" class="docClass">validating</a> the
1846 field's current value. The <a href="Ext.form.field.Checkbox.html#validitychange" rel="Ext.form.field.Checkbox#validitychange" class="docClass">validitychange</a> event will not be fired; use <a href="Ext.form.field.Checkbox.html#validate" rel="Ext.form.field.Checkbox#validate" class="docClass">validate</a>
1847 instead if you want the event to fire. <b>Note</b>: <a href="Ext.form.field.Checkbox.html#disabled" rel="Ext.form.field.Checkbox#disabled" class="docClass">disabled</a> fields are always treated as valid.</p>
1848
1849
1850 <p>Implementations are encouraged to ensure that this method does not have side-effects such as
1851 triggering error message display.</p>
1852
1853 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the value is valid, else false</p>
1854 </li></ul></div></div></div><div id="method-isVisible" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-isVisible" rel="method-isVisible" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isVisible" class="viewSource">view source</a></div><a name="isVisible"></a><a name="method-isVisible"></a><a href="Ext.form.field.Checkbox.html#" rel="method-isVisible" class="cls expand">isVisible</a>(
1855 <span class="pre">Boolean deep</span>)
1856  : Boolean</div><div class="description"><div class="short"><p>Returns true if this component is visible.</p>
1857 </div><div class="long"><p>Returns true if this component is visible.</p>
1858 <h3 class="pa">Parameters</h3><ul><li><span class="pre">deep</span> : Boolean<div class="sub-desc"><p>. <p>Optional. Pass <code>true</code> to interrogate the visibility status of all
1859 parent Containers to determine whether this Component is truly visible to the user.</p></p>
1860
1861 <p>Generally, to determine whether a Component is hidden, the no argument form is needed. For example
1862 when creating dynamically laid out UIs in a hidden Container before showing them.</p>
1863
1864 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if this component is visible, false otherwise.</p>
1865 </li></ul></div></div></div><div id="method-isXType" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-isXType" rel="method-isXType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isXType" class="viewSource">view source</a></div><a name="isXType"></a><a name="method-isXType"></a><a href="Ext.form.field.Checkbox.html#" rel="method-isXType" class="cls expand">isXType</a>(
1866 <span class="pre">String xtype, [Boolean shallow]</span>)
1867  : Boolean</div><div class="description"><div class="short">Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1868 from th...</div><div class="long"><p>Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1869 from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
1870
1871
1872 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1873 to participate in determination of inherited xtypes.</b></p>
1874
1875
1876 <p>For a list of all available xtypes, see the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> header.</p>
1877
1878
1879 <p>Example usage:</p>
1880
1881
1882 <pre><code>var t = new Ext.form.field.Text();
1883 var isText = t.isXType('textfield');        // true
1884 var isBoxSubclass = t.isXType('field');       // true, descended from <a href="Ext.form.field.Base.html" rel="Ext.form.field.Base" class="docClass">Ext.form.field.Base</a>
1885 var isBoxInstance = t.isXType('field', true); // false, not a direct <a href="Ext.form.field.Base.html" rel="Ext.form.field.Base" class="docClass">Ext.form.field.Base</a> instance
1886 </code></pre>
1887
1888 <h3 class="pa">Parameters</h3><ul><li><span class="pre">xtype</span> : String<div class="sub-desc"><p>The xtype to check for this Component</p>
1889 </div></li><li><span class="pre">shallow</span> : Boolean<div class="sub-desc"><p>(optional) False to check whether this Component is descended from the xtype (this is
1890 the default), or true to check whether this Component is directly of the specified xtype.</p>
1891 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if this component descends from the specified xtype, false otherwise.</p>
1892 </li></ul></div></div></div><div id="method-markInvalid" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-markInvalid" rel="method-markInvalid" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-markInvalid" class="viewSource">view source</a></div><a name="markInvalid"></a><a name="method-markInvalid"></a><a href="Ext.form.field.Checkbox.html#" rel="method-markInvalid" class="cls expand">markInvalid</a>(
1893 <span class="pre">String/Array errors</span>)
1894  : void</div><div class="description"><div class="short">Display one or more error messages associated with this field, using msgTarget to determine how to
1895 display the messag...</div><div class="long"><p>Display one or more error messages associated with this field, using <a href="Ext.form.field.Checkbox.html#msgTarget" rel="Ext.form.field.Checkbox#msgTarget" class="docClass">msgTarget</a> to determine how to
1896 display the messages and applying <a href="Ext.form.field.Checkbox.html#invalidCls" rel="Ext.form.field.Checkbox#invalidCls" class="docClass">invalidCls</a> to the field's UI element.</p>
1897
1898
1899 <p><b>Note</b>: this method does not cause the Field's <a href="Ext.form.field.Checkbox.html#validate" rel="Ext.form.field.Checkbox#validate" class="docClass">validate</a> or <a href="Ext.form.field.Checkbox.html#isValid" rel="Ext.form.field.Checkbox#isValid" class="docClass">isValid</a> methods to
1900 return <code>false</code> if the value does <i>pass</i> validation. So simply marking a Field as invalid
1901 will not prevent submission of forms submitted with the <a href="Ext.form.action.Submit.html#clientValidation" rel="Ext.form.action.Submit#clientValidation" class="docClass">Ext.form.action.Submit.clientValidation</a>
1902 option set.</p>
1903
1904 <h3 class="pa">Parameters</h3><ul><li><span class="pre">errors</span> : String/Array<div class="sub-desc"><p>The validation message(s) to display.</p>
1905 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1906 </li></ul></div></div></div><div id="method-nextNode" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-nextNode" rel="method-nextNode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-nextNode" class="viewSource">view source</a></div><a name="nextNode"></a><a name="method-nextNode"></a><a href="Ext.form.field.Checkbox.html#" rel="method-nextNode" class="cls expand">nextNode</a>(
1907 <span class="pre">String selector, Object includeSelf</span>)
1908  : void</div><div class="description"><div class="short">Returns the next node in the Component tree in tree traversal order.
1909
1910
1911 Note that this is not limited to siblings, and...</div><div class="long"><p>Returns the next node in the Component tree in tree traversal order.</p>
1912
1913
1914 <p>Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will
1915 walk the tree to attempt to find a match. Contrast with <a href="Ext.form.field.Checkbox.html#pnextSibling" rel="Ext.form.field.Checkbox#pnextSibling" class="docClass">pnextSibling</a>.</p>
1916
1917 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional A <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector to filter the following nodes.</p>
1918 </div></li><li><span class="pre">includeSelf</span> : Object<div class="sub-desc">
1919 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>The next node (or the next node which matches the selector). Returns null if there is no matching node.</p>
1920 </li></ul></div></div></div><div id="method-nextSibling" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-nextSibling" rel="method-nextSibling" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-nextSibling" class="viewSource">view source</a></div><a name="nextSibling"></a><a name="method-nextSibling"></a><a href="Ext.form.field.Checkbox.html#" rel="method-nextSibling" class="cls expand">nextSibling</a>(
1921 <span class="pre">String selector</span>)
1922  : void</div><div class="description"><div class="short">Returns the next sibling of this Component.
1923
1924
1925 Optionally selects the next sibling which matches the passed ComponentQ...</div><div class="long"><p>Returns the next sibling of this Component.</p>
1926
1927
1928 <p>Optionally selects the next sibling which matches the passed <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector.</p>
1929
1930
1931 <p>May also be refered to as <code><b>next()</b></code></p>
1932
1933
1934 <p>Note that this is limited to siblings, and if no siblings of the item match, <code>null</code> is returned. Contrast with <a href="Ext.form.field.Checkbox.html#nextNode" rel="Ext.form.field.Checkbox#nextNode" class="docClass">nextNode</a></p>
1935
1936 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional A <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector to filter the following items.</p>
1937 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.</p>
1938 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.form.field.Checkbox.html#" rel="method-observe" class="cls expand">observe</a>(
1939 <span class="pre">Function c, Object listeners</span>)
1940  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
1941
1942 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
1943
1944 <p>This makes any event fired on any instance of the passed class also fire a single event through
1945 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
1946
1947 <p>Usage:</p>
1948
1949 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
1950 Ext.data.Connection.on('beforerequest', function(con, options) {
1951     console.log('Ajax request made to ' + options.url);
1952 });
1953 </code></pre>
1954 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
1955 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.form.field.Checkbox.html#addListener" rel="Ext.form.field.Checkbox#addListener" class="docClass">addListener</a>.</p>
1956 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1957 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.form.field.Checkbox.html#" rel="method-on" class="cls expand">on</a>(
1958 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
1959  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.form.field.Checkbox.html#addListener" rel="Ext.form.field.Checkbox#addListener" class="docClass">addListener</a>.)</p>
1960 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.form.field.Checkbox.html#addListener" rel="Ext.form.field.Checkbox#addListener" class="docClass">addListener</a>.)</p>
1961 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
1962 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
1963 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
1964 <b>If omitted, defaults to the object which fired the event.</b></p>
1965 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
1966 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1967 </li></ul></div></div></div><div id="method-previousNode" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-previousNode" rel="method-previousNode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-previousNode" class="viewSource">view source</a></div><a name="previousNode"></a><a name="method-previousNode"></a><a href="Ext.form.field.Checkbox.html#" rel="method-previousNode" class="cls expand">previousNode</a>(
1968 <span class="pre">String selector, Object includeSelf</span>)
1969  : void</div><div class="description"><div class="short">Returns the previous node in the Component tree in tree traversal order.
1970
1971
1972 Note that this is not limited to siblings,...</div><div class="long"><p>Returns the previous node in the Component tree in tree traversal order.</p>
1973
1974
1975 <p>Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will
1976 walk the tree in reverse order to attempt to find a match. Contrast with <a href="Ext.form.field.Checkbox.html#previousSibling" rel="Ext.form.field.Checkbox#previousSibling" class="docClass">previousSibling</a>.</p>
1977
1978 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional. A <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector to filter the preceding nodes.</p>
1979 </div></li><li><span class="pre">includeSelf</span> : Object<div class="sub-desc">
1980 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>The previous node (or the previous node which matches the selector). Returns null if there is no matching node.</p>
1981 </li></ul></div></div></div><div id="method-previousSibling" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-previousSibling" rel="method-previousSibling" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-previousSibling" class="viewSource">view source</a></div><a name="previousSibling"></a><a name="method-previousSibling"></a><a href="Ext.form.field.Checkbox.html#" rel="method-previousSibling" class="cls expand">previousSibling</a>(
1982 <span class="pre">String selector</span>)
1983  : void</div><div class="description"><div class="short">Returns the previous sibling of this Component.
1984
1985
1986 Optionally selects the previous sibling which matches the passed Co...</div><div class="long"><p>Returns the previous sibling of this Component.</p>
1987
1988
1989 <p>Optionally selects the previous sibling which matches the passed <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector.</p>
1990
1991
1992 <p>May also be refered to as <code><b>prev()</b></code></p>
1993
1994
1995 <p>Note that this is limited to siblings, and if no siblings of the item match, <code>null</code> is returned. Contrast with <a href="Ext.form.field.Checkbox.html#previousNode" rel="Ext.form.field.Checkbox#previousNode" class="docClass">previousNode</a></p>
1996
1997 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional. A <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector to filter the preceding items.</p>
1998 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.</p>
1999 </li></ul></div></div></div><div id="method-processRawValue" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-processRawValue" rel="method-processRawValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-processRawValue" class="viewSource">view source</a></div><a name="processRawValue"></a><a name="method-processRawValue"></a><a href="Ext.form.field.Checkbox.html#" rel="method-processRawValue" class="cls expand">processRawValue</a>(
2000 <span class="pre">Mixed value</span>)
2001  : Mixed</div><div class="description"><div class="short">Performs any necessary manipulation of a raw field value to prepare it for conversion
2002 and/or validation, for instance...</div><div class="long"><p>Performs any necessary manipulation of a raw field value to prepare it for <a href="Ext.form.field.Checkbox.html#rawToValue" rel="Ext.form.field.Checkbox#rawToValue" class="docClass">conversion</a>
2003 and/or <a href="Ext.form.field.Checkbox.html#validate" rel="Ext.form.field.Checkbox#validate" class="docClass">validation</a>, for instance stripping out ignored characters. In the base implementation
2004 it does nothing; individual subclasses may override this as needed.</p>
2005 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value</span> : Mixed<div class="sub-desc"><p>The unprocessed string value</p>
2006 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>The processed string value</p>
2007 </li></ul></div></div></div><div id="method-rawToValue" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-rawToValue" rel="method-rawToValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-rawToValue" class="viewSource">view source</a></div><a name="rawToValue"></a><a name="method-rawToValue"></a><a href="Ext.form.field.Checkbox.html#" rel="method-rawToValue" class="cls expand">rawToValue</a>(
2008 <span class="pre">Mixed rawValue</span>)
2009  : Mixed</div><div class="description"><div class="short">Converts a raw input field value into a mixed-type value that is suitable for this particular field type.
2010 This allows...</div><div class="long"><p>Converts a raw input field value into a mixed-type value that is suitable for this particular field type.
2011 This allows controlling the normalization and conversion of user-entered values into field-type-appropriate
2012 values, e.g. a Date object for <a href="Ext.form.field.Date.html" rel="Ext.form.field.Date" class="docClass">Ext.form.field.Date</a>, and is invoked by <a href="Ext.form.field.Checkbox.html#getValue" rel="Ext.form.field.Checkbox#getValue" class="docClass">getValue</a>.</p>
2013
2014
2015 <p>It is up to individual implementations to decide how to handle raw values that cannot be successfully
2016 converted to the desired object type.</p>
2017
2018
2019 <p>See <a href="Ext.form.field.Checkbox.html#valueToRaw" rel="Ext.form.field.Checkbox#valueToRaw" class="docClass">valueToRaw</a> for the opposite conversion.</p>
2020
2021
2022 <p>The base implementation does no conversion, returning the raw value untouched.</p>
2023
2024 <h3 class="pa">Parameters</h3><ul><li><span class="pre">rawValue</span> : Mixed<div class="sub-desc">
2025 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>The converted value.</p>
2026 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.form.field.Checkbox.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
2027 <span class="pre">Object origin, Array events, Object prefix</span>)
2028  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
2029 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
2030 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
2031 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
2032 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
2033 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2034 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.form.field.Checkbox.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
2035 <span class="pre">Observable o</span>)
2036  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
2037 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
2038 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
2039 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2040 </li></ul></div></div></div><div id="method-removeCls" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-removeCls" rel="method-removeCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-removeCls" class="viewSource">view source</a></div><a name="removeCls"></a><a name="method-removeCls"></a><a href="Ext.form.field.Checkbox.html#" rel="method-removeCls" class="cls expand">removeCls</a>(
2041 <span class="pre">Object className</span>)
2042  : Ext.Component</div><div class="description"><div class="short"><p>Removes a CSS class from the top level element representing this component.</p>
2043 </div><div class="long"><p>Removes a CSS class from the top level element representing this component.</p>
2044 <h3 class="pa">Parameters</h3><ul><li><span class="pre">className</span> : Object<div class="sub-desc">
2045 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>Returns the Component to allow method chaining.</p>
2046 </li></ul></div></div></div><div id="method-removeClsWithUI" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-removeClsWithUI" rel="method-removeClsWithUI" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-removeClsWithUI" class="viewSource">view source</a></div><a name="removeClsWithUI"></a><a name="method-removeClsWithUI"></a><a href="Ext.form.field.Checkbox.html#" rel="method-removeClsWithUI" class="cls expand">removeClsWithUI</a>(
2047 <span class="pre">String/Array cls</span>)
2048  : void</div><div class="description"><div class="short">Removes a cls to the uiCls array, which will also call removeUIClsToElement and removes
2049 it from all elements of this ...</div><div class="long"><p>Removes a cls to the uiCls array, which will also call <a href="Ext.form.field.Checkbox.html#removeUIClsToElement" rel="Ext.form.field.Checkbox#removeUIClsToElement" class="docClass">removeUIClsToElement</a> and removes
2050 it from all elements of this component.</p>
2051 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String/Array<div class="sub-desc"><p>A string or an array of strings to remove to the uiCls</p>
2052 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2053 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.form.field.Checkbox.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
2054 <span class="pre">String eventName, Function handler, [Object scope]</span>)
2055  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
2056 </div><div class="long"><p>Removes an event handler.</p>
2057 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
2058 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.form.field.Checkbox.html#addListener" rel="Ext.form.field.Checkbox#addListener" class="docClass">addListener</a> call.</b></p>
2059 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
2060 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2061 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.form.field.Checkbox.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
2062 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
2063  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.form.field.Checkbox.html#mon" rel="Ext.form.field.Checkbox#mon" class="docClass">mon</a> method.</p>
2064 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.form.field.Checkbox.html#mon" rel="Ext.form.field.Checkbox#mon" class="docClass">mon</a> method.</p>
2065 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
2066 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
2067 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
2068 is the handler function.</p>
2069 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
2070 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
2071 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2072 </li></ul></div></div></div><div id="method-reset" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-reset" rel="method-reset" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-reset" class="viewSource">view source</a></div><a name="reset"></a><a name="method-reset"></a><a href="Ext.form.field.Checkbox.html#" rel="method-reset" class="cls expand">reset</a> : void</div><div class="description"><div class="short">Resets the current field value to the originally loaded value and clears any validation messages.
2073 See Ext.form.Basic....</div><div class="long"><p>Resets the current field value to the originally loaded value and clears any validation messages.
2074 See <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">Ext.form.Basic</a>.<a href="Ext.form.Basic.html#trackResetOnLoad" rel="Ext.form.Basic#trackResetOnLoad" class="docClass">trackResetOnLoad</a></p>
2075 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2076 </li></ul></div></div></div><div id="method-resetOriginalValue" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-resetOriginalValue" rel="method-resetOriginalValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-resetOriginalValue" class="viewSource">view source</a></div><a name="resetOriginalValue"></a><a name="method-resetOriginalValue"></a><a href="Ext.form.field.Checkbox.html#" rel="method-resetOriginalValue" class="cls expand">resetOriginalValue</a> : void</div><div class="description"><div class="short">Resets the field's originalValue property so it matches the current value.
2077 This is called by Ext.form.Basic.setValues...</div><div class="long"><p>Resets the field's <a href="Ext.form.field.Checkbox.html#originalValue" rel="Ext.form.field.Checkbox#originalValue" class="docClass">originalValue</a> property so it matches the current <a href="Ext.form.field.Checkbox.html#getValue" rel="Ext.form.field.Checkbox#getValue" class="docClass">value</a>.
2078 This is called by <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">Ext.form.Basic</a>.<a href="Ext.form.Basic.html#setValues" rel="Ext.form.Basic#setValues" class="docClass">setValues</a> if the form's
2079 <a href="Ext.form.Basic.html#trackResetOnLoad" rel="Ext.form.Basic#trackResetOnLoad" class="docClass">trackResetOnLoad</a> property is set to true.</p>
2080 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2081 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.form.field.Checkbox.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
2082 If events were suspended using the queueSuspended parameter, then all
2083 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.form.field.Checkbox.html#suspendEvents" rel="Ext.form.field.Checkbox#suspendEvents" class="docClass">suspendEvents</a>)
2084 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
2085 events fired during event suspension will be sent to any listeners now.</p>
2086 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2087 </li></ul></div></div></div><div id="method-sequenceFx" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-sequenceFx" rel="method-sequenceFx" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-sequenceFx" class="viewSource">view source</a></div><a name="sequenceFx"></a><a name="method-sequenceFx"></a><a href="Ext.form.field.Checkbox.html#" rel="method-sequenceFx" class="cls expand">sequenceFx</a> : Ext.core.Element</div><div class="description"><div class="short">Ensures that all effects queued after sequenceFx is called on this object are
2088 run in sequence.  This is the opposite ...</div><div class="long"><p>Ensures that all effects queued after sequenceFx is called on this object are
2089 run in sequence.  This is the opposite of <a href="Ext.form.field.Checkbox.html#syncFx" rel="Ext.form.field.Checkbox#syncFx" class="docClass">syncFx</a>.</p>
2090 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The Element</p>
2091 </li></ul></div></div></div><div id="method-setActive" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setActive" rel="method-setActive" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-setActive" class="viewSource">view source</a></div><a name="setActive"></a><a name="method-setActive"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setActive" class="cls expand">setActive</a>(
2092 <span class="pre">Boolean active, Component newActive</span>)
2093  : void</div><div class="description"><div class="short">This method is called internally by Ext.ZIndexManager to signal that a floating
2094 Component has either been moved to th...</div><div class="long"><p>This method is called internally by <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">Ext.ZIndexManager</a> to signal that a floating
2095 Component has either been moved to the top of its zIndex stack, or pushed from the top of its zIndex stack.</p>
2096
2097
2098 <p>If a <i>Window</i> is superceded by another Window, deactivating it hides its shadow.</p>
2099
2100
2101 <p>This method also fires the <a href="Ext.form.field.Checkbox.html#activate" rel="Ext.form.field.Checkbox#activate" class="docClass">activate</a> or <a href="Ext.form.field.Checkbox.html#deactivate" rel="Ext.form.field.Checkbox#deactivate" class="docClass">deactivate</a> event depending on which action occurred.</p>
2102
2103 <h3 class="pa">Parameters</h3><ul><li><span class="pre">active</span> : Boolean<div class="sub-desc"><p>True to activate the Component, false to deactivate it (defaults to false)</p>
2104 </div></li><li><span class="pre">newActive</span> : Component<div class="sub-desc"><p>The newly active Component which is taking over topmost zIndex position.</p>
2105 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2106 </li></ul></div></div></div><div id="method-setActiveError" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setActiveError" rel="method-setActiveError" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-setActiveError" class="viewSource">view source</a></div><a name="setActiveError"></a><a name="method-setActiveError"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setActiveError" class="cls expand">setActiveError</a>(
2107 <span class="pre">String msg</span>)
2108  : void</div><div class="description"><div class="short">Sets the active error message to the given string. This replaces the entire error message
2109 contents with the given str...</div><div class="long"><p>Sets the active error message to the given string. This replaces the entire error message
2110 contents with the given string. Also see <a href="Ext.form.field.Checkbox.html#setActiveErrors" rel="Ext.form.field.Checkbox#setActiveErrors" class="docClass">setActiveErrors</a> which accepts an Array of
2111 messages and formats them according to the <a href="Ext.form.field.Checkbox.html#activeErrorsTpl" rel="Ext.form.field.Checkbox#activeErrorsTpl" class="docClass">activeErrorsTpl</a>.</p>
2112 <h3 class="pa">Parameters</h3><ul><li><span class="pre">msg</span> : String<div class="sub-desc"><p>The error message</p>
2113 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2114 </li></ul></div></div></div><div id="method-setActiveErrors" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setActiveErrors" rel="method-setActiveErrors" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-setActiveErrors" class="viewSource">view source</a></div><a name="setActiveErrors"></a><a name="method-setActiveErrors"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setActiveErrors" class="cls expand">setActiveErrors</a>(
2115 <span class="pre">Array errors</span>)
2116  : void</div><div class="description"><div class="short">Set the active error message to an Array of error messages. The messages are formatted into
2117 a single message string u...</div><div class="long"><p>Set the active error message to an Array of error messages. The messages are formatted into
2118 a single message string using the <a href="Ext.form.field.Checkbox.html#activeErrorsTpl" rel="Ext.form.field.Checkbox#activeErrorsTpl" class="docClass">activeErrorsTpl</a>. Also see <a href="Ext.form.field.Checkbox.html#setActiveError" rel="Ext.form.field.Checkbox#setActiveError" class="docClass">setActiveError</a>
2119 which allows setting the entire error contents with a single string.</p>
2120 <h3 class="pa">Parameters</h3><ul><li><span class="pre">errors</span> : Array<div class="sub-desc"><p>The error messages</p>
2121 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2122 </li></ul></div></div></div><div id="method-setAutoScroll" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setAutoScroll" rel="method-setAutoScroll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-setAutoScroll" class="viewSource">view source</a></div><a name="setAutoScroll"></a><a name="method-setAutoScroll"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setAutoScroll" class="cls expand">setAutoScroll</a>(
2123 <span class="pre">Boolean scroll</span>)
2124  : Ext.Component</div><div class="description"><div class="short"><p>Sets the overflow on the content element of the component.</p>
2125 </div><div class="long"><p>Sets the overflow on the content element of the component.</p>
2126 <h3 class="pa">Parameters</h3><ul><li><span class="pre">scroll</span> : Boolean<div class="sub-desc"><p>True to allow the Component to auto scroll.</p>
2127 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2128 </li></ul></div></div></div><div id="method-setDisabled" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setDisabled" rel="method-setDisabled" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setDisabled" class="viewSource">view source</a></div><a name="setDisabled"></a><a name="method-setDisabled"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setDisabled" class="cls expand">setDisabled</a>(
2129 <span class="pre">Boolean disabled</span>)
2130  : void</div><div class="description"><div class="short"><p>Enable or disable the component.</p>
2131 </div><div class="long"><p>Enable or disable the component.</p>
2132 <h3 class="pa">Parameters</h3><ul><li><span class="pre">disabled</span> : Boolean<div class="sub-desc">
2133 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2134 </li></ul></div></div></div><div id="method-setDocked" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setDocked" rel="method-setDocked" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setDocked" class="viewSource">view source</a></div><a name="setDocked"></a><a name="method-setDocked"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setDocked" class="cls expand">setDocked</a>(
2135 <span class="pre">Object dock, Object layoutParent</span>)
2136  : Component</div><div class="description"><div class="short">Sets the dock position of this component in its parent panel. Note that
2137 this only has effect if this item is part of ...</div><div class="long"><p>Sets the dock position of this component in its parent panel. Note that
2138 this only has effect if this item is part of the dockedItems collection
2139 of a parent that has a DockLayout (note that any Panel has a DockLayout
2140 by default)</p>
2141 <h3 class="pa">Parameters</h3><ul><li><span class="pre">dock</span> : Object<div class="sub-desc">
2142 </div></li><li><span class="pre">layoutParent</span> : Object<div class="sub-desc">
2143 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
2144 </li></ul></div></div></div><div id="method-setFieldDefaults" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setFieldDefaults" rel="method-setFieldDefaults" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-setFieldDefaults" class="viewSource">view source</a></div><a name="setFieldDefaults"></a><a name="method-setFieldDefaults"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setFieldDefaults" class="cls expand">setFieldDefaults</a>(
2145 <span class="pre">Object defaults</span>)
2146  : void</div><div class="description"><div class="short">Applies a set of default configuration values to this Labelable instance. For each of the
2147 properties in the given obj...</div><div class="long"><p>Applies a set of default configuration values to this Labelable instance. For each of the
2148 properties in the given object, check if this component hasOwnProperty that config; if not
2149 then it's inheriting a default value from its prototype and we should apply the default value.</p>
2150 <h3 class="pa">Parameters</h3><ul><li><span class="pre">defaults</span> : Object<div class="sub-desc"><p>The defaults to apply to the object.</p>
2151 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2152 </li></ul></div></div></div><div id="method-setFieldStyle" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setFieldStyle" rel="method-setFieldStyle" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-setFieldStyle" class="viewSource">view source</a></div><a name="setFieldStyle"></a><a name="method-setFieldStyle"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setFieldStyle" class="cls expand">setFieldStyle</a>(
2153 <span class="pre">String/Object/Function style</span>)
2154  : void</div><div class="description"><div class="short"><p>Set the <a href="Ext.form.field.Checkbox.html#fieldStyle" rel="Ext.form.field.Checkbox#fieldStyle" class="docClass">CSS style</a> of the <a href="Ext.form.field.Checkbox.html#inputEl" rel="Ext.form.field.Checkbox#inputEl" class="docClass">field input element</a>.</p>
2155 </div><div class="long"><p>Set the <a href="Ext.form.field.Checkbox.html#fieldStyle" rel="Ext.form.field.Checkbox#fieldStyle" class="docClass">CSS style</a> of the <a href="Ext.form.field.Checkbox.html#inputEl" rel="Ext.form.field.Checkbox#inputEl" class="docClass">field input element</a>.</p>
2156 <h3 class="pa">Parameters</h3><ul><li><span class="pre">style</span> : String/Object/Function<div class="sub-desc"><p>The style(s) to apply. Should be a valid argument to
2157 <a href="Ext.core.Element.html#applyStyles" rel="Ext.core.Element#applyStyles" class="docClass">Ext.core.Element.applyStyles</a>.</p>
2158 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2159 </li></ul></div></div></div><div id="method-setHeight" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setHeight" rel="method-setHeight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setHeight" class="viewSource">view source</a></div><a name="setHeight"></a><a name="method-setHeight"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setHeight" class="cls expand">setHeight</a>(
2160 <span class="pre">Number height</span>)
2161  : Ext.Component</div><div class="description"><div class="short"><p>Sets the height of the component.  This method fires the <a href="Ext.form.field.Checkbox.html#resize" rel="Ext.form.field.Checkbox#resize" class="docClass">resize</a> event.</p>
2162 </div><div class="long"><p>Sets the height of the component.  This method fires the <a href="Ext.form.field.Checkbox.html#resize" rel="Ext.form.field.Checkbox#resize" class="docClass">resize</a> event.</p>
2163 <h3 class="pa">Parameters</h3><ul><li><span class="pre">height</span> : Number<div class="sub-desc"><p>The new height to set. This may be one of:<div class="mdetail-params"><ul>
2164 <li>A Number specifying the new height in the <a href="Ext.form.field.Checkbox.html#getEl" rel="Ext.form.field.Checkbox#getEl" class="docClass">Element</a>'s <a href="Ext.core.Element.html#defaultUnit" rel="Ext.core.Element#defaultUnit" class="docClass">Ext.core.Element.defaultUnit</a>s (by default, pixels).</li>
2165 <li>A String used to set the CSS height style.</li>
2166 <li><i>undefined</i> to leave the height unchanged.</li>
2167 </ul></div></p>
2168 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2169 </li></ul></div></div></div><div id="method-setLoading" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setLoading" rel="method-setLoading" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setLoading" class="viewSource">view source</a></div><a name="setLoading"></a><a name="method-setLoading"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setLoading" class="cls expand">setLoading</a>(
2170 <span class="pre">Boolean/Object/String load, Boolean targetEl</span>)
2171  : Ext.LoadMask</div><div class="description"><div class="short"><p>This method allows you to show or hide a LoadMask on top of this component.</p>
2172 </div><div class="long"><p>This method allows you to show or hide a LoadMask on top of this component.</p>
2173 <h3 class="pa">Parameters</h3><ul><li><span class="pre">load</span> : Boolean/Object/String<div class="sub-desc"><p>True to show the default LoadMask, a config object
2174 that will be passed to the LoadMask constructor, or a message String to show. False to
2175 hide the current LoadMask.</p>
2176 </div></li><li><span class="pre">targetEl</span> : Boolean<div class="sub-desc"><p>True to mask the targetEl of this Component instead of the this.el.
2177 For example, setting this to true on a Panel will cause only the body to be masked. (defaults to false)</p>
2178 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.LoadMask</span>&nbsp; &nbsp;<p>The LoadMask instance that has just been shown.</p>
2179 </li></ul></div></div></div><div id="method-setPagePosition" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setPagePosition" rel="method-setPagePosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-setPagePosition" class="viewSource">view source</a></div><a name="setPagePosition"></a><a name="method-setPagePosition"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setPagePosition" class="cls expand">setPagePosition</a>(
2180 <span class="pre">Number x, Number y, Mixed animate</span>)
2181  : Ext.Component</div><div class="description"><div class="short">Sets the page XY position of the component.  To set the left and top instead, use setPosition.
2182 This method fires the ...</div><div class="long"><p>Sets the page XY position of the component.  To set the left and top instead, use <a href="Ext.form.field.Checkbox.html#setPosition" rel="Ext.form.field.Checkbox#setPosition" class="docClass">setPosition</a>.
2183 This method fires the <a href="Ext.form.field.Checkbox.html#move" rel="Ext.form.field.Checkbox#move" class="docClass">move</a> event.</p>
2184 <h3 class="pa">Parameters</h3><ul><li><span class="pre">x</span> : Number<div class="sub-desc"><p>The new x position</p>
2185 </div></li><li><span class="pre">y</span> : Number<div class="sub-desc"><p>The new y position</p>
2186 </div></li><li><span class="pre">animate</span> : Mixed<div class="sub-desc"><p>If passed, the Component is <i>animated</i> into its new position. If this parameter
2187 is a number, it is used as the animation duration in milliseconds.</p>
2188 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2189 </li></ul></div></div></div><div id="method-setPosition" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setPosition" rel="method-setPosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-setPosition" class="viewSource">view source</a></div><a name="setPosition"></a><a name="method-setPosition"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setPosition" class="cls expand">setPosition</a>(
2190 <span class="pre">Number left, Number top, Mixed animate</span>)
2191  : Ext.Component</div><div class="description"><div class="short">Sets the left and top of the component.  To set the page XY position instead, use setPagePosition.
2192 This method fires ...</div><div class="long"><p>Sets the left and top of the component.  To set the page XY position instead, use <a href="Ext.form.field.Checkbox.html#setPagePosition" rel="Ext.form.field.Checkbox#setPagePosition" class="docClass">setPagePosition</a>.
2193 This method fires the <a href="Ext.form.field.Checkbox.html#move" rel="Ext.form.field.Checkbox#move" class="docClass">move</a> event.</p>
2194 <h3 class="pa">Parameters</h3><ul><li><span class="pre">left</span> : Number<div class="sub-desc"><p>The new left</p>
2195 </div></li><li><span class="pre">top</span> : Number<div class="sub-desc"><p>The new top</p>
2196 </div></li><li><span class="pre">animate</span> : Mixed<div class="sub-desc"><p>If true, the Component is <i>animated</i> into its new position. You may also pass an animation configuration.</p>
2197 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2198 </li></ul></div></div></div><div id="method-setRawValue" class="member ni"><a href="Ext.form.field.Checkbox.html#method-setRawValue" rel="method-setRawValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-method-setRawValue" class="viewSource">view source</a></div><a name="setRawValue"></a><a name="method-setRawValue"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setRawValue" class="cls expand">setRawValue</a>(
2199 <span class="pre">Boolean/String value</span>)
2200  : Boolean</div><div class="description"><div class="short"><p>Sets the checked state of the checkbox.</p>
2201 </div><div class="long"><p>Sets the checked state of the checkbox.</p>
2202 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value</span> : Boolean/String<div class="sub-desc"><p>The following values will check the checkbox:
2203 <code>true, 'true', '1', or 'on'</code>, as well as a String that matches the <a href="Ext.form.field.Checkbox.html#inputValue" rel="Ext.form.field.Checkbox#inputValue" class="docClass">inputValue</a>.
2204 Any other value will uncheck the checkbox.</p>
2205 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the new checked state of the checkbox</p>
2206 </li></ul></div></div></div><div id="method-setReadOnly" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setReadOnly" rel="method-setReadOnly" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-setReadOnly" class="viewSource">view source</a></div><a name="setReadOnly"></a><a name="method-setReadOnly"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setReadOnly" class="cls expand">setReadOnly</a>(
2207 <span class="pre">Boolean readOnly</span>)
2208  : void</div><div class="description"><div class="short"><p>Sets the read only state of this field.</p>
2209 </div><div class="long"><p>Sets the read only state of this field.</p>
2210 <h3 class="pa">Parameters</h3><ul><li><span class="pre">readOnly</span> : Boolean<div class="sub-desc"><p>Whether the field should be read only.</p>
2211 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2212 </li></ul></div></div></div><div id="method-setSize" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setSize" rel="method-setSize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setSize" class="viewSource">view source</a></div><a name="setSize"></a><a name="method-setSize"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setSize" class="cls expand">setSize</a>(
2213 <span class="pre">Mixed width, Mixed height</span>)
2214  : Ext.Component</div><div class="description"><div class="short">Sets the width and height of this Component. This method fires the resize event. This method can accept
2215 either width ...</div><div class="long"><p>Sets the width and height of this Component. This method fires the <a href="Ext.form.field.Checkbox.html#resize" rel="Ext.form.field.Checkbox#resize" class="docClass">resize</a> event. This method can accept
2216 either width and height as separate arguments, or you can pass a size object like <code>{width:10, height:20}</code>.</p>
2217 <h3 class="pa">Parameters</h3><ul><li><span class="pre">width</span> : Mixed<div class="sub-desc"><p>The new width to set. This may be one of:<div class="mdetail-params"><ul>
2218 <li>A Number specifying the new width in the <a href="Ext.form.field.Checkbox.html#getEl" rel="Ext.form.field.Checkbox#getEl" class="docClass">Element</a>'s <a href="Ext.core.Element.html#defaultUnit" rel="Ext.core.Element#defaultUnit" class="docClass">Ext.core.Element.defaultUnit</a>s (by default, pixels).</li>
2219 <li>A String used to set the CSS width style.</li>
2220 <li>A size object in the format <code>{width: widthValue, height: heightValue}</code>.</li>
2221 <li><code>undefined</code> to leave the width unchanged.</li>
2222 </ul></div></p>
2223 </div></li><li><span class="pre">height</span> : Mixed<div class="sub-desc"><p>The new height to set (not required if a size object is passed as the first arg).
2224 This may be one of:<div class="mdetail-params"><ul>
2225 <li>A Number specifying the new height in the <a href="Ext.form.field.Checkbox.html#getEl" rel="Ext.form.field.Checkbox#getEl" class="docClass">Element</a>'s <a href="Ext.core.Element.html#defaultUnit" rel="Ext.core.Element#defaultUnit" class="docClass">Ext.core.Element.defaultUnit</a>s (by default, pixels).</li>
2226 <li>A String used to set the CSS height style. Animation may <b>not</b> be used.</li>
2227 <li><code>undefined</code> to leave the height unchanged.</li>
2228 </ul></div></p>
2229 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2230 </li></ul></div></div></div><div id="method-setUI" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setUI" rel="method-setUI" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setUI" class="viewSource">view source</a></div><a name="setUI"></a><a name="method-setUI"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setUI" class="cls expand">setUI</a>(
2231 <span class="pre">String ui</span>)
2232  : void</div><div class="description"><div class="short">Sets the UI for the component. This will remove any existing UIs on the component. It will also
2233 loop through any uiCl...</div><div class="long"><p>Sets the UI for the component. This will remove any existing UIs on the component. It will also
2234 loop through any uiCls set on the component and rename them so they include the new UI</p>
2235 <h3 class="pa">Parameters</h3><ul><li><span class="pre">ui</span> : String<div class="sub-desc"><p>The new UI for the component</p>
2236 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2237 </li></ul></div></div></div><div id="method-setValue" class="member ni"><a href="Ext.form.field.Checkbox.html#method-setValue" rel="method-setValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Checkbox.html" class="definedIn docClass">Ext.form.field.Checkbox</a><br/><a href="../source/Checkbox.html#Ext-form.field.Checkbox-method-setValue" class="viewSource">view source</a></div><a name="setValue"></a><a name="method-setValue"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setValue" class="cls expand">setValue</a>(
2238 <span class="pre">Boolean/String checked</span>)
2239  : Ext.form.field.Checkbox</div><div class="description"><div class="short"><p>Sets the checked state of the checkbox, and invokes change detection.</p>
2240 </div><div class="long"><p>Sets the checked state of the checkbox, and invokes change detection.</p>
2241 <h3 class="pa">Parameters</h3><ul><li><span class="pre">checked</span> : Boolean/String<div class="sub-desc"><p>The following values will check the checkbox:
2242 <code>true, 'true', '1', or 'on'</code>, as well as a String that matches the <a href="Ext.form.field.Checkbox.html#inputValue" rel="Ext.form.field.Checkbox#inputValue" class="docClass">inputValue</a>.
2243 Any other value will uncheck the checkbox.</p>
2244 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.form.field.Checkbox</span>&nbsp; &nbsp;<p>this</p>
2245 </li></ul></div></div></div><div id="method-setVisible" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setVisible" rel="method-setVisible" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setVisible" class="viewSource">view source</a></div><a name="setVisible"></a><a name="method-setVisible"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setVisible" class="cls expand">setVisible</a>(
2246 <span class="pre">Boolean visible</span>)
2247  : Ext.Component</div><div class="description"><div class="short"><p>Convenience function to hide or show this component by boolean.</p>
2248 </div><div class="long"><p>Convenience function to hide or show this component by boolean.</p>
2249 <h3 class="pa">Parameters</h3><ul><li><span class="pre">visible</span> : Boolean<div class="sub-desc"><p>True to show, false to hide</p>
2250 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2251 </li></ul></div></div></div><div id="method-setWidth" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-setWidth" rel="method-setWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setWidth" class="viewSource">view source</a></div><a name="setWidth"></a><a name="method-setWidth"></a><a href="Ext.form.field.Checkbox.html#" rel="method-setWidth" class="cls expand">setWidth</a>(
2252 <span class="pre">Number width</span>)
2253  : Ext.Component</div><div class="description"><div class="short"><p>Sets the width of the component.  This method fires the <a href="Ext.form.field.Checkbox.html#resize" rel="Ext.form.field.Checkbox#resize" class="docClass">resize</a> event.</p>
2254 </div><div class="long"><p>Sets the width of the component.  This method fires the <a href="Ext.form.field.Checkbox.html#resize" rel="Ext.form.field.Checkbox#resize" class="docClass">resize</a> event.</p>
2255 <h3 class="pa">Parameters</h3><ul><li><span class="pre">width</span> : Number<div class="sub-desc"><p>The new width to setThis may be one of:<div class="mdetail-params"><ul>
2256 <li>A Number specifying the new width in the <a href="Ext.form.field.Checkbox.html#getEl" rel="Ext.form.field.Checkbox#getEl" class="docClass">Element</a>'s <a href="Ext.core.Element.html#defaultUnit" rel="Ext.core.Element#defaultUnit" class="docClass">Ext.core.Element.defaultUnit</a>s (by default, pixels).</li>
2257 <li>A String used to set the CSS width style.</li>
2258 </ul></div></p>
2259 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2260 </li></ul></div></div></div><div id="method-show" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-show" rel="method-show" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-show" class="viewSource">view source</a></div><a name="show"></a><a name="method-show"></a><a href="Ext.form.field.Checkbox.html#" rel="method-show" class="cls expand">show</a>(
2261 <span class="pre">String/Element animateTarget, [Function callback], [Object scope]</span>)
2262  : Component</div><div class="description"><div class="short">Shows this Component, rendering it first if autoRender or {&quot;floating are true.
2263
2264
2265 After being shown, a floating C...</div><div class="long"><p>Shows this Component, rendering it first if <a href="Ext.form.field.Checkbox.html#autoRender" rel="Ext.form.field.Checkbox#autoRender" class="docClass">autoRender</a> or {<a href="Ext.form.field.Checkbox.html"floating" rel=""floating" class="docClass">&quot;floating</a> are <code>true</code>.</p>
2266
2267
2268 <p>After being shown, a <a href="Ext.form.field.Checkbox.html#floating" rel="Ext.form.field.Checkbox#floating" class="docClass">floating</a> Component (such as a <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Ext.window.Window</a>), is activated it and brought to the front of
2269 its <a href="Ext.form.field.Checkbox.html#ZIndexManager" rel="Ext.form.field.Checkbox#ZIndexManager" class="docClass">z-index stack</a>.</p>
2270
2271 <h3 class="pa">Parameters</h3><ul><li><span class="pre">animateTarget</span> : String/Element<div class="sub-desc"><p>Optional, and <b>only valid for <a href="Ext.form.field.Checkbox.html#floating" rel="Ext.form.field.Checkbox#floating" class="docClass">floating</a> Components such as
2272 <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Window</a>s or <a href="Ext.tip.ToolTip.html" rel="Ext.tip.ToolTip" class="docClass">ToolTip</a>s, or regular Components which have been configured
2273 with <code>floating: true</code>.</b> The target from which the Component should
2274 animate from while opening (defaults to null with no animation)</p>
2275 </div></li><li><span class="pre">callback</span> : Function<div class="sub-desc"><p>(optional) A callback function to call after the Component is displayed. Only necessary if animation was specified.</p>
2276 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to this Component.</p>
2277 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
2278 </li></ul></div></div></div><div id="method-stopAnimation" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-stopAnimation" rel="method-stopAnimation" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-stopAnimation" class="viewSource">view source</a></div><a name="stopAnimation"></a><a name="method-stopAnimation"></a><a href="Ext.form.field.Checkbox.html#" rel="method-stopAnimation" class="cls expand">stopAnimation</a> : Ext.core.Element</div><div class="description"><div class="short">@deprecated 4.0 Replaced by stopAnimation
2279 Stops any running effects and clears this object's internal effects queue i...</div><div class="long"><p>@deprecated 4.0 Replaced by <a href="Ext.form.field.Checkbox.html#stopAnimation" rel="Ext.form.field.Checkbox#stopAnimation" class="docClass">stopAnimation</a>
2280 Stops any running effects and clears this object's internal effects queue if it contains
2281 any additional effects that haven't started yet.</p>
2282 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The Element</p>
2283 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.form.field.Checkbox.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
2284 <span class="pre">Boolean queueSuspended</span>)
2285  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.form.field.Checkbox.html#resumeEvents" rel="Ext.form.field.Checkbox#resumeEvents" class="docClass">resumeEvents</a>)</p>
2286 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.form.field.Checkbox.html#resumeEvents" rel="Ext.form.field.Checkbox#resumeEvents" class="docClass">resumeEvents</a>)</p>
2287 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
2288 after the <a href="Ext.form.field.Checkbox.html#resumeEvents" rel="Ext.form.field.Checkbox#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
2289 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2290 </li></ul></div></div></div><div id="method-syncFx" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-syncFx" rel="method-syncFx" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-syncFx" class="viewSource">view source</a></div><a name="syncFx"></a><a name="method-syncFx"></a><a href="Ext.form.field.Checkbox.html#" rel="method-syncFx" class="cls expand">syncFx</a> : Ext.core.Element</div><div class="description"><div class="short">Ensures that all effects queued after syncFx is called on this object are
2291 run concurrently.  This is the opposite of ...</div><div class="long"><p>Ensures that all effects queued after syncFx is called on this object are
2292 run concurrently.  This is the opposite of <a href="Ext.form.field.Checkbox.html#sequenceFx" rel="Ext.form.field.Checkbox#sequenceFx" class="docClass">sequenceFx</a>.</p>
2293 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The Element</p>
2294 </li></ul></div></div></div><div id="method-toBack" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-toBack" rel="method-toBack" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-toBack" class="viewSource">view source</a></div><a name="toBack"></a><a name="method-toBack"></a><a href="Ext.form.field.Checkbox.html#" rel="method-toBack" class="cls expand">toBack</a> : Component</div><div class="description"><div class="short"><p>Sends this Component to the back of (lower z-index than) any other visible windows</p>
2295 </div><div class="long"><p>Sends this Component to the back of (lower z-index than) any other visible windows</p>
2296 <h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
2297 </li></ul></div></div></div><div id="method-toFront" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-toFront" rel="method-toFront" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-toFront" class="viewSource">view source</a></div><a name="toFront"></a><a name="method-toFront"></a><a href="Ext.form.field.Checkbox.html#" rel="method-toFront" class="cls expand">toFront</a>(
2298 <span class="pre">[Boolean preventFocus]</span>)
2299  : Component</div><div class="description"><div class="short">Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManag...</div><div class="long"><p>Brings this floating Component to the front of any other visible, floating Components managed by the same <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">ZIndexManager</a></p>
2300
2301
2302 <p>If this Component is modal, inserts the modal mask just below this Component in the z-index stack.</p>
2303
2304 <h3 class="pa">Parameters</h3><ul><li><span class="pre">preventFocus</span> : Boolean<div class="sub-desc"><p>(optional) Specify <code>true</code> to prevent the Component from being focused.</p>
2305 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
2306 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.form.field.Checkbox.html#" rel="method-un" class="cls expand">un</a>(
2307 <span class="pre">String eventName, Function handler, [Object scope]</span>)
2308  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.form.field.Checkbox.html#removeListener" rel="Ext.form.field.Checkbox#removeListener" class="docClass">removeListener</a>.)</p>
2309 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.form.field.Checkbox.html#removeListener" rel="Ext.form.field.Checkbox#removeListener" class="docClass">removeListener</a>.)</p>
2310 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
2311 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.form.field.Checkbox.html#addListener" rel="Ext.form.field.Checkbox#addListener" class="docClass">addListener</a> call.</b></p>
2312 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
2313 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2314 </li></ul></div></div></div><div id="method-unsetActiveError" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-unsetActiveError" rel="method-unsetActiveError" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-unsetActiveError" class="viewSource">view source</a></div><a name="unsetActiveError"></a><a name="method-unsetActiveError"></a><a href="Ext.form.field.Checkbox.html#" rel="method-unsetActiveError" class="cls expand">unsetActiveError</a> : void</div><div class="description"><div class="short"><p>Clears the active error.</p>
2315 </div><div class="long"><p>Clears the active error.</p>
2316 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2317 </li></ul></div></div></div><div id="method-up" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-up" rel="method-up" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-up" class="viewSource">view source</a></div><a name="up"></a><a name="method-up"></a><a href="Ext.form.field.Checkbox.html#" rel="method-up" class="cls expand">up</a>(
2318 <span class="pre">String selector</span>)
2319  : Container</div><div class="description"><div class="short">Walks up the ownerCt axis looking for an ancestor Container which matches
2320 the passed simple selector.
2321
2322
2323 Example:
2324 var ...</div><div class="long"><p>Walks up the <code>ownerCt</code> axis looking for an ancestor Container which matches
2325 the passed simple selector.</p>
2326
2327
2328 <p>Example:
2329 <pre><code>var owningTabPanel = grid.up('tabpanel');
2330 </code></pre>
2331
2332 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional. The simple selector to test.</p>
2333 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Container</span>&nbsp; &nbsp;<p>The matching ancestor Container (or <code>undefined</code> if no match was found).</p>
2334 </li></ul></div></div></div><div id="method-update" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-update" rel="method-update" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-update" class="viewSource">view source</a></div><a name="update"></a><a name="method-update"></a><a href="Ext.form.field.Checkbox.html#" rel="method-update" class="cls expand">update</a>(
2335 <span class="pre">Mixed htmlOrData, [Boolean loadScripts], [Function callback]</span>)
2336  : void</div><div class="description"><div class="short"><p>Update the content area of a component.</p>
2337 </div><div class="long"><p>Update the content area of a component.</p>
2338 <h3 class="pa">Parameters</h3><ul><li><span class="pre">htmlOrData</span> : Mixed<div class="sub-desc"><p>If this component has been configured with a template via the tpl config
2339 then it will use this argument as data to populate the template.
2340 If this component was not configured with a template, the components
2341 content area will be updated via <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Ext.core.Element</a> update</p>
2342 </div></li><li><span class="pre">loadScripts</span> : Boolean<div class="sub-desc"><p>(optional) Only legitimate when using the html configuration. Defaults to false</p>
2343 </div></li><li><span class="pre">callback</span> : Function<div class="sub-desc"><p>(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading</p>
2344 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2345 </li></ul></div></div></div><div id="method-updateBox" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-updateBox" rel="method-updateBox" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-updateBox" class="viewSource">view source</a></div><a name="updateBox"></a><a name="method-updateBox"></a><a href="Ext.form.field.Checkbox.html#" rel="method-updateBox" class="cls expand">updateBox</a>(
2346 <span class="pre">Object box</span>)
2347  : Ext.Component</div><div class="description"><div class="short"><p>Sets the current box measurements of the component's underlying element.</p>
2348 </div><div class="long"><p>Sets the current box measurements of the component's underlying element.</p>
2349 <h3 class="pa">Parameters</h3><ul><li><span class="pre">box</span> : Object<div class="sub-desc"><p>An object in the format {x, y, width, height}</p>
2350 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2351 </li></ul></div></div></div><div id="method-validate" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-validate" rel="method-validate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-validate" class="viewSource">view source</a></div><a name="validate"></a><a name="method-validate"></a><a href="Ext.form.field.Checkbox.html#" rel="method-validate" class="cls expand">validate</a> : Boolean</div><div class="description"><div class="short">Returns whether or not the field value is currently valid by validating the
2352 field's current value, and fires the vali...</div><div class="long"><p>Returns whether or not the field value is currently valid by <a href="Ext.form.field.Checkbox.html#getErrors" rel="Ext.form.field.Checkbox#getErrors" class="docClass">validating</a> the
2353 field's current value, and fires the <a href="Ext.form.field.Checkbox.html#validitychange" rel="Ext.form.field.Checkbox#validitychange" class="docClass">validitychange</a> event if the field's validity has
2354 changed since the last validation. <b>Note</b>: <a href="Ext.form.field.Checkbox.html#disabled" rel="Ext.form.field.Checkbox#disabled" class="docClass">disabled</a> fields are always treated as valid.</p>
2355
2356
2357 <p>Custom implementations of this method are allowed to have side-effects such as triggering error
2358 message display. To validate without side-effects, use <a href="Ext.form.field.Checkbox.html#isValid" rel="Ext.form.field.Checkbox#isValid" class="docClass">isValid</a>.</p>
2359
2360 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the value is valid, else false</p>
2361 </li></ul></div></div></div><div id="method-validateValue" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-validateValue" rel="method-validateValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-validateValue" class="viewSource">view source</a></div><a name="validateValue"></a><a name="method-validateValue"></a><a href="Ext.form.field.Checkbox.html#" rel="method-validateValue" class="cls expand">validateValue</a>(
2362 <span class="pre">Mixed value</span>)
2363  : Boolean</div><div class="description"><div class="short">Uses getErrors to build an array of validation errors. If any errors are found, they are passed
2364 to markInvalid and fa...</div><div class="long"><p>Uses <a href="Ext.form.field.Checkbox.html#getErrors" rel="Ext.form.field.Checkbox#getErrors" class="docClass">getErrors</a> to build an array of validation errors. If any errors are found, they are passed
2365 to <a href="Ext.form.field.Checkbox.html#markInvalid" rel="Ext.form.field.Checkbox#markInvalid" class="docClass">markInvalid</a> and false is returned, otherwise true is returned.</p>
2366
2367
2368 <p>Previously, subclasses were invited to provide an implementation of this to process validations - from 3.2
2369 onwards <a href="Ext.form.field.Checkbox.html#getErrors" rel="Ext.form.field.Checkbox#getErrors" class="docClass">getErrors</a> should be overridden instead.</p>
2370
2371 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value</span> : Mixed<div class="sub-desc"><p>The value to validate</p>
2372 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if all validations passed, false if one or more failed</p>
2373 </li></ul></div></div></div><div id="method-valueToRaw" class="member inherited"><a href="Ext.form.field.Checkbox.html#method-valueToRaw" rel="method-valueToRaw" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-valueToRaw" class="viewSource">view source</a></div><a name="valueToRaw"></a><a name="method-valueToRaw"></a><a href="Ext.form.field.Checkbox.html#" rel="method-valueToRaw" class="cls expand">valueToRaw</a>(
2374 <span class="pre">Mixed value</span>)
2375  : Mixed</div><div class="description"><div class="short">Converts a mixed-type value to a raw representation suitable for displaying in the field. This allows
2376 controlling how...</div><div class="long"><p>Converts a mixed-type value to a raw representation suitable for displaying in the field. This allows
2377 controlling how value objects passed to <a href="Ext.form.field.Checkbox.html#setValue" rel="Ext.form.field.Checkbox#setValue" class="docClass">setValue</a> are shown to the user, including localization.
2378 For instance, for a <a href="Ext.form.field.Date.html" rel="Ext.form.field.Date" class="docClass">Ext.form.field.Date</a>, this would control how a Date object passed to <a href="Ext.form.field.Checkbox.html#setValue" rel="Ext.form.field.Checkbox#setValue" class="docClass">setValue</a>
2379 would be converted to a String for display in the field.</p>
2380
2381
2382 <p>See <a href="Ext.form.field.Checkbox.html#rawToValue" rel="Ext.form.field.Checkbox#rawToValue" class="docClass">rawToValue</a> for the opposite conversion.</p>
2383
2384
2385 <p>The base implementation simply does a standard toString conversion, and converts
2386 <a href="Ext.html#isEmpty" rel="Ext#isEmpty" class="docClass">empty values</a> to an empty string.</p>
2387
2388 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value</span> : Mixed<div class="sub-desc"><p>The mixed-type value to convert to the raw representation.</p>
2389 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>The converted raw value.</p>
2390 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-activate" class="member f inherited"><a href="Ext.form.field.Checkbox.html#event-activate" rel="event-activate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-activate" class="viewSource">view source</a></div><a name="activate"></a><a name="event-activate"></a><a href="Ext.form.field.Checkbox.html#" rel="event-activate" class="cls expand">activate</a>(
2391 <span class="pre">Ext.Component this</span>)
2392 </div><div class="description"><div class="short"><p>Fires after a Component has been visually activated.</p>
2393 </div><div class="long"><p>Fires after a Component has been visually activated.</p>
2394 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2395 </div></li></ul></div></div></div><div id="event-added" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-added" rel="event-added" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-added" class="viewSource">view source</a></div><a name="added"></a><a name="event-added"></a><a href="Ext.form.field.Checkbox.html#" rel="event-added" class="cls expand">added</a>(
2396 <span class="pre">Ext.Component this, Ext.container.Container container, Number pos</span>)
2397 </div><div class="description"><div class="short"><p>Fires after a Component had been added to a Container.</p>
2398 </div><div class="long"><p>Fires after a Component had been added to a Container.</p>
2399 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2400 </div></li><li><span class="pre">container</span> : Ext.container.Container<div class="sub-desc"><p>Parent Container</p>
2401 </div></li><li><span class="pre">pos</span> : Number<div class="sub-desc"><p>position of Component</p>
2402 </div></li></ul></div></div></div><div id="event-afterrender" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-afterrender" rel="event-afterrender" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-afterrender" class="viewSource">view source</a></div><a name="afterrender"></a><a name="event-afterrender"></a><a href="Ext.form.field.Checkbox.html#" rel="event-afterrender" class="cls expand">afterrender</a>(
2403 <span class="pre">Ext.Component this</span>)
2404 </div><div class="description"><div class="short">Fires after the component rendering is finished.
2405
2406
2407 The afterrender event is fired after this Component has been rende...</div><div class="long"><p>Fires after the component rendering is finished.</p>
2408
2409
2410 <p>The afterrender event is fired after this Component has been <a href="Ext.form.field.Checkbox.html#rendered" rel="Ext.form.field.Checkbox#rendered" class="docClass">rendered</a>, been postprocesed
2411 by any afterRender method defined for the Component.</p>
2412
2413 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2414 </div></li></ul></div></div></div><div id="event-beforeactivate" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-beforeactivate" rel="event-beforeactivate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforeactivate" class="viewSource">view source</a></div><a name="beforeactivate"></a><a name="event-beforeactivate"></a><a href="Ext.form.field.Checkbox.html#" rel="event-beforeactivate" class="cls expand">beforeactivate</a>(
2415 <span class="pre">Ext.Component this</span>)
2416 </div><div class="description"><div class="short">Fires before a Component has been visually activated.
2417 Returning false from an event listener can prevent the activate...</div><div class="long"><p>Fires before a Component has been visually activated.
2418 Returning false from an event listener can prevent the activate
2419 from occurring.</p>
2420 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2421 </div></li></ul></div></div></div><div id="event-beforedeactivate" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-beforedeactivate" rel="event-beforedeactivate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforedeactivate" class="viewSource">view source</a></div><a name="beforedeactivate"></a><a name="event-beforedeactivate"></a><a href="Ext.form.field.Checkbox.html#" rel="event-beforedeactivate" class="cls expand">beforedeactivate</a>(
2422 <span class="pre">Ext.Component this</span>)
2423 </div><div class="description"><div class="short">Fires before a Component has been visually deactivated.
2424 Returning false from an event listener can prevent the deacti...</div><div class="long"><p>Fires before a Component has been visually deactivated.
2425 Returning false from an event listener can prevent the deactivate
2426 from occurring.</p>
2427 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2428 </div></li></ul></div></div></div><div id="event-beforedestroy" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-beforedestroy" rel="event-beforedestroy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforedestroy" class="viewSource">view source</a></div><a name="beforedestroy"></a><a name="event-beforedestroy"></a><a href="Ext.form.field.Checkbox.html#" rel="event-beforedestroy" class="cls expand">beforedestroy</a>(
2429 <span class="pre">Ext.Component this</span>)
2430 </div><div class="description"><div class="short"><p>Fires before the component is <a href="Ext.form.field.Checkbox.html#destroy" rel="Ext.form.field.Checkbox#destroy" class="docClass">destroy</a>ed. Return false from an event handler to stop the <a href="Ext.form.field.Checkbox.html#destroy" rel="Ext.form.field.Checkbox#destroy" class="docClass">destroy</a>.</p>
2431 </div><div class="long"><p>Fires before the component is <a href="Ext.form.field.Checkbox.html#destroy" rel="Ext.form.field.Checkbox#destroy" class="docClass">destroy</a>ed. Return false from an event handler to stop the <a href="Ext.form.field.Checkbox.html#destroy" rel="Ext.form.field.Checkbox#destroy" class="docClass">destroy</a>.</p>
2432 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2433 </div></li></ul></div></div></div><div id="event-beforehide" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-beforehide" rel="event-beforehide" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforehide" class="viewSource">view source</a></div><a name="beforehide"></a><a name="event-beforehide"></a><a href="Ext.form.field.Checkbox.html#" rel="event-beforehide" class="cls expand">beforehide</a>(
2434 <span class="pre">Ext.Component this</span>)
2435 </div><div class="description"><div class="short"><p>Fires before the component is hidden when calling the <a href="Ext.form.field.Checkbox.html#hide" rel="Ext.form.field.Checkbox#hide" class="docClass">hide</a> method.
2436 Return false from an event handler to stop the hide.</p>
2437 </div><div class="long"><p>Fires before the component is hidden when calling the <a href="Ext.form.field.Checkbox.html#hide" rel="Ext.form.field.Checkbox#hide" class="docClass">hide</a> method.
2438 Return false from an event handler to stop the hide.</p>
2439 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2440 </div></li></ul></div></div></div><div id="event-beforerender" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-beforerender" rel="event-beforerender" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforerender" class="viewSource">view source</a></div><a name="beforerender"></a><a name="event-beforerender"></a><a href="Ext.form.field.Checkbox.html#" rel="event-beforerender" class="cls expand">beforerender</a>(
2441 <span class="pre">Ext.Component this</span>)
2442 </div><div class="description"><div class="short"><p>Fires before the component is <a href="Ext.form.field.Checkbox.html#rendered" rel="Ext.form.field.Checkbox#rendered" class="docClass">rendered</a>. Return false from an
2443 event handler to stop the <a href="Ext.form.field.Checkbox.html#render" rel="Ext.form.field.Checkbox#render" class="docClass">render</a>.</p>
2444 </div><div class="long"><p>Fires before the component is <a href="Ext.form.field.Checkbox.html#rendered" rel="Ext.form.field.Checkbox#rendered" class="docClass">rendered</a>. Return false from an
2445 event handler to stop the <a href="Ext.form.field.Checkbox.html#render" rel="Ext.form.field.Checkbox#render" class="docClass">render</a>.</p>
2446 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2447 </div></li></ul></div></div></div><div id="event-beforeshow" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-beforeshow" rel="event-beforeshow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforeshow" class="viewSource">view source</a></div><a name="beforeshow"></a><a name="event-beforeshow"></a><a href="Ext.form.field.Checkbox.html#" rel="event-beforeshow" class="cls expand">beforeshow</a>(
2448 <span class="pre">Ext.Component this</span>)
2449 </div><div class="description"><div class="short"><p>Fires before the component is shown when calling the <a href="Ext.form.field.Checkbox.html#show" rel="Ext.form.field.Checkbox#show" class="docClass">show</a> method.
2450 Return false from an event handler to stop the show.</p>
2451 </div><div class="long"><p>Fires before the component is shown when calling the <a href="Ext.form.field.Checkbox.html#show" rel="Ext.form.field.Checkbox#show" class="docClass">show</a> method.
2452 Return false from an event handler to stop the show.</p>
2453 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2454 </div></li></ul></div></div></div><div id="event-beforestaterestore" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-beforestaterestore" rel="event-beforestaterestore" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-event-beforestaterestore" class="viewSource">view source</a></div><a name="beforestaterestore"></a><a name="event-beforestaterestore"></a><a href="Ext.form.field.Checkbox.html#" rel="event-beforestaterestore" class="cls expand">beforestaterestore</a>(
2455 <span class="pre">Ext.state.Stateful this, Object state</span>)
2456 </div><div class="description"><div class="short"><p>Fires before the state of the object is restored. Return false from an event handler to stop the restore.</p>
2457 </div><div class="long"><p>Fires before the state of the object is restored. Return false from an event handler to stop the restore.</p>
2458 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
2459 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values returned from the StateProvider. If this
2460 event is not vetoed, then the state object is passed to <b><tt>applyState</tt></b>. By default,
2461 that simply copies property values into this object. The method maybe overriden to
2462 provide custom state restoration.</p>
2463 </div></li></ul></div></div></div><div id="event-beforestatesave" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-beforestatesave" rel="event-beforestatesave" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-event-beforestatesave" class="viewSource">view source</a></div><a name="beforestatesave"></a><a name="event-beforestatesave"></a><a href="Ext.form.field.Checkbox.html#" rel="event-beforestatesave" class="cls expand">beforestatesave</a>(
2464 <span class="pre">Ext.state.Stateful this, Object state</span>)
2465 </div><div class="description"><div class="short"><p>Fires before the state of the object is saved to the configured state provider. Return false to stop the save.</p>
2466 </div><div class="long"><p>Fires before the state of the object is saved to the configured state provider. Return false to stop the save.</p>
2467 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
2468 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values. This is determined by calling
2469 <b><tt>getState()</tt></b> on the object. This method must be provided by the
2470 developer to return whetever representation of state is required, by default, <a href="Ext.state.Stateful.html" rel="Ext.state.Stateful" class="docClass">Ext.state.Stateful</a>
2471 has a null implementation.</p>
2472 </div></li></ul></div></div></div><div id="event-blur" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-blur" rel="event-blur" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-event-blur" class="viewSource">view source</a></div><a name="blur"></a><a name="event-blur"></a><a href="Ext.form.field.Checkbox.html#" rel="event-blur" class="cls expand">blur</a>(
2473 <span class="pre">Ext.form.field.Base this</span>)
2474 </div><div class="description"><div class="short"><p>Fires when this field loses input focus.</p>
2475 </div><div class="long"><p>Fires when this field loses input focus.</p>
2476 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.field.Base<div class="sub-desc">
2477 </div></li></ul></div></div></div><div id="event-change" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-change" rel="event-change" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-event-change" class="viewSource">view source</a></div><a name="change"></a><a name="event-change"></a><a href="Ext.form.field.Checkbox.html#" rel="event-change" class="cls expand">change</a>(
2478 <span class="pre">Ext.form.field.Field this, Mixed newValue, Mixed oldValue</span>)
2479 </div><div class="description"><div class="short"><p>Fires when a user-initiated change is detected in the value of the field.</p>
2480 </div><div class="long"><p>Fires when a user-initiated change is detected in the value of the field.</p>
2481 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.field.Field<div class="sub-desc">
2482 </div></li><li><span class="pre">newValue</span> : Mixed<div class="sub-desc"><p>The new value</p>
2483 </div></li><li><span class="pre">oldValue</span> : Mixed<div class="sub-desc"><p>The original value</p>
2484 </div></li></ul></div></div></div><div id="event-deactivate" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-deactivate" rel="event-deactivate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-deactivate" class="viewSource">view source</a></div><a name="deactivate"></a><a name="event-deactivate"></a><a href="Ext.form.field.Checkbox.html#" rel="event-deactivate" class="cls expand">deactivate</a>(
2485 <span class="pre">Ext.Component this</span>)
2486 </div><div class="description"><div class="short"><p>Fires after a Component has been visually deactivated.</p>
2487 </div><div class="long"><p>Fires after a Component has been visually deactivated.</p>
2488 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2489 </div></li></ul></div></div></div><div id="event-destroy" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-destroy" rel="event-destroy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-destroy" class="viewSource">view source</a></div><a name="destroy"></a><a name="event-destroy"></a><a href="Ext.form.field.Checkbox.html#" rel="event-destroy" class="cls expand">destroy</a>(
2490 <span class="pre">Ext.Component this</span>)
2491 </div><div class="description"><div class="short"><p>Fires after the component is <a href="Ext.form.field.Checkbox.html#destroy" rel="Ext.form.field.Checkbox#destroy" class="docClass">destroy</a>ed.</p>
2492 </div><div class="long"><p>Fires after the component is <a href="Ext.form.field.Checkbox.html#destroy" rel="Ext.form.field.Checkbox#destroy" class="docClass">destroy</a>ed.</p>
2493 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2494 </div></li></ul></div></div></div><div id="event-dirtychange" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-dirtychange" rel="event-dirtychange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-event-dirtychange" class="viewSource">view source</a></div><a name="dirtychange"></a><a name="event-dirtychange"></a><a href="Ext.form.field.Checkbox.html#" rel="event-dirtychange" class="cls expand">dirtychange</a>(
2495 <span class="pre">Ext.form.field.Field this, Boolean isDirty</span>)
2496 </div><div class="description"><div class="short"><p>Fires when a change in the field's <a href="Ext.form.field.Checkbox.html#isDirty" rel="Ext.form.field.Checkbox#isDirty" class="docClass">isDirty</a> state is detected.</p>
2497 </div><div class="long"><p>Fires when a change in the field's <a href="Ext.form.field.Checkbox.html#isDirty" rel="Ext.form.field.Checkbox#isDirty" class="docClass">isDirty</a> state is detected.</p>
2498 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.field.Field<div class="sub-desc">
2499 </div></li><li><span class="pre">isDirty</span> : Boolean<div class="sub-desc"><p>Whether or not the field is now dirty</p>
2500 </div></li></ul></div></div></div><div id="event-disable" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-disable" rel="event-disable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-disable" class="viewSource">view source</a></div><a name="disable"></a><a name="event-disable"></a><a href="Ext.form.field.Checkbox.html#" rel="event-disable" class="cls expand">disable</a>(
2501 <span class="pre">Ext.Component this</span>)
2502 </div><div class="description"><div class="short"><p>Fires after the component is disabled.</p>
2503 </div><div class="long"><p>Fires after the component is disabled.</p>
2504 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2505 </div></li></ul></div></div></div><div id="event-enable" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-enable" rel="event-enable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-enable" class="viewSource">view source</a></div><a name="enable"></a><a name="event-enable"></a><a href="Ext.form.field.Checkbox.html#" rel="event-enable" class="cls expand">enable</a>(
2506 <span class="pre">Ext.Component this</span>)
2507 </div><div class="description"><div class="short"><p>Fires after the component is enabled.</p>
2508 </div><div class="long"><p>Fires after the component is enabled.</p>
2509 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2510 </div></li></ul></div></div></div><div id="event-errorchange" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-errorchange" rel="event-errorchange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-event-errorchange" class="viewSource">view source</a></div><a name="errorchange"></a><a name="event-errorchange"></a><a href="Ext.form.field.Checkbox.html#" rel="event-errorchange" class="cls expand">errorchange</a>(
2511 <span class="pre">Ext.form.Labelable this, String error</span>)
2512 </div><div class="description"><div class="short"><p>Fires when the active error message is changed via <a href="Ext.form.field.Checkbox.html#setActiveError" rel="Ext.form.field.Checkbox#setActiveError" class="docClass">setActiveError</a>.</p>
2513 </div><div class="long"><p>Fires when the active error message is changed via <a href="Ext.form.field.Checkbox.html#setActiveError" rel="Ext.form.field.Checkbox#setActiveError" class="docClass">setActiveError</a>.</p>
2514 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.Labelable<div class="sub-desc">
2515 </div></li><li><span class="pre">error</span> : String<div class="sub-desc"><p>The active error message</p>
2516 </div></li></ul></div></div></div><div id="event-focus" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-focus" rel="event-focus" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-event-focus" class="viewSource">view source</a></div><a name="focus"></a><a name="event-focus"></a><a href="Ext.form.field.Checkbox.html#" rel="event-focus" class="cls expand">focus</a>(
2517 <span class="pre">Ext.form.field.Base this</span>)
2518 </div><div class="description"><div class="short"><p>Fires when this field receives input focus.</p>
2519 </div><div class="long"><p>Fires when this field receives input focus.</p>
2520 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.field.Base<div class="sub-desc">
2521 </div></li></ul></div></div></div><div id="event-hide" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-hide" rel="event-hide" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-hide" class="viewSource">view source</a></div><a name="hide"></a><a name="event-hide"></a><a href="Ext.form.field.Checkbox.html#" rel="event-hide" class="cls expand">hide</a>(
2522 <span class="pre">Ext.Component this</span>)
2523 </div><div class="description"><div class="short"><p>Fires after the component is hidden.
2524 Fires after the component is hidden when calling the <a href="Ext.form.field.Checkbox.html#hide" rel="Ext.form.field.Checkbox#hide" class="docClass">hide</a> method.</p>
2525 </div><div class="long"><p>Fires after the component is hidden.
2526 Fires after the component is hidden when calling the <a href="Ext.form.field.Checkbox.html#hide" rel="Ext.form.field.Checkbox#hide" class="docClass">hide</a> method.</p>
2527 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2528 </div></li></ul></div></div></div><div id="event-move" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-move" rel="event-move" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-move" class="viewSource">view source</a></div><a name="move"></a><a name="event-move"></a><a href="Ext.form.field.Checkbox.html#" rel="event-move" class="cls expand">move</a>(
2529 <span class="pre">Ext.Component this, Number x, Number y</span>)
2530 </div><div class="description"><div class="short"><p>Fires after the component is moved.</p>
2531 </div><div class="long"><p>Fires after the component is moved.</p>
2532 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2533 </div></li><li><span class="pre">x</span> : Number<div class="sub-desc"><p>The new x position</p>
2534 </div></li><li><span class="pre">y</span> : Number<div class="sub-desc"><p>The new y position</p>
2535 </div></li></ul></div></div></div><div id="event-removed" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-removed" rel="event-removed" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-removed" class="viewSource">view source</a></div><a name="removed"></a><a name="event-removed"></a><a href="Ext.form.field.Checkbox.html#" rel="event-removed" class="cls expand">removed</a>(
2536 <span class="pre">Ext.Component this, Ext.container.Container ownerCt</span>)
2537 </div><div class="description"><div class="short"><p>Fires when a component is removed from an Ext.container.Container</p>
2538 </div><div class="long"><p>Fires when a component is removed from an Ext.container.Container</p>
2539 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2540 </div></li><li><span class="pre">ownerCt</span> : Ext.container.Container<div class="sub-desc"><p>Container which holds the component</p>
2541 </div></li></ul></div></div></div><div id="event-render" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-render" rel="event-render" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-render" class="viewSource">view source</a></div><a name="render"></a><a name="event-render"></a><a href="Ext.form.field.Checkbox.html#" rel="event-render" class="cls expand">render</a>(
2542 <span class="pre">Ext.Component this</span>)
2543 </div><div class="description"><div class="short"><p>Fires after the component markup is <a href="Ext.form.field.Checkbox.html#rendered" rel="Ext.form.field.Checkbox#rendered" class="docClass">rendered</a>.</p>
2544 </div><div class="long"><p>Fires after the component markup is <a href="Ext.form.field.Checkbox.html#rendered" rel="Ext.form.field.Checkbox#rendered" class="docClass">rendered</a>.</p>
2545 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2546 </div></li></ul></div></div></div><div id="event-resize" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-resize" rel="event-resize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-resize" class="viewSource">view source</a></div><a name="resize"></a><a name="event-resize"></a><a href="Ext.form.field.Checkbox.html#" rel="event-resize" class="cls expand">resize</a>(
2547 <span class="pre">Ext.Component this, Number adjWidth, Number adjHeight</span>)
2548 </div><div class="description"><div class="short"><p>Fires after the component is resized.</p>
2549 </div><div class="long"><p>Fires after the component is resized.</p>
2550 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2551 </div></li><li><span class="pre">adjWidth</span> : Number<div class="sub-desc"><p>The box-adjusted width that was set</p>
2552 </div></li><li><span class="pre">adjHeight</span> : Number<div class="sub-desc"><p>The box-adjusted height that was set</p>
2553 </div></li></ul></div></div></div><div id="event-show" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-show" rel="event-show" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-show" class="viewSource">view source</a></div><a name="show"></a><a name="event-show"></a><a href="Ext.form.field.Checkbox.html#" rel="event-show" class="cls expand">show</a>(
2554 <span class="pre">Ext.Component this</span>)
2555 </div><div class="description"><div class="short"><p>Fires after the component is shown when calling the <a href="Ext.form.field.Checkbox.html#show" rel="Ext.form.field.Checkbox#show" class="docClass">show</a> method.</p>
2556 </div><div class="long"><p>Fires after the component is shown when calling the <a href="Ext.form.field.Checkbox.html#show" rel="Ext.form.field.Checkbox#show" class="docClass">show</a> method.</p>
2557 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2558 </div></li></ul></div></div></div><div id="event-specialkey" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-specialkey" rel="event-specialkey" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-event-specialkey" class="viewSource">view source</a></div><a name="specialkey"></a><a name="event-specialkey"></a><a href="Ext.form.field.Checkbox.html#" rel="event-specialkey" class="cls expand">specialkey</a>(
2559 <span class="pre">Ext.form.field.Base this, Ext.EventObject e</span>)
2560 </div><div class="description"><div class="short">Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
2561 To handle other keys see Ext.pan...</div><div class="long"><p>Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
2562 To handle other keys see <a href="Ext.panel.Panel.html#keys" rel="Ext.panel.Panel#keys" class="docClass">Ext.panel.Panel.keys</a> or <a href="Ext.util.KeyMap.html" rel="Ext.util.KeyMap" class="docClass">Ext.util.KeyMap</a>.
2563 You can check <a href="Ext.EventObject.html#getKey" rel="Ext.EventObject#getKey" class="docClass">Ext.EventObject.getKey</a> to determine which key was pressed.
2564 For example:</p>
2565
2566 <pre><code>var form = new Ext.form.Panel({
2567     ...
2568     items: [{
2569             fieldLabel: 'Field 1',
2570             name: 'field1',
2571             allowBlank: false
2572         },{
2573             fieldLabel: 'Field 2',
2574             name: 'field2',
2575             listeners: {
2576                 specialkey: function(field, e){
2577                     // e.HOME, e.END, e.PAGE_UP, e.PAGE_DOWN,
2578                     // e.TAB, e.ESC, arrow keys: e.LEFT, e.RIGHT, e.UP, e.DOWN
2579                     if (e.<a href="Ext.EventObject.html#getKey" rel="Ext.EventObject#getKey" class="docClass">getKey()</a> == e.ENTER) {
2580                         var form = field.up('form').getForm();
2581                         form.submit();
2582                     }
2583                 }
2584             }
2585         }
2586     ],
2587     ...
2588 });
2589 </code></pre>
2590
2591 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.field.Base<div class="sub-desc">
2592 </div></li><li><span class="pre">e</span> : Ext.EventObject<div class="sub-desc"><p>The event object</p>
2593 </div></li></ul></div></div></div><div id="event-staterestore" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-staterestore" rel="event-staterestore" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-event-staterestore" class="viewSource">view source</a></div><a name="staterestore"></a><a name="event-staterestore"></a><a href="Ext.form.field.Checkbox.html#" rel="event-staterestore" class="cls expand">staterestore</a>(
2594 <span class="pre">Ext.state.Stateful this, Object state</span>)
2595 </div><div class="description"><div class="short"><p>Fires after the state of the object is restored.</p>
2596 </div><div class="long"><p>Fires after the state of the object is restored.</p>
2597 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
2598 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values returned from the StateProvider. This is passed
2599 to <b><tt>applyState</tt></b>. By default, that simply copies property values into this
2600 object. The method maybe overriden to provide custom state restoration.</p>
2601 </div></li></ul></div></div></div><div id="event-statesave" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-statesave" rel="event-statesave" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-event-statesave" class="viewSource">view source</a></div><a name="statesave"></a><a name="event-statesave"></a><a href="Ext.form.field.Checkbox.html#" rel="event-statesave" class="cls expand">statesave</a>(
2602 <span class="pre">Ext.state.Stateful this, Object state</span>)
2603 </div><div class="description"><div class="short"><p>Fires after the state of the object is saved to the configured state provider.</p>
2604 </div><div class="long"><p>Fires after the state of the object is saved to the configured state provider.</p>
2605 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
2606 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values. This is determined by calling
2607 <b><tt>getState()</tt></b> on the object. This method must be provided by the
2608 developer to return whetever representation of state is required, by default, <a href="Ext.state.Stateful.html" rel="Ext.state.Stateful" class="docClass">Ext.state.Stateful</a>
2609 has a null implementation.</p>
2610 </div></li></ul></div></div></div><div id="event-validitychange" class="member inherited"><a href="Ext.form.field.Checkbox.html#event-validitychange" rel="event-validitychange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-event-validitychange" class="viewSource">view source</a></div><a name="validitychange"></a><a name="event-validitychange"></a><a href="Ext.form.field.Checkbox.html#" rel="event-validitychange" class="cls expand">validitychange</a>(
2611 <span class="pre">Ext.form.field.Field this, Boolean isValid</span>)
2612 </div><div class="description"><div class="short"><p>Fires when a change in the field's validity is detected.</p>
2613 </div><div class="long"><p>Fires when a change in the field's validity is detected.</p>
2614 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.field.Field<div class="sub-desc">
2615 </div></li><li><span class="pre">isValid</span> : Boolean<div class="sub-desc"><p>Whether or not the field is now valid</p>
2616 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>