docs/source/Checkbox.html

   1 <html>
   2 <head>
   3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   4   <title>The source code</title>
   5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   7 </head>
   8 <body  onload="prettyPrint();">
   9     <pre class="prettyprint lang-js">/*!
  10  * Ext JS Library 3.3.1
  11  * Copyright(c) 2006-2010 Sencha Inc.
  12  * licensing@sencha.com
  13  * http://www.sencha.com/license
  14  */
  15 <div id="cls-Ext.form.Checkbox"></div>/**
  16  * @class Ext.form.Checkbox
  17  * @extends Ext.form.Field
  18  * Single checkbox field.  Can be used as a direct replacement for traditional checkbox fields.
  19  * @constructor
  20  * Creates a new Checkbox
  21  * @param {Object} config Configuration options
  22  * @xtype checkbox
  23  */
  24 Ext.form.Checkbox = Ext.extend(Ext.form.Field,  {
  25     <div id="cfg-Ext.form.Checkbox-focusClass"></div>/**
  26      * @cfg {String} focusClass The CSS class to use when the checkbox receives focus (defaults to undefined)
  27      */
  28     focusClass : undefined,
  29     <div id="cfg-Ext.form.Checkbox-fieldClass"></div>/**
  30      * @cfg {String} fieldClass The default CSS class for the checkbox (defaults to 'x-form-field')
  31      */
  32     fieldClass : 'x-form-field',
  33     <div id="cfg-Ext.form.Checkbox-checked"></div>/**
  34      * @cfg {Boolean} checked <tt>true</tt> if the checkbox should render initially checked (defaults to <tt>false</tt>)
  35      */
  36     checked : false,
  37     <div id="cfg-Ext.form.Checkbox-boxLabel"></div>/**
  38      * @cfg {String} boxLabel The text that appears beside the checkbox
  39      */
  40     boxLabel: '&#160;',
  41     <div id="cfg-Ext.form.Checkbox-autoCreate"></div>/**
  42      * @cfg {String/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to
  43      * {tag: 'input', type: 'checkbox', autocomplete: 'off'})
  44      */
  45     defaultAutoCreate : { tag: 'input', type: 'checkbox', autocomplete: 'off'},
  46     <div id="cfg-Ext.form.Checkbox-inputValue"></div>/**
  47      * @cfg {String} inputValue The value that should go into the generated input element's value attribute
  48      */
  49     <div id="cfg-Ext.form.Checkbox-handler"></div>/**
  50      * @cfg {Function} handler A function called when the {@link #checked} value changes (can be used instead of
  51      * handling the check event). The handler is passed the following parameters:
  52      * <div class="mdetail-params"><ul>
  53      * <li><b>checkbox</b> : Ext.form.Checkbox<div class="sub-desc">The Checkbox being toggled.</div></li>
  54      * <li><b>checked</b> : Boolean<div class="sub-desc">The new checked state of the checkbox.</div></li>
  55      * </ul></div>
  56      */
  57     <div id="cfg-Ext.form.Checkbox-scope"></div>/**
  58      * @cfg {Object} scope An object to use as the scope ('this' reference) of the {@link #handler} function
  59      * (defaults to this Checkbox).
  60      */
  61
  62     // private
  63     actionMode : 'wrap',
  64
  65         // private
  66     initComponent : function(){
  67         Ext.form.Checkbox.superclass.initComponent.call(this);
  68         this.addEvents(
  69             <div id="event-Ext.form.Checkbox-check"></div>/**
  70              * @event check
  71              * Fires when the checkbox is checked or unchecked.
  72              * @param {Ext.form.Checkbox} this This checkbox
  73              * @param {Boolean} checked The new checked value
  74              */
  75             'check'
  76         );
  77     },
  78
  79     // private
  80     onResize : function(){
  81         Ext.form.Checkbox.superclass.onResize.apply(this, arguments);
  82         if(!this.boxLabel && !this.fieldLabel){
  83             this.el.alignTo(this.wrap, 'c-c');
  84         }
  85     },
  86
  87     // private
  88     initEvents : function(){
  89         Ext.form.Checkbox.superclass.initEvents.call(this);
  90         this.mon(this.el, {
  91             scope: this,
  92             click: this.onClick,
  93             change: this.onClick
  94         });
  95     },
  96
  97     <div id="method-Ext.form.Checkbox-markInvalid"></div>/**
  98      * @hide
  99      * Overridden and disabled. The editor element does not support standard valid/invalid marking.
 100      * @method
 101      */
 102     markInvalid : Ext.emptyFn,
 103     <div id="method-Ext.form.Checkbox-clearInvalid"></div>/**
 104      * @hide
 105      * Overridden and disabled. The editor element does not support standard valid/invalid marking.
 106      * @method
 107      */
 108     clearInvalid : Ext.emptyFn,
 109
 110     // private
 111     onRender : function(ct, position){
 112         Ext.form.Checkbox.superclass.onRender.call(this, ct, position);
 113         if(this.inputValue !== undefined){
 114             this.el.dom.value = this.inputValue;
 115         }
 116         this.wrap = this.el.wrap({cls: 'x-form-check-wrap'});
 117         if(this.boxLabel){
 118             this.wrap.createChild({tag: 'label', htmlFor: this.el.id, cls: 'x-form-cb-label', html: this.boxLabel});
 119         }
 120         if(this.checked){
 121             this.setValue(true);
 122         }else{
 123             this.checked = this.el.dom.checked;
 124         }
 125         // Need to repaint for IE, otherwise positioning is broken
 126         if (Ext.isIE && !Ext.isStrict) {
 127             this.wrap.repaint();
 128         }
 129         this.resizeEl = this.positionEl = this.wrap;
 130     },
 131
 132     // private
 133     onDestroy : function(){
 134         Ext.destroy(this.wrap);
 135         Ext.form.Checkbox.superclass.onDestroy.call(this);
 136     },
 137
 138     // private
 139     initValue : function() {
 140         this.originalValue = this.getValue();
 141     },
 142
 143     <div id="method-Ext.form.Checkbox-getValue"></div>/**
 144      * Returns the checked state of the checkbox.
 145      * @return {Boolean} True if checked, else false
 146      */
 147     getValue : function(){
 148         if(this.rendered){
 149             return this.el.dom.checked;
 150         }
 151         return this.checked;
 152     },
 153
 154         // private
 155     onClick : function(){
 156         if(this.el.dom.checked != this.checked){
 157             this.setValue(this.el.dom.checked);
 158         }
 159     },
 160
 161     <div id="method-Ext.form.Checkbox-setValue"></div>/**
 162      * Sets the checked state of the checkbox, fires the 'check' event, and calls a
 163      * <code>{@link #handler}</code> (if configured).
 164      * @param {Boolean/String} checked The following values will check the checkbox:
 165      * <code>true, 'true', '1', or 'on'</code>. Any other value will uncheck the checkbox.
 166      * @return {Ext.form.Field} this
 167      */
 168     setValue : function(v){
 169         var checked = this.checked,
 170             inputVal = this.inputValue;
 171
 172         this.checked = (v === true || v === 'true' || v == '1' || (inputVal ? v == inputVal : String(v).toLowerCase() == 'on'));
 173         if(this.rendered){
 174             this.el.dom.checked = this.checked;
 175             this.el.dom.defaultChecked = this.checked;
 176         }
 177         if(checked != this.checked){
 178             this.fireEvent('check', this, this.checked);
 179             if(this.handler){
 180                 this.handler.call(this.scope || this, this, this.checked);
 181             }
 182         }
 183         return this;
 184     }
 185 });
 186 Ext.reg('checkbox', Ext.form.Checkbox);
 187 </pre>
 188 </body>
 189 </html>