1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.form.Checkbox</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.form.Checkbox-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.form.Checkbox-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.form.Checkbox-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.form.Checkbox-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.Checkbox
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.form.Checkbox
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_form_Checkbox.js.html">Roo/form/Checkbox.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">Checkbox</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 Single checkbox field. Can be used as a direct replacement for traditional checkbox fields.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.Checkbox';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.form" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.form.Checkbox.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.form.Checkbox-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.form.Checkbox-cfg-autoCreate" name=".autoCreate"></a>
132 <div class="fixedFont">
133 <b class="itemname">autoCreate</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object
139 <div class="short">A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "checkbox", autocomplete: "off"})</div>
143 <div class="long">A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "checkbox", autocomplete: "off"})</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.form.Checkbox-cfg-boxLabel" name=".boxLabel"></a>
162 <div class="fixedFont">
163 <b class="itemname">boxLabel</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
169 <div class="short">The text that appears beside the checkbox</div>
173 <div class="long">The text that appears beside the checkbox</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.form.Checkbox-cfg-checked" name=".checked"></a>
192 <div class="fixedFont">
193 <b class="itemname">checked</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
199 <div class="short">True if the the checkbox should render already checked (defaults to false)</div>
203 <div class="long">True if the the checkbox should render already checked (defaults to false)</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.form.Checkbox-cfg-fieldClass" name=".fieldClass"></a>
222 <div class="fixedFont">
223 <b class="itemname">fieldClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
229 <div class="short">The default CSS class for the checkbox (defaults to "x-form-field")</div>
233 <div class="long">The default CSS class for the checkbox (defaults to "x-form-field")</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.form.Checkbox-cfg-focusClass" name=".focusClass"></a>
252 <div class="fixedFont">
253 <b class="itemname">focusClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
259 <div class="short">The CSS class to use when the checkbox receives focus (defaults to undefined)</div>
263 <div class="long">The CSS class to use when the checkbox receives focus (defaults to undefined)</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.form.Checkbox-cfg-inputValue" name=".inputValue"></a>
282 <div class="fixedFont">
283 <b class="itemname">inputValue</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
289 <div class="short">The value that should go into the generated input element's value attribute</div>
293 <div class="long">The value that should go into the generated input element's value attribute</div>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.form.Checkbox-cfg-valueOff" name=".valueOff"></a>
312 <div class="fixedFont">
313 <b class="itemname">valueOff</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
319 <div class="short">The value that should go into the generated input element's value when unchecked.</div>
323 <div class="long">The value that should go into the generated input element's value when unchecked.</div>
347 <!-- ============================== public properties ==================== -->
351 <a id="Roo.form.Checkbox-props"></a>
357 <table cellspacing="0" class="member-table">
358 <caption class="Empty">Public Properties - Has None</caption>
364 <!-- ============================== methods summary / details ======================== -->
367 <a id="Roo.form.Checkbox-methods"></a>
368 <!-- constructor?? -->
375 <!-- then dynamics first -->
382 <table cellspacing="0" class="member-table">
383 <caption>Public Methods</caption>
385 <th class="sig-header" colspan="2">Method</th>
386 <th class="msource-header">Defined By</th>
396 <tr class="method-row config-row-alt0 expandable notInherited">
397 <td class="micon"><a class="exi" href="#expand"> </a></td>
401 <a id="Roo.form-method-Checkbox" name=".Checkbox"></a>
402 <div class="fixedFont">
403 <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">Checkbox</b>
405 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
413 <div class="short">Create a new Roo.form.Checkbox</div>
420 Create a new Roo.form.Checkbox
423 <dl class="detailList">
424 <dt class="heading">Parameters:</dt>
427 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
430 <dd>Configuration options</dd>
454 <tr class="method-row config-row-alt1 expandable notInherited">
455 <td class="micon"><a class="exi" href="#expand"> </a></td>
459 <a id="Roo.form.Checkbox-method-getValue" name=".getValue"></a>
460 <div class="fixedFont">
461 <span class="attributes"></span><b class="itemname">getValue</b>
469 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
478 <div class="short">Returns the checked state of the checkbox.</div>
484 Returns the checked state of the checkbox.
495 <dl class="detailList">
496 <dt class="heading">Returns:</dt>
498 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if checked, else false</dd>
520 <tr class="method-row config-row-alt0 expandable notInherited">
521 <td class="micon"><a class="exi" href="#expand"> </a></td>
525 <a id="Roo.form.Checkbox-method-setValue" name=".setValue"></a>
526 <div class="fixedFont">
527 <span class="attributes"></span><b class="itemname">setValue</b>
529 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String <B><i>checked</i></B>)
536 <div class="short">Sets the checked state of the checkbox.</div>
542 Sets the checked state of the checkbox.
549 <dl class="detailList">
550 <dt class="heading">Parameters:</dt>
553 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String</span> <b>checked</b>
556 <dd>True, 'true', '1', or 'on' to check the checkbox, any other value will uncheck it.</dd>
585 <!-- ============================== events summary / details ======================== -->
588 <a id="Roo.form.Checkbox-events"></a>
597 <table cellspacing="0" class="member-table">
598 <caption>Events</caption>
601 <th class="sig-header" colspan="2">Event</th>
602 <th class="msource-header">Defined By</th>
611 <tr class="method-row expandable config-row-alt0 notInherited">
612 <td class="micon"><a class="exi" href="#expand"> </a></td>
615 <a id="Roo.form.Checkbox-event-*check"></a>
617 <div class="fixedFont">
618 <b class="itemname">check</b> (<a href="./Roo.form.Checkbox.html#constructor" roo:cls="Roo.form.Checkbox.html#constructor">Roo.form.Checkbox</a> <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>checked</i></B>)
624 <div class="short">Fires when the checkbox is checked or unchecked.
630 Fires when the checkbox is checked or unchecked.
636 <dl class="detailList">
637 <dt class="heading">Parameters:</dt>
640 <span class="fixedFont"><a href="./Roo.form.Checkbox.html#constructor" roo:cls="Roo.form.Checkbox.html#constructor">Roo.form.Checkbox</a></span> <b>this</b>
643 <dd>This checkbox</dd>
646 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>checked</b>
649 <dd>The new checked value</dd>
679 <!-- ============================== footer ================================= -->
680 <div class="fineprint" style="clear:both">
682 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:43:11 GMT+0800 (HKT)
684 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>