git.roojs.org Git - roojs1/blob - Roo/grid/EditorGrid.js

   1 /*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * <script type="text/javascript">
  10  */
  11
  12 /**
  13  * @class Roo.grid.EditorGrid
  14  * @extends Roo.grid.Grid
  15  * Class for creating and editable grid.
  16  * @param {String/HTMLElement/Roo.Element} container The element into which this grid will be rendered -
  17  * The container MUST have some type of size defined for the grid to fill. The container will be
  18  * automatically set to position relative if it isn't already.
  19  * @param {Object} dataSource The data model to bind to
  20  * @param {Object} colModel The column model with info about this grid's columns
  21  */
  22 Roo.grid.EditorGrid = function(container, config){
  23     Roo.grid.EditorGrid.superclass.constructor.call(this, container, config);
  24     this.getGridEl().addClass("xedit-grid");
  25
  26     if(!this.selModel){
  27         this.selModel = new Roo.grid.CellSelectionModel();
  28     }
  29
  30     this.activeEditor = null;
  31
  32         this.addEvents({
  33             /**
  34              * @event beforeedit
  35              * Fires before cell editing is triggered. The edit event object has the following properties <br />
  36              * <ul style="padding:5px;padding-left:16px;">
  37              * <li>grid - This grid</li>
  38              * <li>record - The record being edited</li>
  39              * <li>field - The field name being edited</li>
  40              * <li>value - The value for the field being edited.</li>
  41              * <li>row - The grid row index</li>
  42              * <li>column - The grid column index</li>
  43              * <li>cancel - Set this to true to cancel the edit or return false from your handler.</li>
  44              * </ul>
  45              * @param {Object} e An edit event (see above for description)
  46              */
  47             "beforeedit" : true,
  48             /**
  49              * @event afteredit
  50              * Fires after a cell is edited. <br />
  51              * <ul style="padding:5px;padding-left:16px;">
  52              * <li>grid - This grid</li>
  53              * <li>record - The record being edited</li>
  54              * <li>field - The field name being edited</li>
  55              * <li>value - The value being set</li>
  56              * <li>originalValue - The original value for the field, before the edit.</li>
  57              * <li>row - The grid row index</li>
  58              * <li>column - The grid column index</li>
  59              * </ul>
  60              * @param {Object} e An edit event (see above for description)
  61              */
  62             "afteredit" : true,
  63             /**
  64              * @event validateedit
  65              * Fires after a cell is edited, but before the value is set in the record.
  66          * You can use this to modify the value being set in the field, Return false
  67              * to cancel the change. The edit event object has the following properties <br />
  68              * <ul style="padding:5px;padding-left:16px;">
  69          * <li>editor - This editor</li>
  70              * <li>grid - This grid</li>
  71              * <li>record - The record being edited</li>
  72              * <li>field - The field name being edited</li>
  73              * <li>value - The value being set</li>
  74              * <li>originalValue - The original value for the field, before the edit.</li>
  75              * <li>row - The grid row index</li>
  76              * <li>column - The grid column index</li>
  77              * <li>cancel - Set this to true to cancel the edit or return false from your handler.</li>
  78              * </ul>
  79              * @param {Object} e An edit event (see above for description)
  80              */
  81             "validateedit" : true
  82         });
  83     this.on("bodyscroll", this.stopEditing,  this);
  84     this.on(this.clicksToEdit == 1 ? "cellclick" : "celldblclick", this.onCellDblClick,  this);
  85 };
  86
  87 Roo.extend(Roo.grid.EditorGrid, Roo.grid.Grid, {
  88     /**
  89      * @cfg {Number} clicksToEdit
  90      * The number of clicks on a cell required to display the cell's editor (defaults to 2)
  91      */
  92     clicksToEdit: 2,
  93
  94     // private
  95     isEditor : true,
  96     // private
  97     trackMouseOver: false, // causes very odd FF errors
  98
  99     onCellDblClick : function(g, row, col){
 100         this.startEditing(row, col);
 101     },
 102
 103     onEditComplete : function(ed, value, startValue){
 104         this.editing = false;
 105         this.activeEditor = null;
 106         ed.un("specialkey", this.selModel.onEditorKey, this.selModel);
 107         var r = ed.record;
 108         var field = this.colModel.getDataIndex(ed.col);
 109         var e = {
 110             grid: this,
 111             record: r,
 112             field: field,
 113             originalValue: startValue,
 114             value: value,
 115             row: ed.row,
 116             column: ed.col,
 117             cancel:false,
 118             editor: ed
 119         };
 120         var cell = Roo.get(this.view.getCell(ed.row,ed.col));
 121         cell.show();
 122
 123         if(String(value) !== String(startValue)){
 124
 125             if(this.fireEvent("validateedit", e) !== false && !e.cancel){
 126                 r.set(field, e.value);
 127                 // if we are dealing with a combo box..
 128                 // then we also set the 'name' colum to be the displayField
 129                 if (ed.field.displayField && ed.field.name) {
 130                     r.set(ed.field.name, ed.field.el.dom.value);
 131                 }
 132
 133                 delete e.cancel; //?? why!!!
 134                 this.fireEvent("afteredit", e);
 135             }
 136         } else {
 137             this.fireEvent("afteredit", e); // always fire it!
 138         }
 139         this.view.focusCell(ed.row, ed.col);
 140     },
 141
 142     /**
 143      * Starts editing the specified for the specified row/column
 144      * @param {Number} rowIndex
 145      * @param {Number} colIndex
 146      */
 147     startEditing : function(row, col){
 148         this.stopEditing();
 149         if(this.colModel.isCellEditable(col, row)){
 150             this.view.ensureVisible(row, col, true);
 151
 152             var r = this.dataSource.getAt(row);
 153             var field = this.colModel.getDataIndex(col);
 154             var cell = Roo.get(this.view.getCell(row,col));
 155             var e = {
 156                 grid: this,
 157                 record: r,
 158                 field: field,
 159                 value: r.data[field],
 160                 row: row,
 161                 column: col,
 162                 cancel:false
 163             };
 164             if(this.fireEvent("beforeedit", e) !== false && !e.cancel){
 165                 this.editing = true;
 166                 var ed = this.colModel.getCellEditor(col, row);
 167
 168                 if (!ed) {
 169                     return;
 170                 }
 171                 if(!ed.rendered){
 172                     ed.render(ed.parentEl || document.body);
 173                 }
 174                 ed.field.reset();
 175
 176                 cell.hide();
 177
 178                 (function(){ // complex but required for focus issues in safari, ie and opera
 179                     ed.row = row;
 180                     ed.col = col;
 181                     ed.record = r;
 182                     ed.on("complete",   this.onEditComplete,        this,       {single: true});
 183                     ed.on("specialkey", this.selModel.onEditorKey,  this.selModel);
 184                     this.activeEditor = ed;
 185                     var v = r.data[field];
 186                     ed.startEdit(this.view.getCell(row, col), v);
 187                     // combo's with 'displayField and name set
 188                     if (ed.field.displayField && ed.field.name) {
 189                         ed.field.el.dom.value = r.data[ed.field.name];
 190                     }
 191
 192
 193                 }).defer(50, this);
 194             }
 195         }
 196     },
 197
 198     /**
 199      * Stops any active editing
 200      */
 201     stopEditing : function(){
 202         if(this.activeEditor){
 203             this.activeEditor.completeEdit();
 204         }
 205         this.activeEditor = null;
 206     },
 207
 208          /**
 209      * Called to get grid's drag proxy text, by default returns this.ddText.
 210      * @return {String}
 211      */
 212     getDragDropText : function(){
 213         var count = this.selModel.getSelectedCell() ? 1 : 0;
 214         return String.format(this.ddText, count, count == 1 ? '' : 's');
 215     }
 216
 217 });