3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
8 * @class Ext.grid.PropertyRecord
9 * A specific {@link Ext.data.Record} type that represents a name/value pair and is made to work with the
10 * {@link Ext.grid.PropertyGrid}. Typically, PropertyRecords do not need to be created directly as they can be
11 * created implicitly by simply using the appropriate data configs either via the {@link Ext.grid.PropertyGrid#source}
12 * config property or by calling {@link Ext.grid.PropertyGrid#setSource}. However, if the need arises, these records
13 * can also be created explicitly as shwon below. Example usage:
15 var rec = new Ext.grid.PropertyRecord({
17 value: new Date(Date.parse('05/26/1972'))
19 // Add record to an already populated grid
20 grid.store.addSorted(rec);
23 * @param {Object} config A data object in the format: {name: [name], value: [value]}. The specified value's type
24 * will be read automatically by the grid to determine the type of editor to use when displaying it.
26 Ext.grid.PropertyRecord = Ext.data.Record.create([
27 {name:'name',type:'string'}, 'value'
31 * @class Ext.grid.PropertyStore
32 * @extends Ext.util.Observable
33 * A custom wrapper for the {@link Ext.grid.PropertyGrid}'s {@link Ext.data.Store}. This class handles the mapping
34 * between the custom data source objects supported by the grid and the {@link Ext.grid.PropertyRecord} format
35 * required for compatibility with the underlying store. Generally this class should not need to be used directly --
36 * the grid's data should be accessed from the underlying store via the {@link #store} property.
38 * @param {Ext.grid.Grid} grid The grid this store will be bound to
39 * @param {Object} source The source data config object
41 Ext.grid.PropertyStore = Ext.extend(Ext.util.Observable, {
43 constructor : function(grid, source){
45 this.store = new Ext.data.Store({
46 recordType : Ext.grid.PropertyRecord
48 this.store.on('update', this.onUpdate, this);
50 this.setSource(source);
52 Ext.grid.PropertyStore.superclass.constructor.call(this);
55 // protected - should only be called by the grid. Use grid.setSource instead.
56 setSource : function(o){
58 this.store.removeAll();
61 if(this.isEditableValue(o[k])){
62 data.push(new Ext.grid.PropertyRecord({name: k, value: o[k]}, k));
65 this.store.loadRecords({records: data}, {}, true);
69 onUpdate : function(ds, record, type){
70 if(type == Ext.data.Record.EDIT){
71 var v = record.data.value;
72 var oldValue = record.modified.value;
73 if(this.grid.fireEvent('beforepropertychange', this.source, record.id, v, oldValue) !== false){
74 this.source[record.id] = v;
76 this.grid.fireEvent('propertychange', this.source, record.id, v, oldValue);
84 getProperty : function(row){
85 return this.store.getAt(row);
89 isEditableValue: function(val){
90 return Ext.isPrimitive(val) || Ext.isDate(val);
94 setValue : function(prop, value){
95 this.source[prop] = value;
96 this.store.getById(prop).set('value', value);
99 // protected - should only be called by the grid. Use grid.getSource instead.
100 getSource : function(){
106 * @class Ext.grid.PropertyColumnModel
107 * @extends Ext.grid.ColumnModel
108 * A custom column model for the {@link Ext.grid.PropertyGrid}. Generally it should not need to be used directly.
110 * @param {Ext.grid.Grid} grid The grid this store will be bound to
111 * @param {Object} source The source data config object
113 Ext.grid.PropertyColumnModel = Ext.extend(Ext.grid.ColumnModel, {
114 // private - strings used for locale support
117 dateFormat : 'm/j/Y',
119 constructor : function(grid, store){
124 g.PropertyColumnModel.superclass.constructor.call(this, [
125 {header: this.nameText, width:50, sortable: true, dataIndex:'name', id: 'name', menuDisabled:true},
126 {header: this.valueText, width:50, resizable:false, dataIndex: 'value', id: 'value', menuDisabled:true}
130 var bfield = new f.Field({
131 autoCreate: {tag: 'select', children: [
132 {tag: 'option', value: 'true', html: 'true'},
133 {tag: 'option', value: 'false', html: 'false'}
135 getValue : function(){
136 return this.el.dom.value == 'true';
140 'date' : new g.GridEditor(new f.DateField({selectOnFocus:true})),
141 'string' : new g.GridEditor(new f.TextField({selectOnFocus:true})),
142 'number' : new g.GridEditor(new f.NumberField({selectOnFocus:true, style:'text-align:left;'})),
143 'boolean' : new g.GridEditor(bfield, {
147 this.renderCellDelegate = this.renderCell.createDelegate(this);
148 this.renderPropDelegate = this.renderProp.createDelegate(this);
152 renderDate : function(dateVal){
153 return dateVal.dateFormat(this.dateFormat);
157 renderBool : function(bVal){
158 return bVal ? 'true' : 'false';
162 isCellEditable : function(colIndex, rowIndex){
163 return colIndex == 1;
167 getRenderer : function(col){
169 this.renderCellDelegate : this.renderPropDelegate;
173 renderProp : function(v){
174 return this.getPropertyName(v);
178 renderCell : function(val){
181 rv = this.renderDate(val);
182 }else if(typeof val == 'boolean'){
183 rv = this.renderBool(val);
185 return Ext.util.Format.htmlEncode(rv);
189 getPropertyName : function(name){
190 var pn = this.grid.propertyNames;
191 return pn && pn[name] ? pn[name] : name;
195 getCellEditor : function(colIndex, rowIndex){
196 var p = this.store.getProperty(rowIndex),
199 if(this.grid.customEditors[n]){
200 return this.grid.customEditors[n];
203 return this.editors.date;
204 }else if(typeof val == 'number'){
205 return this.editors.number;
206 }else if(typeof val == 'boolean'){
207 return this.editors['boolean'];
209 return this.editors.string;
214 destroy : function(){
215 Ext.grid.PropertyColumnModel.superclass.destroy.call(this);
216 for(var ed in this.editors){
217 Ext.destroy(this.editors[ed]);
223 * @class Ext.grid.PropertyGrid
224 * @extends Ext.grid.EditorGridPanel
225 * A specialized grid implementation intended to mimic the traditional property grid as typically seen in
226 * development IDEs. Each row in the grid represents a property of some object, and the data is stored
227 * as a set of name/value pairs in {@link Ext.grid.PropertyRecord}s. Example usage:
229 var grid = new Ext.grid.PropertyGrid({
230 title: 'Properties Grid',
235 "(name)": "My Object",
236 "Created": new Date(Date.parse('10/15/2006')),
239 "Description": "A test object"
244 * @param {Object} config The grid config object
246 Ext.grid.PropertyGrid = Ext.extend(Ext.grid.EditorGridPanel, {
248 * @cfg {Object} propertyNames An object containing property name/display name pairs.
249 * If specified, the display name will be shown in the name column instead of the property name.
252 * @cfg {Object} source A data object to use as the data source of the grid (see {@link #setSource} for details).
255 * @cfg {Object} customEditors An object containing name/value pairs of custom editor type definitions that allow
256 * the grid to support additional types of editable fields. By default, the grid supports strongly-typed editing
257 * of strings, dates, numbers and booleans using built-in form editors, but any custom type can be supported and
258 * associated with a custom input control by specifying a custom editor. The name of the editor
259 * type should correspond with the name of the property that will use the editor. Example usage:
261 var grid = new Ext.grid.PropertyGrid({
264 'Start Time': new Ext.grid.GridEditor(new Ext.form.TimeField({selectOnFocus:true}))
267 'Start Time': '10:00 AM'
273 // private config overrides
274 enableColumnMove:false,
276 trackMouseOver: false,
278 enableHdMenu : false,
284 initComponent : function(){
285 this.customEditors = this.customEditors || {};
286 this.lastEditRow = null;
287 var store = new Ext.grid.PropertyStore(this);
288 this.propStore = store;
289 var cm = new Ext.grid.PropertyColumnModel(this, store);
290 store.store.sort('name', 'ASC');
293 * @event beforepropertychange
294 * Fires before a property value changes. Handlers can return false to cancel the property change
295 * (this will internally call {@link Ext.data.Record#reject} on the property's record).
296 * @param {Object} source The source data object for the grid (corresponds to the same object passed in
297 * as the {@link #source} config property).
298 * @param {String} recordId The record's id in the data store
299 * @param {Mixed} value The current edited property value
300 * @param {Mixed} oldValue The original property value prior to editing
302 'beforepropertychange',
304 * @event propertychange
305 * Fires after a property value has changed.
306 * @param {Object} source The source data object for the grid (corresponds to the same object passed in
307 * as the {@link #source} config property).
308 * @param {String} recordId The record's id in the data store
309 * @param {Mixed} value The current edited property value
310 * @param {Mixed} oldValue The original property value prior to editing
315 this.ds = store.store;
316 Ext.grid.PropertyGrid.superclass.initComponent.call(this);
318 this.mon(this.selModel, 'beforecellselect', function(sm, rowIndex, colIndex){
320 this.startEditing.defer(200, this, [rowIndex, 1]);
327 onRender : function(){
328 Ext.grid.PropertyGrid.superclass.onRender.apply(this, arguments);
330 this.getGridEl().addClass('x-props-grid');
334 afterRender: function(){
335 Ext.grid.PropertyGrid.superclass.afterRender.apply(this, arguments);
337 this.setSource(this.source);
342 * Sets the source data object containing the property data. The data object can contain one or more name/value
343 * pairs representing all of the properties of an object to display in the grid, and this data will automatically
344 * be loaded into the grid's {@link #store}. The values should be supplied in the proper data type if needed,
345 * otherwise string type will be assumed. If the grid already contains data, this method will replace any
346 * existing data. See also the {@link #source} config value. Example usage:
349 "(name)": "My Object",
350 "Created": new Date(Date.parse('10/15/2006')), // date type
351 "Available": false, // boolean type
352 "Version": .01, // decimal type
353 "Description": "A test object"
356 * @param {Object} source The data object
358 setSource : function(source){
359 this.propStore.setSource(source);
363 * Gets the source data object containing the property data. See {@link #setSource} for details regarding the
364 * format of the data object.
365 * @return {Object} The data object
367 getSource : function(){
368 return this.propStore.getSource();
388 Ext.reg("propertygrid", Ext.grid.PropertyGrid);