+++ /dev/null
-/*!
- * Ext JS Library 3.0.3
- * Copyright(c) 2006-2009 Ext JS, LLC
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
-/**\r
- * @class Ext.form.CheckboxGroup\r
- * @extends Ext.form.Field\r
- * <p>A grouping container for {@link Ext.form.Checkbox} controls.</p>\r
- * <p>Sample usage:</p>\r
- * <pre><code>\r
-var myCheckboxGroup = new Ext.form.CheckboxGroup({\r
- id:'myGroup',\r
- xtype: 'checkboxgroup',\r
- fieldLabel: 'Single Column',\r
- itemCls: 'x-check-group-alt',\r
- // Put all controls in a single column with width 100%\r
- columns: 1,\r
- items: [\r
- {boxLabel: 'Item 1', name: 'cb-col-1'},\r
- {boxLabel: 'Item 2', name: 'cb-col-2', checked: true},\r
- {boxLabel: 'Item 3', name: 'cb-col-3'}\r
- ]\r
-});\r
- * </code></pre>\r
- * @constructor\r
- * Creates a new CheckboxGroup\r
- * @param {Object} config Configuration options\r
- * @xtype checkboxgroup\r
- */\r
-Ext.form.CheckboxGroup = Ext.extend(Ext.form.Field, {\r
- /**\r
- * @cfg {Array} items An Array of {@link Ext.form.Checkbox Checkbox}es or Checkbox config objects\r
- * to arrange in the group.\r
- */\r
- /**\r
- * @cfg {String/Number/Array} columns Specifies the number of columns to use when displaying grouped\r
- * checkbox/radio controls using automatic layout. This config can take several types of values:\r
- * <ul><li><b>'auto'</b> : <p class="sub-desc">The controls will be rendered one per column on one row and the width\r
- * of each column will be evenly distributed based on the width of the overall field container. This is the default.</p></li>\r
- * <li><b>Number</b> : <p class="sub-desc">If you specific a number (e.g., 3) that number of columns will be \r
- * created and the contained controls will be automatically distributed based on the value of {@link #vertical}.</p></li>\r
- * <li><b>Array</b> : Object<p class="sub-desc">You can also specify an array of column widths, mixing integer\r
- * (fixed width) and float (percentage width) values as needed (e.g., [100, .25, .75]). Any integer values will\r
- * be rendered first, then any float values will be calculated as a percentage of the remaining space. Float\r
- * values do not have to add up to 1 (100%) although if you want the controls to take up the entire field\r
- * container you should do so.</p></li></ul>\r
- */\r
- columns : 'auto',\r
- /**\r
- * @cfg {Boolean} vertical True to distribute contained controls across columns, completely filling each column \r
- * top to bottom before starting on the next column. The number of controls in each column will be automatically\r
- * calculated to keep columns as even as possible. The default value is false, so that controls will be added\r
- * to columns one at a time, completely filling each row left to right before starting on the next row.\r
- */\r
- vertical : false,\r
- /**\r
- * @cfg {Boolean} allowBlank False to validate that at least one item in the group is checked (defaults to true).\r
- * If no items are selected at validation time, {@link @blankText} will be used as the error text.\r
- */\r
- allowBlank : true,\r
- /**\r
- * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails (defaults to "You must \r
- * select at least one item in this group")\r
- */\r
- blankText : "You must select at least one item in this group",\r
- \r
- // private\r
- defaultType : 'checkbox',\r
- \r
- // private\r
- groupCls : 'x-form-check-group',\r
- \r
- // private\r
- initComponent: function(){\r
- this.addEvents(\r
- /**\r
- * @event change\r
- * Fires when the state of a child checkbox changes.\r
- * @param {Ext.form.CheckboxGroup} this\r
- * @param {Array} checked An array containing the checked boxes.\r
- */\r
- 'change'\r
- ); \r
- Ext.form.CheckboxGroup.superclass.initComponent.call(this);\r
- },\r
- \r
- // private\r
- onRender : function(ct, position){\r
- if(!this.el){\r
- var panelCfg = {\r
- id: this.id,\r
- cls: this.groupCls,\r
- layout: 'column',\r
- border: false,\r
- renderTo: ct,\r
- bufferResize: false // Default this to false, since it doesn't really have a proper ownerCt.\r
- };\r
- var colCfg = {\r
- defaultType: this.defaultType,\r
- layout: 'form',\r
- border: false,\r
- defaults: {\r
- hideLabel: true,\r
- anchor: '100%'\r
- }\r
- };\r
- \r
- if(this.items[0].items){\r
- \r
- // The container has standard ColumnLayout configs, so pass them in directly\r
- \r
- Ext.apply(panelCfg, {\r
- layoutConfig: {columns: this.items.length},\r
- defaults: this.defaults,\r
- items: this.items\r
- });\r
- for(var i=0, len=this.items.length; i<len; i++){\r
- Ext.applyIf(this.items[i], colCfg);\r
- }\r
- \r
- }else{\r
- \r
- // The container has field item configs, so we have to generate the column\r
- // panels first then move the items into the columns as needed.\r
- \r
- var numCols, cols = [];\r
- \r
- if(typeof this.columns == 'string'){ // 'auto' so create a col per item\r
- this.columns = this.items.length;\r
- }\r
- if(!Ext.isArray(this.columns)){\r
- var cs = [];\r
- for(var i=0; i<this.columns; i++){\r
- cs.push((100/this.columns)*.01); // distribute by even %\r
- }\r
- this.columns = cs;\r
- }\r
- \r
- numCols = this.columns.length;\r
- \r
- // Generate the column configs with the correct width setting\r
- for(var i=0; i<numCols; i++){\r
- var cc = Ext.apply({items:[]}, colCfg);\r
- cc[this.columns[i] <= 1 ? 'columnWidth' : 'width'] = this.columns[i];\r
- if(this.defaults){\r
- cc.defaults = Ext.apply(cc.defaults || {}, this.defaults)\r
- }\r
- cols.push(cc);\r
- };\r
- \r
- // Distribute the original items into the columns\r
- if(this.vertical){\r
- var rows = Math.ceil(this.items.length / numCols), ri = 0;\r
- for(var i=0, len=this.items.length; i<len; i++){\r
- if(i>0 && i%rows==0){\r
- ri++;\r
- }\r
- if(this.items[i].fieldLabel){\r
- this.items[i].hideLabel = false;\r
- }\r
- cols[ri].items.push(this.items[i]);\r
- };\r
- }else{\r
- for(var i=0, len=this.items.length; i<len; i++){\r
- var ci = i % numCols;\r
- if(this.items[i].fieldLabel){\r
- this.items[i].hideLabel = false;\r
- }\r
- cols[ci].items.push(this.items[i]);\r
- };\r
- }\r
- \r
- Ext.apply(panelCfg, {\r
- layoutConfig: {columns: numCols},\r
- items: cols\r
- });\r
- }\r
- \r
- this.panel = new Ext.Panel(panelCfg);\r
- this.panel.ownerCt = this;\r
- this.el = this.panel.getEl();\r
- \r
- if(this.forId && this.itemCls){\r
- var l = this.el.up(this.itemCls).child('label', true);\r
- if(l){\r
- l.setAttribute('htmlFor', this.forId);\r
- }\r
- }\r
- \r
- var fields = this.panel.findBy(function(c){\r
- return c.isFormField;\r
- }, this);\r
- \r
- this.items = new Ext.util.MixedCollection();\r
- this.items.addAll(fields);\r
- }\r
- Ext.form.CheckboxGroup.superclass.onRender.call(this, ct, position);\r
- },\r
- \r
- initValue : function(){\r
- if(this.value){\r
- this.setValue.apply(this, this.buffered ? this.value : [this.value]);\r
- delete this.buffered;\r
- delete this.value;\r
- }\r
- },\r
- \r
- afterRender : function(){\r
- Ext.form.CheckboxGroup.superclass.afterRender.call(this);\r
- this.eachItem(function(item){\r
- item.on('check', this.fireChecked, this);\r
- item.inGroup = true;\r
- });\r
- },\r
- \r
- // private\r
- doLayout: function(){\r
- //ugly method required to layout hidden items\r
- if(this.rendered){\r
- this.panel.forceLayout = this.ownerCt.forceLayout;\r
- this.panel.doLayout();\r
- }\r
- },\r
- \r
- // private\r
- fireChecked: function(){\r
- var arr = [];\r
- this.eachItem(function(item){\r
- if(item.checked){\r
- arr.push(item);\r
- }\r
- });\r
- this.fireEvent('change', this, arr);\r
- },\r
- \r
- // private\r
- validateValue : function(value){\r
- if(!this.allowBlank){\r
- var blank = true;\r
- this.eachItem(function(f){\r
- if(f.checked){\r
- return (blank = false);\r
- }\r
- });\r
- if(blank){\r
- this.markInvalid(this.blankText);\r
- return false;\r
- }\r
- }\r
- return true;\r
- },\r
- \r
- // private\r
- isDirty: function(){\r
- //override the behaviour to check sub items.\r
- if (this.disabled || !this.rendered) {\r
- return false;\r
- }\r
-\r
- var dirty = false;\r
- this.eachItem(function(item){\r
- if(item.isDirty()){\r
- dirty = true;\r
- return false;\r
- }\r
- });\r
- return dirty;\r
- },\r
- \r
- // private\r
- onDisable : function(){\r
- this.eachItem(function(item){\r
- item.disable();\r
- });\r
- },\r
-\r
- // private\r
- onEnable : function(){\r
- this.eachItem(function(item){\r
- item.enable();\r
- });\r
- },\r
- \r
- // private\r
- doLayout: function(){\r
- if(this.rendered){\r
- this.panel.forceLayout = this.ownerCt.forceLayout;\r
- this.panel.doLayout();\r
- }\r
- },\r
- \r
- // private\r
- onResize : function(w, h){\r
- this.panel.setSize(w, h);\r
- this.panel.doLayout();\r
- },\r
- \r
- // inherit docs from Field\r
- reset : function(){\r
- Ext.form.CheckboxGroup.superclass.reset.call(this);\r
- this.eachItem(function(c){\r
- if(c.reset){\r
- c.reset();\r
- }\r
- });\r
- },\r
- \r
- /**\r
- * {@link Ext.form.Checkbox#setValue Set the value(s)} of an item or items\r
- * in the group. Examples illustrating how this method may be called:\r
- * <pre><code>\r
-// call with name and value\r
-myCheckboxGroup.setValue('cb-col-1', true);\r
-// call with an array of boolean values \r
-myCheckboxGroup.setValue([true, false, false]);\r
-// call with an object literal specifying item:value pairs\r
-myCheckboxGroup.setValue({\r
- 'cb-col-2': false,\r
- 'cb-col-3': true\r
-});\r
-// use comma separated string to set items with name to true (checked)\r
-myCheckboxGroup.setValue('cb-col-1,cb-col-3');\r
- * </code></pre>\r
- * See {@link Ext.form.Checkbox#setValue} for additional information.\r
- * @param {Mixed} id The checkbox to check, or as described by example shown.\r
- * @param {Boolean} value (optional) The value to set the item.\r
- * @return {Ext.form.CheckboxGroup} this\r
- */\r
- setValue: function(){\r
- if(this.rendered){\r
- this.onSetValue.apply(this, arguments);\r
- }else{\r
- this.buffered = true;\r
- this.value = arguments;\r
- }\r
- return this;\r
- },\r
- \r
- onSetValue: function(id, value){\r
- if(arguments.length == 1){\r
- if(Ext.isArray(id)){\r
- // an array of boolean values\r
- Ext.each(id, function(val, idx){\r
- var item = this.items.itemAt(idx);\r
- if(item){\r
- item.setValue(val);\r
- }\r
- }, this);\r
- }else if(Ext.isObject(id)){\r
- // set of name/value pairs\r
- for(var i in id){\r
- var f = this.getBox(i);\r
- if(f){\r
- f.setValue(id[i]);\r
- }\r
- }\r
- }else{\r
- this.setValueForItem(id);\r
- }\r
- }else{\r
- var f = this.getBox(id);\r
- if(f){\r
- f.setValue(value);\r
- }\r
- }\r
- },\r
- \r
- // private\r
- onDestroy: function(){\r
- Ext.destroy(this.panel);\r
- Ext.form.CheckboxGroup.superclass.onDestroy.call(this);\r
-\r
- },\r
- \r
- setValueForItem : function(val){\r
- val = String(val).split(',');\r
- this.eachItem(function(item){\r
- if(val.indexOf(item.inputValue)> -1){\r
- item.setValue(true);\r
- }\r
- });\r
- },\r
- \r
- // private\r
- getBox : function(id){\r
- var box = null;\r
- this.eachItem(function(f){\r
- if(id == f || f.dataIndex == id || f.id == id || f.getName() == id){\r
- box = f;\r
- return false;\r
- }\r
- });\r
- return box;\r
- },\r
- \r
- /**\r
- * Gets an array of the selected {@link Ext.form.Checkbox} in the group.\r
- * @return {Array} An array of the selected checkboxes.\r
- */\r
- getValue : function(){\r
- var out = [];\r
- this.eachItem(function(item){\r
- if(item.checked){\r
- out.push(item);\r
- }\r
- });\r
- return out;\r
- },\r
- \r
- // private\r
- eachItem: function(fn){\r
- if(this.items && this.items.each){\r
- this.items.each(fn, this);\r
- }\r
- },\r
- \r
- /**\r
- * @cfg {String} name\r
- * @hide\r
- */\r
-\r
- /**\r
- * @method getRawValue\r
- * @hide\r
- */\r
- getRawValue : Ext.emptyFn,\r
- \r
- /**\r
- * @method setRawValue\r
- * @hide\r
- */\r
- setRawValue : Ext.emptyFn\r
- \r
-});\r
-\r
-Ext.reg('checkboxgroup', Ext.form.CheckboxGroup);\r
git.ithinksw.org / extjs.git / blobdiff