pkgs/pkg-grid-property-debug.js

   1 /*!
   2  * Ext JS Library 3.1.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.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:
  14  * <pre><code>
  15 var rec = new Ext.grid.PropertyRecord({
  16     name: 'Birthday',
  17     value: new Date(Date.parse('05/26/1972'))
  18 });
  19 // Add record to an already populated grid
  20 grid.store.addSorted(rec);
  21 </code></pre>
  22  * @constructor
  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.
  25  */
  26 Ext.grid.PropertyRecord = Ext.data.Record.create([
  27     {name:'name',type:'string'}, 'value'
  28 ]);
  29
  30 /**
  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.
  37  * @constructor
  38  * @param {Ext.grid.Grid} grid The grid this store will be bound to
  39  * @param {Object} source The source data config object
  40  */
  41 Ext.grid.PropertyStore = Ext.extend(Ext.util.Observable, {
  42
  43     constructor : function(grid, source){
  44         this.grid = grid;
  45         this.store = new Ext.data.Store({
  46             recordType : Ext.grid.PropertyRecord
  47         });
  48         this.store.on('update', this.onUpdate,  this);
  49         if(source){
  50             this.setSource(source);
  51         }
  52         Ext.grid.PropertyStore.superclass.constructor.call(this);
  53     },
  54
  55     // protected - should only be called by the grid.  Use grid.setSource instead.
  56     setSource : function(o){
  57         this.source = o;
  58         this.store.removeAll();
  59         var data = [];
  60         for(var k in o){
  61             if(this.isEditableValue(o[k])){
  62                 data.push(new Ext.grid.PropertyRecord({name: k, value: o[k]}, k));
  63             }
  64         }
  65         this.store.loadRecords({records: data}, {}, true);
  66     },
  67
  68     // private
  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;
  75                 record.commit();
  76                 this.grid.fireEvent('propertychange', this.source, record.id, v, oldValue);
  77             }else{
  78                 record.reject();
  79             }
  80         }
  81     },
  82
  83     // private
  84     getProperty : function(row){
  85        return this.store.getAt(row);
  86     },
  87
  88     // private
  89     isEditableValue: function(val){
  90         return Ext.isPrimitive(val) || Ext.isDate(val);
  91     },
  92
  93     // private
  94     setValue : function(prop, value){
  95         this.source[prop] = value;
  96         this.store.getById(prop).set('value', value);
  97     },
  98
  99     // protected - should only be called by the grid.  Use grid.getSource instead.
 100     getSource : function(){
 101         return this.source;
 102     }
 103 });
 104
 105 /**
 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.
 109  * @constructor
 110  * @param {Ext.grid.Grid} grid The grid this store will be bound to
 111  * @param {Object} source The source data config object
 112  */
 113 Ext.grid.PropertyColumnModel = Ext.extend(Ext.grid.ColumnModel, {
 114     // private - strings used for locale support
 115     nameText : 'Name',
 116     valueText : 'Value',
 117     dateFormat : 'm/j/Y',
 118
 119     constructor : function(grid, store){
 120         var g = Ext.grid,
 121                 f = Ext.form;
 122
 123             this.grid = grid;
 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}
 127             ]);
 128             this.store = store;
 129
 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'}
 134                 ]},
 135                 getValue : function(){
 136                     return this.el.dom.value == 'true';
 137                 }
 138             });
 139             this.editors = {
 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, {
 144                     autoSize: 'both'
 145                 })
 146             };
 147             this.renderCellDelegate = this.renderCell.createDelegate(this);
 148             this.renderPropDelegate = this.renderProp.createDelegate(this);
 149     },
 150
 151     // private
 152     renderDate : function(dateVal){
 153         return dateVal.dateFormat(this.dateFormat);
 154     },
 155
 156     // private
 157     renderBool : function(bVal){
 158         return bVal ? 'true' : 'false';
 159     },
 160
 161     // private
 162     isCellEditable : function(colIndex, rowIndex){
 163         return colIndex == 1;
 164     },
 165
 166     // private
 167     getRenderer : function(col){
 168         return col == 1 ?
 169             this.renderCellDelegate : this.renderPropDelegate;
 170     },
 171
 172     // private
 173     renderProp : function(v){
 174         return this.getPropertyName(v);
 175     },
 176
 177     // private
 178     renderCell : function(val){
 179         var rv = val;
 180         if(Ext.isDate(val)){
 181             rv = this.renderDate(val);
 182         }else if(typeof val == 'boolean'){
 183             rv = this.renderBool(val);
 184         }
 185         return Ext.util.Format.htmlEncode(rv);
 186     },
 187
 188     // private
 189     getPropertyName : function(name){
 190         var pn = this.grid.propertyNames;
 191         return pn && pn[name] ? pn[name] : name;
 192     },
 193
 194     // private
 195     getCellEditor : function(colIndex, rowIndex){
 196         var p = this.store.getProperty(rowIndex),
 197             n = p.data.name,
 198             val = p.data.value;
 199         if(this.grid.customEditors[n]){
 200             return this.grid.customEditors[n];
 201         }
 202         if(Ext.isDate(val)){
 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'];
 208         }else{
 209             return this.editors.string;
 210         }
 211     },
 212
 213     // inherit docs
 214     destroy : function(){
 215         Ext.grid.PropertyColumnModel.superclass.destroy.call(this);
 216         for(var ed in this.editors){
 217             Ext.destroy(this.editors[ed]);
 218         }
 219     }
 220 });
 221
 222 /**
 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:
 228  * <pre><code>
 229 var grid = new Ext.grid.PropertyGrid({
 230     title: 'Properties Grid',
 231     autoHeight: true,
 232     width: 300,
 233     renderTo: 'grid-ct',
 234     source: {
 235         "(name)": "My Object",
 236         "Created": new Date(Date.parse('10/15/2006')),
 237         "Available": false,
 238         "Version": .01,
 239         "Description": "A test object"
 240     }
 241 });
 242 </code></pre>
 243  * @constructor
 244  * @param {Object} config The grid config object
 245  */
 246 Ext.grid.PropertyGrid = Ext.extend(Ext.grid.EditorGridPanel, {
 247     /**
 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.
 250     */
 251     /**
 252     * @cfg {Object} source A data object to use as the data source of the grid (see {@link #setSource} for details).
 253     */
 254     /**
 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:
 260     * <pre><code>
 261 var grid = new Ext.grid.PropertyGrid({
 262     ...
 263     customEditors: {
 264         'Start Time': new Ext.grid.GridEditor(new Ext.form.TimeField({selectOnFocus:true}))
 265     },
 266     source: {
 267         'Start Time': '10:00 AM'
 268     }
 269 });
 270 </code></pre>
 271     */
 272
 273     // private config overrides
 274     enableColumnMove:false,
 275     stripeRows:false,
 276     trackMouseOver: false,
 277     clicksToEdit:1,
 278     enableHdMenu : false,
 279     viewConfig : {
 280         forceFit:true
 281     },
 282
 283     // private
 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');
 291         this.addEvents(
 292             /**
 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
 301              */
 302             'beforepropertychange',
 303             /**
 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
 311              */
 312             'propertychange'
 313         );
 314         this.cm = cm;
 315         this.ds = store.store;
 316         Ext.grid.PropertyGrid.superclass.initComponent.call(this);
 317
 318                 this.mon(this.selModel, 'beforecellselect', function(sm, rowIndex, colIndex){
 319             if(colIndex === 0){
 320                 this.startEditing.defer(200, this, [rowIndex, 1]);
 321                 return false;
 322             }
 323         }, this);
 324     },
 325
 326     // private
 327     onRender : function(){
 328         Ext.grid.PropertyGrid.superclass.onRender.apply(this, arguments);
 329
 330         this.getGridEl().addClass('x-props-grid');
 331     },
 332
 333     // private
 334     afterRender: function(){
 335         Ext.grid.PropertyGrid.superclass.afterRender.apply(this, arguments);
 336         if(this.source){
 337             this.setSource(this.source);
 338         }
 339     },
 340
 341     /**
 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:
 347      * <pre><code>
 348 grid.setSource({
 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"
 354 });
 355 </code></pre>
 356      * @param {Object} source The data object
 357      */
 358     setSource : function(source){
 359         this.propStore.setSource(source);
 360     },
 361
 362     /**
 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
 366      */
 367     getSource : function(){
 368         return this.propStore.getSource();
 369     }
 370
 371     /**
 372      * @cfg store
 373      * @hide
 374      */
 375     /**
 376      * @cfg colModel
 377      * @hide
 378      */
 379     /**
 380      * @cfg cm
 381      * @hide
 382      */
 383     /**
 384      * @cfg columns
 385      * @hide
 386      */
 387 });
 388 Ext.reg("propertygrid", Ext.grid.PropertyGrid);