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.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 };