CheckboxGroup.js
上传用户:dawnssy
上传日期:2022-08-06
资源大小:9345k
文件大小:14k
源码类别:

JavaScript

开发平台:

JavaScript

  1. /*!
  2.  * Ext JS Library 3.1.0
  3.  * Copyright(c) 2006-2009 Ext JS, LLC
  4.  * licensing@extjs.com
  5.  * http://www.extjs.com/license
  6.  */
  7. /**
  8.  * @class Ext.form.CheckboxGroup
  9.  * @extends Ext.form.Field
  10.  * <p>A grouping container for {@link Ext.form.Checkbox} controls.</p>
  11.  * <p>Sample usage:</p>
  12.  * <pre><code>
  13. var myCheckboxGroup = new Ext.form.CheckboxGroup({
  14.     id:'myGroup',
  15.     xtype: 'checkboxgroup',
  16.     fieldLabel: 'Single Column',
  17.     itemCls: 'x-check-group-alt',
  18.     // Put all controls in a single column with width 100%
  19.     columns: 1,
  20.     items: [
  21.         {boxLabel: 'Item 1', name: 'cb-col-1'},
  22.         {boxLabel: 'Item 2', name: 'cb-col-2', checked: true},
  23.         {boxLabel: 'Item 3', name: 'cb-col-3'}
  24.     ]
  25. });
  26.  * </code></pre>
  27.  * @constructor
  28.  * Creates a new CheckboxGroup
  29.  * @param {Object} config Configuration options
  30.  * @xtype checkboxgroup
  31.  */
  32. Ext.form.CheckboxGroup = Ext.extend(Ext.form.Field, {
  33.     /**
  34.      * @cfg {Array} items An Array of {@link Ext.form.Checkbox Checkbox}es or Checkbox config objects
  35.      * to arrange in the group.
  36.      */
  37.     /**
  38.      * @cfg {String/Number/Array} columns Specifies the number of columns to use when displaying grouped
  39.      * checkbox/radio controls using automatic layout.  This config can take several types of values:
  40.      * <ul><li><b>'auto'</b> : <p class="sub-desc">The controls will be rendered one per column on one row and the width
  41.      * of each column will be evenly distributed based on the width of the overall field container. This is the default.</p></li>
  42.      * <li><b>Number</b> : <p class="sub-desc">If you specific a number (e.g., 3) that number of columns will be
  43.      * created and the contained controls will be automatically distributed based on the value of {@link #vertical}.</p></li>
  44.      * <li><b>Array</b> : Object<p class="sub-desc">You can also specify an array of column widths, mixing integer
  45.      * (fixed width) and float (percentage width) values as needed (e.g., [100, .25, .75]). Any integer values will
  46.      * be rendered first, then any float values will be calculated as a percentage of the remaining space. Float
  47.      * values do not have to add up to 1 (100%) although if you want the controls to take up the entire field
  48.      * container you should do so.</p></li></ul>
  49.      */
  50.     columns : 'auto',
  51.     /**
  52.      * @cfg {Boolean} vertical True to distribute contained controls across columns, completely filling each column
  53.      * top to bottom before starting on the next column.  The number of controls in each column will be automatically
  54.      * calculated to keep columns as even as possible.  The default value is false, so that controls will be added
  55.      * to columns one at a time, completely filling each row left to right before starting on the next row.
  56.      */
  57.     vertical : false,
  58.     /**
  59.      * @cfg {Boolean} allowBlank False to validate that at least one item in the group is checked (defaults to true).
  60.      * If no items are selected at validation time, {@link @blankText} will be used as the error text.
  61.      */
  62.     allowBlank : true,
  63.     /**
  64.      * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails (defaults to "You must
  65.      * select at least one item in this group")
  66.      */
  67.     blankText : "You must select at least one item in this group",
  68.     // private
  69.     defaultType : 'checkbox',
  70.     // private
  71.     groupCls : 'x-form-check-group',
  72.     // private
  73.     initComponent: function(){
  74.         this.addEvents(
  75.             /**
  76.              * @event change
  77.              * Fires when the state of a child checkbox changes.
  78.              * @param {Ext.form.CheckboxGroup} this
  79.              * @param {Array} checked An array containing the checked boxes.
  80.              */
  81.             'change'
  82.         );
  83.         this.on('change', this.validate, this);
  84.         Ext.form.CheckboxGroup.superclass.initComponent.call(this);
  85.     },
  86.     // private
  87.     onRender : function(ct, position){
  88.         if(!this.el){
  89.             var panelCfg = {
  90.                 autoEl: {
  91.                     id: this.id
  92.                 },
  93.                 cls: this.groupCls,
  94.                 layout: 'column',
  95.                 renderTo: ct,
  96.                 bufferResize: false // Default this to false, since it doesn't really have a proper ownerCt.
  97.             };
  98.             var colCfg = {
  99.                 xtype: 'container',
  100.                 defaultType: this.defaultType,
  101.                 layout: 'form',
  102.                 defaults: {
  103.                     hideLabel: true,
  104.                     anchor: '100%'
  105.                 }
  106.             };
  107.             if(this.items[0].items){
  108.                 // The container has standard ColumnLayout configs, so pass them in directly
  109.                 Ext.apply(panelCfg, {
  110.                     layoutConfig: {columns: this.items.length},
  111.                     defaults: this.defaults,
  112.                     items: this.items
  113.                 });
  114.                 for(var i=0, len=this.items.length; i<len; i++){
  115.                     Ext.applyIf(this.items[i], colCfg);
  116.                 }
  117.             }else{
  118.                 // The container has field item configs, so we have to generate the column
  119.                 // panels first then move the items into the columns as needed.
  120.                 var numCols, cols = [];
  121.                 if(typeof this.columns == 'string'){ // 'auto' so create a col per item
  122.                     this.columns = this.items.length;
  123.                 }
  124.                 if(!Ext.isArray(this.columns)){
  125.                     var cs = [];
  126.                     for(var i=0; i<this.columns; i++){
  127.                         cs.push((100/this.columns)*.01); // distribute by even %
  128.                     }
  129.                     this.columns = cs;
  130.                 }
  131.                 numCols = this.columns.length;
  132.                 // Generate the column configs with the correct width setting
  133.                 for(var i=0; i<numCols; i++){
  134.                     var cc = Ext.apply({items:[]}, colCfg);
  135.                     cc[this.columns[i] <= 1 ? 'columnWidth' : 'width'] = this.columns[i];
  136.                     if(this.defaults){
  137.                         cc.defaults = Ext.apply(cc.defaults || {}, this.defaults)
  138.                     }
  139.                     cols.push(cc);
  140.                 };
  141.                 // Distribute the original items into the columns
  142.                 if(this.vertical){
  143.                     var rows = Math.ceil(this.items.length / numCols), ri = 0;
  144.                     for(var i=0, len=this.items.length; i<len; i++){
  145.                         if(i>0 && i%rows==0){
  146.                             ri++;
  147.                         }
  148.                         if(this.items[i].fieldLabel){
  149.                             this.items[i].hideLabel = false;
  150.                         }
  151.                         cols[ri].items.push(this.items[i]);
  152.                     };
  153.                 }else{
  154.                     for(var i=0, len=this.items.length; i<len; i++){
  155.                         var ci = i % numCols;
  156.                         if(this.items[i].fieldLabel){
  157.                             this.items[i].hideLabel = false;
  158.                         }
  159.                         cols[ci].items.push(this.items[i]);
  160.                     };
  161.                 }
  162.                 Ext.apply(panelCfg, {
  163.                     layoutConfig: {columns: numCols},
  164.                     items: cols
  165.                 });
  166.             }
  167.             this.panel = new Ext.Container(panelCfg);
  168.             this.panel.ownerCt = this;
  169.             this.el = this.panel.getEl();
  170.             if(this.forId && this.itemCls){
  171.                 var l = this.el.up(this.itemCls).child('label', true);
  172.                 if(l){
  173.                     l.setAttribute('htmlFor', this.forId);
  174.                 }
  175.             }
  176.             var fields = this.panel.findBy(function(c){
  177.                 return c.isFormField;
  178.             }, this);
  179.             this.items = new Ext.util.MixedCollection();
  180.             this.items.addAll(fields);
  181.         }
  182.         Ext.form.CheckboxGroup.superclass.onRender.call(this, ct, position);
  183.     },
  184.     initValue : function(){
  185.         if(this.value){
  186.             this.setValue.apply(this, this.buffered ? this.value : [this.value]);
  187.             delete this.buffered;
  188.             delete this.value;
  189.         }
  190.     },
  191.     afterRender : function(){
  192.         Ext.form.CheckboxGroup.superclass.afterRender.call(this);
  193.         this.eachItem(function(item){
  194.             item.on('check', this.fireChecked, this);
  195.             item.inGroup = true;
  196.         });
  197.     },
  198.     // private
  199.     doLayout: function(){
  200.         //ugly method required to layout hidden items
  201.         if(this.rendered){
  202.             this.panel.forceLayout = this.ownerCt.forceLayout;
  203.             this.panel.doLayout();
  204.         }
  205.     },
  206.     // private
  207.     fireChecked: function(){
  208.         var arr = [];
  209.         this.eachItem(function(item){
  210.             if(item.checked){
  211.                 arr.push(item);
  212.             }
  213.         });
  214.         this.fireEvent('change', this, arr);
  215.     },
  216.     // private
  217.     validateValue : function(value){
  218.         if(!this.allowBlank){
  219.             var blank = true;
  220.             this.eachItem(function(f){
  221.                 if(f.checked){
  222.                     return (blank = false);
  223.                 }
  224.             });
  225.             if(blank){
  226.                 this.markInvalid(this.blankText);
  227.                 return false;
  228.             }
  229.         }
  230.         return true;
  231.     },
  232.     // private
  233.     isDirty: function(){
  234.         //override the behaviour to check sub items.
  235.         if (this.disabled || !this.rendered) {
  236.             return false;
  237.         }
  238.         var dirty = false;
  239.         this.eachItem(function(item){
  240.             if(item.isDirty()){
  241.                 dirty = true;
  242.                 return false;
  243.             }
  244.         });
  245.         return dirty;
  246.     },
  247.     // private
  248.     onDisable : function(){
  249.         this.eachItem(function(item){
  250.             item.disable();
  251.         });
  252.     },
  253.     // private
  254.     onEnable : function(){
  255.         this.eachItem(function(item){
  256.             item.enable();
  257.         });
  258.     },
  259.     // private
  260.     doLayout: function(){
  261.         if(this.rendered){
  262.             this.panel.forceLayout = this.ownerCt.forceLayout;
  263.             this.panel.doLayout();
  264.         }
  265.     },
  266.     // private
  267.     onResize : function(w, h){
  268.         this.panel.setSize(w, h);
  269.         this.panel.doLayout();
  270.     },
  271.     // inherit docs from Field
  272.     reset : function(){
  273.         this.eachItem(function(c){
  274.             if(c.reset){
  275.                 c.reset();
  276.             }
  277.         });
  278.         // Defer the clearInvalid so if BaseForm's collection is being iterated it will be called AFTER it is complete.
  279.         // Important because reset is being called on both the group and the individual items.
  280.         (function() {
  281.             this.clearInvalid();
  282.         }).defer(50, this);
  283.     },
  284.     /**
  285.      * {@link Ext.form.Checkbox#setValue Set the value(s)} of an item or items
  286.      * in the group. Examples illustrating how this method may be called:
  287.      * <pre><code>
  288. // call with name and value
  289. myCheckboxGroup.setValue('cb-col-1', true);
  290. // call with an array of boolean values
  291. myCheckboxGroup.setValue([true, false, false]);
  292. // call with an object literal specifying item:value pairs
  293. myCheckboxGroup.setValue({
  294.     'cb-col-2': false,
  295.     'cb-col-3': true
  296. });
  297. // use comma separated string to set items with name to true (checked)
  298. myCheckboxGroup.setValue('cb-col-1,cb-col-3');
  299.      * </code></pre>
  300.      * See {@link Ext.form.Checkbox#setValue} for additional information.
  301.      * @param {Mixed} id The checkbox to check, or as described by example shown.
  302.      * @param {Boolean} value (optional) The value to set the item.
  303.      * @return {Ext.form.CheckboxGroup} this
  304.      */
  305.     setValue: function(){
  306.         if(this.rendered){
  307.             this.onSetValue.apply(this, arguments);
  308.         }else{
  309.             this.buffered = true;
  310.             this.value = arguments;
  311.         }
  312.         return this;
  313.     },
  314.     onSetValue: function(id, value){
  315.         if(arguments.length == 1){
  316.             if(Ext.isArray(id)){
  317.                 // an array of boolean values
  318.                 Ext.each(id, function(val, idx){
  319.                     var item = this.items.itemAt(idx);
  320.                     if(item){
  321.                         item.setValue(val);
  322.                     }
  323.                 }, this);
  324.             }else if(Ext.isObject(id)){
  325.                 // set of name/value pairs
  326.                 for(var i in id){
  327.                     var f = this.getBox(i);
  328.                     if(f){
  329.                         f.setValue(id[i]);
  330.                     }
  331.                 }
  332.             }else{
  333.                 this.setValueForItem(id);
  334.             }
  335.         }else{
  336.             var f = this.getBox(id);
  337.             if(f){
  338.                 f.setValue(value);
  339.             }
  340.         }
  341.     },
  342.     // private
  343.     beforeDestroy: function(){
  344.         Ext.destroy(this.panel);
  345.         Ext.form.CheckboxGroup.superclass.beforeDestroy.call(this);
  346.     },
  347.     setValueForItem : function(val){
  348.         val = String(val).split(',');
  349.         this.eachItem(function(item){
  350.             if(val.indexOf(item.inputValue)> -1){
  351.                 item.setValue(true);
  352.             }
  353.         });
  354.     },
  355.     // private
  356.     getBox : function(id){
  357.         var box = null;
  358.         this.eachItem(function(f){
  359.             if(id == f || f.dataIndex == id || f.id == id || f.getName() == id){
  360.                 box = f;
  361.                 return false;
  362.             }
  363.         });
  364.         return box;
  365.     },
  366.     /**
  367.      * Gets an array of the selected {@link Ext.form.Checkbox} in the group.
  368.      * @return {Array} An array of the selected checkboxes.
  369.      */
  370.     getValue : function(){
  371.         var out = [];
  372.         this.eachItem(function(item){
  373.             if(item.checked){
  374.                 out.push(item);
  375.             }
  376.         });
  377.         return out;
  378.     },
  379.     // private
  380.     eachItem: function(fn){
  381.         if(this.items && this.items.each){
  382.             this.items.each(fn, this);
  383.         }
  384.     },
  385.     /**
  386.      * @cfg {String} name
  387.      * @hide
  388.      */
  389.     /**
  390.      * @method getRawValue
  391.      * @hide
  392.      */
  393.     getRawValue : Ext.emptyFn,
  394.     /**
  395.      * @method setRawValue
  396.      * @hide
  397.      */
  398.     setRawValue : Ext.emptyFn
  399. });
  400. Ext.reg('checkboxgroup', Ext.form.CheckboxGroup);