docs/source/PropertyGrid.html

   1 <html>
   2 <head>
   3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   4   <title>The source code</title>
   5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   7 </head>
   8 <body  onload="prettyPrint();">
   9     <pre class="prettyprint lang-js">/*!
  10  * Ext JS Library 3.2.1
  11  * Copyright(c) 2006-2010 Ext JS, Inc.
  12  * licensing@extjs.com
  13  * http://www.extjs.com/license
  14  */
  15 <div id="cls-Ext.grid.PropertyRecord"></div>/**
  16  * @class Ext.grid.PropertyRecord
  17  * A specific {@link Ext.data.Record} type that represents a name/value pair and is made to work with the
  18  * {@link Ext.grid.PropertyGrid}.  Typically, PropertyRecords do not need to be created directly as they can be
  19  * created implicitly by simply using the appropriate data configs either via the {@link Ext.grid.PropertyGrid#source}
  20  * config property or by calling {@link Ext.grid.PropertyGrid#setSource}.  However, if the need arises, these records
  21  * can also be created explicitly as shwon below.  Example usage:
  22  * <pre><code>
  23 var rec = new Ext.grid.PropertyRecord({
  24     name: 'Birthday',
  25     value: new Date(Date.parse('05/26/1972'))
  26 });
  27 // Add record to an already populated grid
  28 grid.store.addSorted(rec);
  29 </code></pre>
  30  * @constructor
  31  * @param {Object} config A data object in the format: {name: [name], value: [value]}.  The specified value's type
  32  * will be read automatically by the grid to determine the type of editor to use when displaying it.
  33  */
  34 Ext.grid.PropertyRecord = Ext.data.Record.create([
  35     {name:'name',type:'string'}, 'value'
  36 ]);
  37
  38 <div id="cls-Ext.grid.PropertyStore"></div>/**
  39  * @class Ext.grid.PropertyStore
  40  * @extends Ext.util.Observable
  41  * A custom wrapper for the {@link Ext.grid.PropertyGrid}'s {@link Ext.data.Store}. This class handles the mapping
  42  * between the custom data source objects supported by the grid and the {@link Ext.grid.PropertyRecord} format
  43  * required for compatibility with the underlying store. Generally this class should not need to be used directly --
  44  * the grid's data should be accessed from the underlying store via the {@link #store} property.
  45  * @constructor
  46  * @param {Ext.grid.Grid} grid The grid this store will be bound to
  47  * @param {Object} source The source data config object
  48  */
  49 Ext.grid.PropertyStore = Ext.extend(Ext.util.Observable, {
  50
  51     constructor : function(grid, source){
  52         this.grid = grid;
  53         this.store = new Ext.data.Store({
  54             recordType : Ext.grid.PropertyRecord
  55         });
  56         this.store.on('update', this.onUpdate,  this);
  57         if(source){
  58             this.setSource(source);
  59         }
  60         Ext.grid.PropertyStore.superclass.constructor.call(this);
  61     },
  62
  63     // protected - should only be called by the grid.  Use grid.setSource instead.
  64     setSource : function(o){
  65         this.source = o;
  66         this.store.removeAll();
  67         var data = [];
  68         for(var k in o){
  69             if(this.isEditableValue(o[k])){
  70                 data.push(new Ext.grid.PropertyRecord({name: k, value: o[k]}, k));
  71             }
  72         }
  73         this.store.loadRecords({records: data}, {}, true);
  74     },
  75
  76     // private
  77     onUpdate : function(ds, record, type){
  78         if(type == Ext.data.Record.EDIT){
  79             var v = record.data.value;
  80             var oldValue = record.modified.value;
  81             if(this.grid.fireEvent('beforepropertychange', this.source, record.id, v, oldValue) !== false){
  82                 this.source[record.id] = v;
  83                 record.commit();
  84                 this.grid.fireEvent('propertychange', this.source, record.id, v, oldValue);
  85             }else{
  86                 record.reject();
  87             }
  88         }
  89     },
  90
  91     // private
  92     getProperty : function(row){
  93        return this.store.getAt(row);
  94     },
  95
  96     // private
  97     isEditableValue: function(val){
  98         return Ext.isPrimitive(val) || Ext.isDate(val);
  99     },
 100
 101     // private
 102     setValue : function(prop, value, create){
 103         var r = this.getRec(prop);
 104         if(r){
 105             r.set('value', value);
 106             this.source[prop] = value;
 107         }else if(create){
 108             // only create if specified.
 109             this.source[prop] = value;
 110             r = new Ext.grid.PropertyRecord({name: prop, value: value}, prop);
 111             this.store.add(r);
 112
 113         }
 114     },
 115
 116     // private
 117     remove : function(prop){
 118         var r = this.getRec(prop);
 119         if(r){
 120             this.store.remove(r);
 121             delete this.source[prop];
 122         }
 123     },
 124
 125     // private
 126     getRec : function(prop){
 127         return this.store.getById(prop);
 128     },
 129
 130     // protected - should only be called by the grid.  Use grid.getSource instead.
 131     getSource : function(){
 132         return this.source;
 133     }
 134 });
 135
 136 <div id="cls-Ext.grid.PropertyColumnModel"></div>/**
 137  * @class Ext.grid.PropertyColumnModel
 138  * @extends Ext.grid.ColumnModel
 139  * A custom column model for the {@link Ext.grid.PropertyGrid}.  Generally it should not need to be used directly.
 140  * @constructor
 141  * @param {Ext.grid.Grid} grid The grid this store will be bound to
 142  * @param {Object} source The source data config object
 143  */
 144 Ext.grid.PropertyColumnModel = Ext.extend(Ext.grid.ColumnModel, {
 145     // private - strings used for locale support
 146     nameText : 'Name',
 147     valueText : 'Value',
 148     dateFormat : 'm/j/Y',
 149     trueText: 'true',
 150     falseText: 'false',
 151
 152     constructor : function(grid, store){
 153         var g = Ext.grid,
 154                 f = Ext.form;
 155
 156             this.grid = grid;
 157             g.PropertyColumnModel.superclass.constructor.call(this, [
 158                 {header: this.nameText, width:50, sortable: true, dataIndex:'name', id: 'name', menuDisabled:true},
 159                 {header: this.valueText, width:50, resizable:false, dataIndex: 'value', id: 'value', menuDisabled:true}
 160             ]);
 161             this.store = store;
 162
 163             var bfield = new f.Field({
 164                 autoCreate: {tag: 'select', children: [
 165                     {tag: 'option', value: 'true', html: this.trueText},
 166                     {tag: 'option', value: 'false', html: this.falseText}
 167                 ]},
 168                 getValue : function(){
 169                     return this.el.dom.value == 'true';
 170                 }
 171             });
 172             this.editors = {
 173                 'date' : new g.GridEditor(new f.DateField({selectOnFocus:true})),
 174                 'string' : new g.GridEditor(new f.TextField({selectOnFocus:true})),
 175                 'number' : new g.GridEditor(new f.NumberField({selectOnFocus:true, style:'text-align:left;'})),
 176                 'boolean' : new g.GridEditor(bfield, {
 177                     autoSize: 'both'
 178                 })
 179             };
 180             this.renderCellDelegate = this.renderCell.createDelegate(this);
 181             this.renderPropDelegate = this.renderProp.createDelegate(this);
 182     },
 183
 184     // private
 185     renderDate : function(dateVal){
 186         return dateVal.dateFormat(this.dateFormat);
 187     },
 188
 189     // private
 190     renderBool : function(bVal){
 191         return this[bVal ? 'trueText' : 'falseText'];
 192     },
 193
 194     // private
 195     isCellEditable : function(colIndex, rowIndex){
 196         return colIndex == 1;
 197     },
 198
 199     // private
 200     getRenderer : function(col){
 201         return col == 1 ?
 202             this.renderCellDelegate : this.renderPropDelegate;
 203     },
 204
 205     // private
 206     renderProp : function(v){
 207         return this.getPropertyName(v);
 208     },
 209
 210     // private
 211     renderCell : function(val, meta, rec){
 212         var renderer = this.grid.customRenderers[rec.get('name')];
 213         if(renderer){
 214             return renderer.apply(this, arguments);
 215         }
 216         var rv = val;
 217         if(Ext.isDate(val)){
 218             rv = this.renderDate(val);
 219         }else if(typeof val == 'boolean'){
 220             rv = this.renderBool(val);
 221         }
 222         return Ext.util.Format.htmlEncode(rv);
 223     },
 224
 225     // private
 226     getPropertyName : function(name){
 227         var pn = this.grid.propertyNames;
 228         return pn && pn[name] ? pn[name] : name;
 229     },
 230
 231     // private
 232     getCellEditor : function(colIndex, rowIndex){
 233         var p = this.store.getProperty(rowIndex),
 234             n = p.data.name,
 235             val = p.data.value;
 236         if(this.grid.customEditors[n]){
 237             return this.grid.customEditors[n];
 238         }
 239         if(Ext.isDate(val)){
 240             return this.editors.date;
 241         }else if(typeof val == 'number'){
 242             return this.editors.number;
 243         }else if(typeof val == 'boolean'){
 244             return this.editors['boolean'];
 245         }else{
 246             return this.editors.string;
 247         }
 248     },
 249
 250     // inherit docs
 251     destroy : function(){
 252         Ext.grid.PropertyColumnModel.superclass.destroy.call(this);
 253         for(var ed in this.editors){
 254             Ext.destroy(this.editors[ed]);
 255         }
 256     }
 257 });
 258
 259 <div id="cls-Ext.grid.PropertyGrid"></div>/**
 260  * @class Ext.grid.PropertyGrid
 261  * @extends Ext.grid.EditorGridPanel
 262  * A specialized grid implementation intended to mimic the traditional property grid as typically seen in
 263  * development IDEs.  Each row in the grid represents a property of some object, and the data is stored
 264  * as a set of name/value pairs in {@link Ext.grid.PropertyRecord}s.  Example usage:
 265  * <pre><code>
 266 var grid = new Ext.grid.PropertyGrid({
 267     title: 'Properties Grid',
 268     autoHeight: true,
 269     width: 300,
 270     renderTo: 'grid-ct',
 271     source: {
 272         "(name)": "My Object",
 273         "Created": new Date(Date.parse('10/15/2006')),
 274         "Available": false,
 275         "Version": .01,
 276         "Description": "A test object"
 277     }
 278 });
 279 </code></pre>
 280  * @constructor
 281  * @param {Object} config The grid config object
 282  */
 283 Ext.grid.PropertyGrid = Ext.extend(Ext.grid.EditorGridPanel, {
 284     <div id="cfg-Ext.grid.PropertyGrid-propertyNames"></div>/**
 285     * @cfg {Object} propertyNames An object containing property name/display name pairs.
 286     * If specified, the display name will be shown in the name column instead of the property name.
 287     */
 288     <div id="cfg-Ext.grid.PropertyGrid-source"></div>/**
 289     * @cfg {Object} source A data object to use as the data source of the grid (see {@link #setSource} for details).
 290     */
 291     <div id="cfg-Ext.grid.PropertyGrid-customEditors"></div>/**
 292     * @cfg {Object} customEditors An object containing name/value pairs of custom editor type definitions that allow
 293     * the grid to support additional types of editable fields.  By default, the grid supports strongly-typed editing
 294     * of strings, dates, numbers and booleans using built-in form editors, but any custom type can be supported and
 295     * associated with a custom input control by specifying a custom editor.  The name of the editor
 296     * type should correspond with the name of the property that will use the editor.  Example usage:
 297     * <pre><code>
 298 var grid = new Ext.grid.PropertyGrid({
 299     ...
 300     customEditors: {
 301         'Start Time': new Ext.grid.GridEditor(new Ext.form.TimeField({selectOnFocus:true}))
 302     },
 303     source: {
 304         'Start Time': '10:00 AM'
 305     }
 306 });
 307 </code></pre>
 308     */
 309     <div id="cfg-Ext.grid.PropertyGrid-source"></div>/**
 310     * @cfg {Object} source A data object to use as the data source of the grid (see {@link #setSource} for details).
 311     */
 312     <div id="cfg-Ext.grid.PropertyGrid-customRenderers"></div>/**
 313     * @cfg {Object} customRenderers An object containing name/value pairs of custom renderer type definitions that allow
 314     * the grid to support custom rendering of fields.  By default, the grid supports strongly-typed rendering
 315     * of strings, dates, numbers and booleans using built-in form editors, but any custom type can be supported and
 316     * associated with the type of the value.  The name of the renderer type should correspond with the name of the property
 317     * that it will render.  Example usage:
 318     * <pre><code>
 319 var grid = new Ext.grid.PropertyGrid({
 320     ...
 321     customRenderers: {
 322         Available: function(v){
 323             if(v){
 324                 return '<span style="color: green;">Yes</span>';
 325             }else{
 326                 return '<span style="color: red;">No</span>';
 327             }
 328         }
 329     },
 330     source: {
 331         Available: true
 332     }
 333 });
 334 </code></pre>
 335     */
 336
 337     // private config overrides
 338     enableColumnMove:false,
 339     stripeRows:false,
 340     trackMouseOver: false,
 341     clicksToEdit:1,
 342     enableHdMenu : false,
 343     viewConfig : {
 344         forceFit:true
 345     },
 346
 347     // private
 348     initComponent : function(){
 349         this.customRenderers = this.customRenderers || {};
 350         this.customEditors = this.customEditors || {};
 351         this.lastEditRow = null;
 352         var store = new Ext.grid.PropertyStore(this);
 353         this.propStore = store;
 354         var cm = new Ext.grid.PropertyColumnModel(this, store);
 355         store.store.sort('name', 'ASC');
 356         this.addEvents(
 357             <div id="event-Ext.grid.PropertyGrid-beforepropertychange"></div>/**
 358              * @event beforepropertychange
 359              * Fires before a property value changes.  Handlers can return false to cancel the property change
 360              * (this will internally call {@link Ext.data.Record#reject} on the property's record).
 361              * @param {Object} source The source data object for the grid (corresponds to the same object passed in
 362              * as the {@link #source} config property).
 363              * @param {String} recordId The record's id in the data store
 364              * @param {Mixed} value The current edited property value
 365              * @param {Mixed} oldValue The original property value prior to editing
 366              */
 367             'beforepropertychange',
 368             <div id="event-Ext.grid.PropertyGrid-propertychange"></div>/**
 369              * @event propertychange
 370              * Fires after a property value has changed.
 371              * @param {Object} source The source data object for the grid (corresponds to the same object passed in
 372              * as the {@link #source} config property).
 373              * @param {String} recordId The record's id in the data store
 374              * @param {Mixed} value The current edited property value
 375              * @param {Mixed} oldValue The original property value prior to editing
 376              */
 377             'propertychange'
 378         );
 379         this.cm = cm;
 380         this.ds = store.store;
 381         Ext.grid.PropertyGrid.superclass.initComponent.call(this);
 382
 383                 this.mon(this.selModel, 'beforecellselect', function(sm, rowIndex, colIndex){
 384             if(colIndex === 0){
 385                 this.startEditing.defer(200, this, [rowIndex, 1]);
 386                 return false;
 387             }
 388         }, this);
 389     },
 390
 391     // private
 392     onRender : function(){
 393         Ext.grid.PropertyGrid.superclass.onRender.apply(this, arguments);
 394
 395         this.getGridEl().addClass('x-props-grid');
 396     },
 397
 398     // private
 399     afterRender: function(){
 400         Ext.grid.PropertyGrid.superclass.afterRender.apply(this, arguments);
 401         if(this.source){
 402             this.setSource(this.source);
 403         }
 404     },
 405
 406     <div id="method-Ext.grid.PropertyGrid-setSource"></div>/**
 407      * Sets the source data object containing the property data.  The data object can contain one or more name/value
 408      * pairs representing all of the properties of an object to display in the grid, and this data will automatically
 409      * be loaded into the grid's {@link #store}.  The values should be supplied in the proper data type if needed,
 410      * otherwise string type will be assumed.  If the grid already contains data, this method will replace any
 411      * existing data.  See also the {@link #source} config value.  Example usage:
 412      * <pre><code>
 413 grid.setSource({
 414     "(name)": "My Object",
 415     "Created": new Date(Date.parse('10/15/2006')),  // date type
 416     "Available": false,  // boolean type
 417     "Version": .01,      // decimal type
 418     "Description": "A test object"
 419 });
 420 </code></pre>
 421      * @param {Object} source The data object
 422      */
 423     setSource : function(source){
 424         this.propStore.setSource(source);
 425     },
 426
 427     <div id="method-Ext.grid.PropertyGrid-getSource"></div>/**
 428      * Gets the source data object containing the property data.  See {@link #setSource} for details regarding the
 429      * format of the data object.
 430      * @return {Object} The data object
 431      */
 432     getSource : function(){
 433         return this.propStore.getSource();
 434     },
 435
 436     <div id="method-Ext.grid.PropertyGrid-setProperty"></div>/**
 437      * Sets the value of a property.
 438      * @param {String} prop The name of the property to set
 439      * @param {Mixed} value The value to test
 440      * @param {Boolean} create (Optional) True to create the property if it doesn't already exist. Defaults to <tt>false</tt>.
 441      */
 442     setProperty : function(prop, value, create){
 443         this.propStore.setValue(prop, value, create);
 444     },
 445
 446     <div id="method-Ext.grid.PropertyGrid-removeProperty"></div>/**
 447      * Removes a property from the grid.
 448      * @param {String} prop The name of the property to remove
 449      */
 450     removeProperty : function(prop){
 451         this.propStore.remove(prop);
 452     }
 453
 454     <div id="cfg-Ext.grid.PropertyGrid-null"></div>/**
 455      * @cfg store
 456      * @hide
 457      */
 458     <div id="cfg-Ext.grid.PropertyGrid-null"></div>/**
 459      * @cfg colModel
 460      * @hide
 461      */
 462     <div id="cfg-Ext.grid.PropertyGrid-null"></div>/**
 463      * @cfg cm
 464      * @hide
 465      */
 466     <div id="cfg-Ext.grid.PropertyGrid-null"></div>/**
 467      * @cfg columns
 468      * @hide
 469      */
 470 });
 471 Ext.reg("propertygrid", Ext.grid.PropertyGrid);
 472 </pre>
 473 </body>
 474 </html>