Roo/ViewPanel.js
[roojs1] / Roo / ViewPanel.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.ViewPanel = function(container, config){
23     Roo.ViewPanel.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.ViewPanel, 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     render : function()
99     {
100         Roo.log(this);
101     },
102     onCellDblClick : function(g, row, col){
103         this.startEditing(row, col);
104     },
105
106     onEditComplete : function(ed, value, startValue){
107         this.editing = false;
108         this.activeEditor = null;
109         ed.un("specialkey", this.selModel.onEditorKey, this.selModel);
110         var r = ed.record;
111         var field = this.colModel.getDataIndex(ed.col);
112         var e = {
113             grid: this,
114             record: r,
115             field: field,
116             originalValue: startValue,
117             value: value,
118             row: ed.row,
119             column: ed.col,
120             cancel:false,
121             editor: ed
122         };
123         var cell = Roo.get(this.view.getCell(ed.row,ed.col))
124         cell.show();
125           
126         if(String(value) !== String(startValue)){
127             
128             if(this.fireEvent("validateedit", e) !== false && !e.cancel){
129                 r.set(field, e.value);
130                 // if we are dealing with a combo box..
131                 // then we also set the 'name' colum to be the displayField
132                 if (ed.field.displayField && ed.field.name) {
133                     r.set(ed.field.name, ed.field.el.dom.value);
134                 }
135                 
136                 delete e.cancel; //?? why!!!
137                 this.fireEvent("afteredit", e);
138             }
139         } else {
140             this.fireEvent("afteredit", e); // always fire it!
141         }
142         this.view.focusCell(ed.row, ed.col);
143     },
144
145     /**
146      * Starts editing the specified for the specified row/column
147      * @param {Number} rowIndex
148      * @param {Number} colIndex
149      */
150     startEditing : function(row, col){
151         this.stopEditing();
152         if(this.colModel.isCellEditable(col, row)){
153             this.view.ensureVisible(row, col, true);
154           
155             var r = this.dataSource.getAt(row);
156             var field = this.colModel.getDataIndex(col);
157             var cell = Roo.get(this.view.getCell(row,col));
158             var e = {
159                 grid: this,
160                 record: r,
161                 field: field,
162                 value: r.data[field],
163                 row: row,
164                 column: col,
165                 cancel:false 
166             };
167             if(this.fireEvent("beforeedit", e) !== false && !e.cancel){
168                 this.editing = true;
169                 var ed = this.colModel.getCellEditor(col, row);
170                 
171                 if (!ed) {
172                     return;
173                 }
174                 if(!ed.rendered){
175                     ed.render(ed.parentEl || document.body);
176                 }
177                 ed.field.reset();
178                
179                 cell.hide();
180                 
181                 (function(){ // complex but required for focus issues in safari, ie and opera
182                     ed.row = row;
183                     ed.col = col;
184                     ed.record = r;
185                     ed.on("complete",   this.onEditComplete,        this,       {single: true});
186                     ed.on("specialkey", this.selModel.onEditorKey,  this.selModel);
187                     this.activeEditor = ed;
188                     var v = r.data[field];
189                     ed.startEdit(this.view.getCell(row, col), v);
190                     // combo's with 'displayField and name set
191                     if (ed.field.displayField && ed.field.name) {
192                         ed.field.el.dom.value = r.data[ed.field.name];
193                     }
194                     
195                     
196                 }).defer(50, this);
197             }
198         }
199     },
200         
201     /**
202      * Stops any active editing
203      */
204     stopEditing : function(){
205         if(this.activeEditor){
206             this.activeEditor.completeEdit();
207         }
208         this.activeEditor = null;
209     },
210         
211          /**
212      * Called to get grid's drag proxy text, by default returns this.ddText.
213      * @return {String}
214      */
215     getDragDropText : function(){
216         var count = this.selModel.getSelectedCell() ? 1 : 0;
217         return String.format(this.ddText, count, count == 1 ? '' : 's');
218     }
219         
220 });