src/widgets/grid/EditorGrid.js

   1 /*!
   2  * Ext JS Library 3.0.0
   3  * Copyright(c) 2006-2009 Ext JS, LLC
   4  * licensing@extjs.com
   5  * http://www.extjs.com/license
   6  */
   7 /**
   8  * @class Ext.grid.EditorGridPanel
   9  * @extends Ext.grid.GridPanel
  10  * <p>This class extends the {@link Ext.grid.GridPanel GridPanel Class} to provide cell editing
  11  * on selected {@link Ext.grid.Column columns}. The editable columns are specified by providing
  12  * an {@link Ext.grid.ColumnModel#editor editor} in the {@link Ext.grid.Column column configuration}.</p>
  13  * <p>Editability of columns may be controlled programatically by inserting an implementation
  14  * of {@link Ext.grid.ColumnModel#isCellEditable isCellEditable} into the
  15  * {@link Ext.grid.ColumnModel ColumnModel}.</p>
  16  * <p>Editing is performed on the value of the <i>field</i> specified by the column's
  17  * <tt>{@link Ext.grid.ColumnModel#dataIndex dataIndex}</tt> in the backing {@link Ext.data.Store Store}
  18  * (so if you are using a {@link Ext.grid.ColumnModel#setRenderer renderer} in order to display
  19  * transformed data, this must be accounted for).</p>
  20  * <p>If a value-to-description mapping is used to render a column, then a {@link Ext.form.Field#ComboBox ComboBox}
  21  * which uses the same {@link Ext.form.Field#valueField value}-to-{@link Ext.form.Field#displayFieldField description}
  22  * mapping would be an appropriate editor.</p>
  23  * If there is a more complex mismatch between the visible data in the grid, and the editable data in
  24  * the {@link Edt.data.Store Store}, then code to transform the data both before and after editing can be
  25  * injected using the {@link #beforeedit} and {@link #afteredit} events.
  26  * @constructor
  27  * @param {Object} config The config object
  28  * @xtype editorgrid
  29  */
  30 Ext.grid.EditorGridPanel = Ext.extend(Ext.grid.GridPanel, {
  31     /**
  32      * @cfg {Number} clicksToEdit
  33      * <p>The number of clicks on a cell required to display the cell's editor (defaults to 2).</p>
  34      * <p>Setting this option to 'auto' means that mousedown <i>on the selected cell</i> starts
  35      * editing that cell.</p>
  36      */
  37     clicksToEdit: 2,
  38
  39     /**
  40     * @cfg {Boolean} forceValidation
  41     * True to force validation even if the value is unmodified (defaults to false)
  42     */
  43     forceValidation: false,
  44
  45     // private
  46     isEditor : true,
  47     // private
  48     detectEdit: false,
  49
  50         /**
  51          * @cfg {Boolean} autoEncode
  52          * True to automatically HTML encode and decode values pre and post edit (defaults to false)
  53          */
  54         autoEncode : false,
  55
  56         /**
  57          * @cfg {Boolean} trackMouseOver @hide
  58          */
  59     // private
  60     trackMouseOver: false, // causes very odd FF errors
  61
  62     // private
  63     initComponent : function(){
  64         Ext.grid.EditorGridPanel.superclass.initComponent.call(this);
  65
  66         if(!this.selModel){
  67             /**
  68              * @cfg {Object} selModel Any subclass of AbstractSelectionModel that will provide the selection model for
  69              * the grid (defaults to {@link Ext.grid.CellSelectionModel} if not specified).
  70              */
  71             this.selModel = new Ext.grid.CellSelectionModel();
  72         }
  73
  74         this.activeEditor = null;
  75
  76             this.addEvents(
  77             /**
  78              * @event beforeedit
  79              * Fires before cell editing is triggered. The edit event object has the following properties <br />
  80              * <ul style="padding:5px;padding-left:16px;">
  81              * <li>grid - This grid</li>
  82              * <li>record - The record being edited</li>
  83              * <li>field - The field name being edited</li>
  84              * <li>value - The value for the field being edited.</li>
  85              * <li>row - The grid row index</li>
  86              * <li>column - The grid column index</li>
  87              * <li>cancel - Set this to true to cancel the edit or return false from your handler.</li>
  88              * </ul>
  89              * @param {Object} e An edit event (see above for description)
  90              */
  91             "beforeedit",
  92             /**
  93              * @event afteredit
  94              * Fires after a cell is edited. The edit event object has the following properties <br />
  95              * <ul style="padding:5px;padding-left:16px;">
  96              * <li>grid - This grid</li>
  97              * <li>record - The record being edited</li>
  98              * <li>field - The field name being edited</li>
  99              * <li>value - The value being set</li>
 100              * <li>originalValue - The original value for the field, before the edit.</li>
 101              * <li>row - The grid row index</li>
 102              * <li>column - The grid column index</li>
 103              * </ul>
 104              *
 105              * <pre><code>
 106 grid.on('afteredit', afterEdit, this );
 107
 108 function afterEdit(e) {
 109     // execute an XHR to send/commit data to the server, in callback do (if successful):
 110     e.record.commit();
 111 };
 112              * </code></pre>
 113              * @param {Object} e An edit event (see above for description)
 114              */
 115             "afteredit",
 116             /**
 117              * @event validateedit
 118              * Fires after a cell is edited, but before the value is set in the record. Return false
 119              * to cancel the change. The edit event object has the following properties <br />
 120              * <ul style="padding:5px;padding-left:16px;">
 121              * <li>grid - This grid</li>
 122              * <li>record - The record being edited</li>
 123              * <li>field - The field name being edited</li>
 124              * <li>value - The value being set</li>
 125              * <li>originalValue - The original value for the field, before the edit.</li>
 126              * <li>row - The grid row index</li>
 127              * <li>column - The grid column index</li>
 128              * <li>cancel - Set this to true to cancel the edit or return false from your handler.</li>
 129              * </ul>
 130              * Usage example showing how to remove the red triangle (dirty record indicator) from some
 131              * records (not all).  By observing the grid's validateedit event, it can be cancelled if
 132              * the edit occurs on a targeted row (for example) and then setting the field's new value
 133              * in the Record directly:
 134              * <pre><code>
 135 grid.on('validateedit', function(e) {
 136   var myTargetRow = 6;
 137
 138   if (e.row == myTargetRow) {
 139     e.cancel = true;
 140     e.record.data[e.field] = e.value;
 141   }
 142 });
 143              * </code></pre>
 144              * @param {Object} e An edit event (see above for description)
 145              */
 146             "validateedit"
 147         );
 148     },
 149
 150     // private
 151     initEvents : function(){
 152         Ext.grid.EditorGridPanel.superclass.initEvents.call(this);
 153
 154         this.on("bodyscroll", this.stopEditing, this, [true]);
 155         this.on("columnresize", this.stopEditing, this, [true]);
 156
 157         if(this.clicksToEdit == 1){
 158             this.on("cellclick", this.onCellDblClick, this);
 159         }else {
 160             if(this.clicksToEdit == 'auto' && this.view.mainBody){
 161                 this.view.mainBody.on("mousedown", this.onAutoEditClick, this);
 162             }
 163             this.on("celldblclick", this.onCellDblClick, this);
 164         }
 165     },
 166
 167     // private
 168     onCellDblClick : function(g, row, col){
 169         this.startEditing(row, col);
 170     },
 171
 172     // private
 173     onAutoEditClick : function(e, t){
 174         if(e.button !== 0){
 175             return;
 176         }
 177         var row = this.view.findRowIndex(t);
 178         var col = this.view.findCellIndex(t);
 179         if(row !== false && col !== false){
 180             this.stopEditing();
 181             if(this.selModel.getSelectedCell){ // cell sm
 182                 var sc = this.selModel.getSelectedCell();
 183                 if(sc && sc[0] === row && sc[1] === col){
 184                     this.startEditing(row, col);
 185                 }
 186             }else{
 187                 if(this.selModel.isSelected(row)){
 188                     this.startEditing(row, col);
 189                 }
 190             }
 191         }
 192     },
 193
 194     // private
 195     onEditComplete : function(ed, value, startValue){
 196         this.editing = false;
 197         this.activeEditor = null;
 198         ed.un("specialkey", this.selModel.onEditorKey, this.selModel);
 199                 var r = ed.record;
 200         var field = this.colModel.getDataIndex(ed.col);
 201         value = this.postEditValue(value, startValue, r, field);
 202         if(this.forceValidation === true || String(value) !== String(startValue)){
 203             var e = {
 204                 grid: this,
 205                 record: r,
 206                 field: field,
 207                 originalValue: startValue,
 208                 value: value,
 209                 row: ed.row,
 210                 column: ed.col,
 211                 cancel:false
 212             };
 213             if(this.fireEvent("validateedit", e) !== false && !e.cancel && String(value) !== String(startValue)){
 214                 r.set(field, e.value);
 215                 delete e.cancel;
 216                 this.fireEvent("afteredit", e);
 217             }
 218         }
 219         this.view.focusCell(ed.row, ed.col);
 220     },
 221
 222     /**
 223      * Starts editing the specified for the specified row/column
 224      * @param {Number} rowIndex
 225      * @param {Number} colIndex
 226      */
 227     startEditing : function(row, col){
 228         this.stopEditing();
 229         if(this.colModel.isCellEditable(col, row)){
 230             this.view.ensureVisible(row, col, true);
 231             var r = this.store.getAt(row);
 232             var field = this.colModel.getDataIndex(col);
 233             var e = {
 234                 grid: this,
 235                 record: r,
 236                 field: field,
 237                 value: r.data[field],
 238                 row: row,
 239                 column: col,
 240                 cancel:false
 241             };
 242             if(this.fireEvent("beforeedit", e) !== false && !e.cancel){
 243                 this.editing = true;
 244                 var ed = this.colModel.getCellEditor(col, row);
 245                 if(!ed){
 246                     return;
 247                 }
 248                 if(!ed.rendered){
 249                     ed.render(this.view.getEditorParent(ed));
 250                 }
 251                 (function(){ // complex but required for focus issues in safari, ie and opera
 252                     ed.row = row;
 253                     ed.col = col;
 254                     ed.record = r;
 255                     ed.on("complete", this.onEditComplete, this, {single: true});
 256                     ed.on("specialkey", this.selModel.onEditorKey, this.selModel);
 257                     /**
 258                      * The currently active editor or null
 259                       * @type Ext.Editor
 260                      */
 261                     this.activeEditor = ed;
 262                     var v = this.preEditValue(r, field);
 263                     ed.startEdit(this.view.getCell(row, col).firstChild, v === undefined ? '' : v);
 264                 }).defer(50, this);
 265             }
 266         }
 267     },
 268
 269     // private
 270     preEditValue : function(r, field){
 271         var value = r.data[field];
 272         return this.autoEncode && typeof value == 'string' ? Ext.util.Format.htmlDecode(value) : value;
 273     },
 274
 275     // private
 276         postEditValue : function(value, originalValue, r, field){
 277                 return this.autoEncode && typeof value == 'string' ? Ext.util.Format.htmlEncode(value) : value;
 278         },
 279
 280     /**
 281      * Stops any active editing
 282      * @param {Boolean} cancel (optional) True to cancel any changes
 283      */
 284     stopEditing : function(cancel){
 285         if(this.activeEditor){
 286             this.activeEditor[cancel === true ? 'cancelEdit' : 'completeEdit']();
 287         }
 288         this.activeEditor = null;
 289     }
 290 });
 291 Ext.reg('editorgrid', Ext.grid.EditorGridPanel);