Upgrade to ExtJS 3.2.0 - Released 03/30/2010
[extjs.git] / docs / source / CheckboxSelectionModel.html
index 224f9fe..02ac6cd 100644 (file)
-<html>\r
-<head>\r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js"><div id="cls-Ext.grid.CheckboxSelectionModel"></div>/**\r
- * @class Ext.grid.CheckboxSelectionModel\r
- * @extends Ext.grid.RowSelectionModel\r
- * A custom selection model that renders a column of checkboxes that can be toggled to select or deselect rows.\r
- * @constructor\r
- * @param {Object} config The configuration options\r
- */\r
-Ext.grid.CheckboxSelectionModel = Ext.extend(Ext.grid.RowSelectionModel, {\r
-\r
-    <div id="cfg-Ext.grid.CheckboxSelectionModel-checkOnly"></div>/**\r
-     * @cfg {Boolean} checkOnly <tt>true</tt> if rows can only be selected by clicking on the\r
-     * checkbox column (defaults to <tt>false</tt>).\r
-     */\r
-    <div id="cfg-Ext.grid.CheckboxSelectionModel-header"></div>/**\r
-     * @cfg {String} header Any valid text or HTML fragment to display in the header cell for the\r
-     * checkbox column.  Defaults to:<pre><code>\r
-     * '&lt;div class="x-grid3-hd-checker">&#38;#160;&lt;/div>'</tt>\r
-     * </code></pre>\r
-     * The default CSS class of <tt>'x-grid3-hd-checker'</tt> displays a checkbox in the header\r
-     * and provides support for automatic check all/none behavior on header click. This string\r
-     * can be replaced by any valid HTML fragment, including a simple text string (e.g.,\r
-     * <tt>'Select Rows'</tt>), but the automatic check all/none behavior will only work if the\r
-     * <tt>'x-grid3-hd-checker'</tt> class is supplied.\r
-     */\r
-    header: '<div class="x-grid3-hd-checker">&#160;</div>',\r
-    <div id="cfg-Ext.grid.CheckboxSelectionModel-width"></div>/**\r
-     * @cfg {Number} width The default width in pixels of the checkbox column (defaults to <tt>20</tt>).\r
-     */\r
-    width: 20,\r
-    <div id="cfg-Ext.grid.CheckboxSelectionModel-sortable"></div>/**\r
-     * @cfg {Boolean} sortable <tt>true</tt> if the checkbox column is sortable (defaults to\r
-     * <tt>false</tt>).\r
-     */\r
-    sortable: false,\r
-\r
-    // private\r
-    menuDisabled:true,\r
-    fixed:true,\r
-    dataIndex: '',\r
-    id: 'checker',\r
-\r
-    constructor: function(){\r
-        Ext.grid.CheckboxSelectionModel.superclass.constructor.apply(this, arguments);\r
-\r
-        if(this.checkOnly){\r
-            this.handleMouseDown = Ext.emptyFn;\r
-        }\r
-    },\r
-\r
-    // private\r
-    initEvents : function(){\r
-        Ext.grid.CheckboxSelectionModel.superclass.initEvents.call(this);\r
-        this.grid.on('render', function(){\r
-            var view = this.grid.getView();\r
-            view.mainBody.on('mousedown', this.onMouseDown, this);\r
-            Ext.fly(view.innerHd).on('mousedown', this.onHdMouseDown, this);\r
-\r
-        }, this);\r
-    },\r
-\r
-    // private\r
-    onMouseDown : function(e, t){\r
-        if(e.button === 0 && t.className == 'x-grid3-row-checker'){ // Only fire if left-click\r
-            e.stopEvent();\r
-            var row = e.getTarget('.x-grid3-row');\r
-            if(row){\r
-                var index = row.rowIndex;\r
-                if(this.isSelected(index)){\r
-                    this.deselectRow(index);\r
-                }else{\r
-                    this.selectRow(index, true);\r
-                }\r
-            }\r
-        }\r
-    },\r
-\r
-    // private\r
-    onHdMouseDown : function(e, t){\r
-        if(t.className == 'x-grid3-hd-checker'){\r
-            e.stopEvent();\r
-            var hd = Ext.fly(t.parentNode);\r
-            var isChecked = hd.hasClass('x-grid3-hd-checker-on');\r
-            if(isChecked){\r
-                hd.removeClass('x-grid3-hd-checker-on');\r
-                this.clearSelections();\r
-            }else{\r
-                hd.addClass('x-grid3-hd-checker-on');\r
-                this.selectAll();\r
-            }\r
-        }\r
-    },\r
-\r
-    // private\r
-    renderer : function(v, p, record){\r
-        return '<div class="x-grid3-row-checker">&#160;</div>';\r
-    }\r
-});</pre>    \r
-</body>\r
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
+  <title>The source code</title>
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+</head>
+<body  onload="prettyPrint();">
+    <pre class="prettyprint lang-js">/*!
+ * Ext JS Library 3.2.0
+ * Copyright(c) 2006-2010 Ext JS, Inc.
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+<div id="cls-Ext.grid.CheckboxSelectionModel"></div>/**
+ * @class Ext.grid.CheckboxSelectionModel
+ * @extends Ext.grid.RowSelectionModel
+ * A custom selection model that renders a column of checkboxes that can be toggled to select or deselect rows.
+ * @constructor
+ * @param {Object} config The configuration options
+ */
+Ext.grid.CheckboxSelectionModel = Ext.extend(Ext.grid.RowSelectionModel, {
+
+    <div id="cfg-Ext.grid.CheckboxSelectionModel-checkOnly"></div>/**
+     * @cfg {Boolean} checkOnly <tt>true</tt> if rows can only be selected by clicking on the
+     * checkbox column (defaults to <tt>false</tt>).
+     */
+    <div id="cfg-Ext.grid.CheckboxSelectionModel-header"></div>/**
+     * @cfg {String} header Any valid text or HTML fragment to display in the header cell for the
+     * checkbox column.  Defaults to:<pre><code>
+     * '&lt;div class="x-grid3-hd-checker">&#38;#160;&lt;/div>'</tt>
+     * </code></pre>
+     * The default CSS class of <tt>'x-grid3-hd-checker'</tt> displays a checkbox in the header
+     * and provides support for automatic check all/none behavior on header click. This string
+     * can be replaced by any valid HTML fragment, including a simple text string (e.g.,
+     * <tt>'Select Rows'</tt>), but the automatic check all/none behavior will only work if the
+     * <tt>'x-grid3-hd-checker'</tt> class is supplied.
+     */
+    header : '<div class="x-grid3-hd-checker">&#160;</div>',
+    <div id="cfg-Ext.grid.CheckboxSelectionModel-width"></div>/**
+     * @cfg {Number} width The default width in pixels of the checkbox column (defaults to <tt>20</tt>).
+     */
+    width : 20,
+    <div id="cfg-Ext.grid.CheckboxSelectionModel-sortable"></div>/**
+     * @cfg {Boolean} sortable <tt>true</tt> if the checkbox column is sortable (defaults to
+     * <tt>false</tt>).
+     */
+    sortable : false,
+
+    // private
+    menuDisabled : true,
+    fixed : true,
+    hideable: false,
+    dataIndex : '',
+    id : 'checker',
+
+    constructor : function(){
+        Ext.grid.CheckboxSelectionModel.superclass.constructor.apply(this, arguments);
+
+        if(this.checkOnly){
+            this.handleMouseDown = Ext.emptyFn;
+        }
+    },
+
+    // private
+    initEvents : function(){
+        Ext.grid.CheckboxSelectionModel.superclass.initEvents.call(this);
+        this.grid.on('render', function(){
+            var view = this.grid.getView();
+            view.mainBody.on('mousedown', this.onMouseDown, this);
+            Ext.fly(view.innerHd).on('mousedown', this.onHdMouseDown, this);
+
+        }, this);
+    },
+
+    // If handleMouseDown was called from another event (enableDragDrop), set a flag so
+    // onMouseDown does not process it a second time
+    handleMouseDown : function() {
+        Ext.grid.CheckboxSelectionModel.superclass.handleMouseDown.apply(this, arguments);
+        this.mouseHandled = true;
+    },
+
+    // private
+    onMouseDown : function(e, t){
+        if(e.button === 0 && t.className == 'x-grid3-row-checker'){ // Only fire if left-click
+            e.stopEvent();
+            var row = e.getTarget('.x-grid3-row');
+
+            // mouseHandled flag check for a duplicate selection (handleMouseDown) call
+            if(!this.mouseHandled && row){
+                var index = row.rowIndex;
+                if(this.isSelected(index)){
+                    this.deselectRow(index);
+                }else{
+                    this.selectRow(index, true);
+                }
+            }
+        }
+        this.mouseHandled = false;
+    },
+
+    // private
+    onHdMouseDown : function(e, t){
+        if(t.className == 'x-grid3-hd-checker'){
+            e.stopEvent();
+            var hd = Ext.fly(t.parentNode);
+            var isChecked = hd.hasClass('x-grid3-hd-checker-on');
+            if(isChecked){
+                hd.removeClass('x-grid3-hd-checker-on');
+                this.clearSelections();
+            }else{
+                hd.addClass('x-grid3-hd-checker-on');
+                this.selectAll();
+            }
+        }
+    },
+
+    // private
+    renderer : function(v, p, record){
+        return '<div class="x-grid3-row-checker">&#160;</div>';
+    }
+});</pre>    
+</body>
 </html>
\ No newline at end of file