Upgrade to ExtJS 3.0.0 - Released 07/06/2009

[extjs.git] / src / widgets / grid / CheckboxSelectionModel.js

diff --git a/src/widgets/grid/CheckboxSelectionModel.js b/src/widgets/grid/CheckboxSelectionModel.js
new file mode 100644 (file)
index 0000000..408fb98
--- /dev/null
+++ b/src/widgets/grid/CheckboxSelectionModel.js
@@ -0,0 +1,103 @@
+/*!
+ * Ext JS Library 3.0.0
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+/**\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
+    /**\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
+    /**\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
+    /**\r
+     * @cfg {Number} width The default width in pixels of the checkbox column (defaults to <tt>20</tt>).\r
+     */\r
+    width: 20,\r
+    /**\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
+});
\ No newline at end of file