PropertyGrid.js
上传用户:dawnssy
上传日期:2022-08-06
资源大小:9345k
文件大小:13k
源码类别:

JavaScript

开发平台:

JavaScript

  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.  * @class Ext.grid.PropertyStore
  31.  * @extends Ext.util.Observable
  32.  * A custom wrapper for the {@link Ext.grid.PropertyGrid}'s {@link Ext.data.Store}. This class handles the mapping
  33.  * between the custom data source objects supported by the grid and the {@link Ext.grid.PropertyRecord} format
  34.  * required for compatibility with the underlying store. Generally this class should not need to be used directly --
  35.  * the grid's data should be accessed from the underlying store via the {@link #store} property.
  36.  * @constructor
  37.  * @param {Ext.grid.Grid} grid The grid this store will be bound to
  38.  * @param {Object} source The source data config object
  39.  */
  40. Ext.grid.PropertyStore = Ext.extend(Ext.util.Observable, {
  41.     
  42.     constructor : function(grid, source){
  43.         this.grid = grid;
  44.         this.store = new Ext.data.Store({
  45.             recordType : Ext.grid.PropertyRecord
  46.         });
  47.         this.store.on('update', this.onUpdate,  this);
  48.         if(source){
  49.             this.setSource(source);
  50.         }
  51.         Ext.grid.PropertyStore.superclass.constructor.call(this);    
  52.     },
  53.     
  54.     // protected - should only be called by the grid.  Use grid.setSource instead.
  55.     setSource : function(o){
  56.         this.source = o;
  57.         this.store.removeAll();
  58.         var data = [];
  59.         for(var k in o){
  60.             if(this.isEditableValue(o[k])){
  61.                 data.push(new Ext.grid.PropertyRecord({name: k, value: o[k]}, k));
  62.             }
  63.         }
  64.         this.store.loadRecords({records: data}, {}, true);
  65.     },
  66.     // private
  67.     onUpdate : function(ds, record, type){
  68.         if(type == Ext.data.Record.EDIT){
  69.             var v = record.data.value;
  70.             var oldValue = record.modified.value;
  71.             if(this.grid.fireEvent('beforepropertychange', this.source, record.id, v, oldValue) !== false){
  72.                 this.source[record.id] = v;
  73.                 record.commit();
  74.                 this.grid.fireEvent('propertychange', this.source, record.id, v, oldValue);
  75.             }else{
  76.                 record.reject();
  77.             }
  78.         }
  79.     },
  80.     // private
  81.     getProperty : function(row){
  82.        return this.store.getAt(row);
  83.     },
  84.     // private
  85.     isEditableValue: function(val){
  86.         return Ext.isPrimitive(val) || Ext.isDate(val);
  87.     },
  88.     // private
  89.     setValue : function(prop, value){
  90.         this.source[prop] = value;
  91.         this.store.getById(prop).set('value', value);
  92.     },
  93.     // protected - should only be called by the grid.  Use grid.getSource instead.
  94.     getSource : function(){
  95.         return this.source;
  96.     }
  97. });
  98. /**
  99.  * @class Ext.grid.PropertyColumnModel
  100.  * @extends Ext.grid.ColumnModel
  101.  * A custom column model for the {@link Ext.grid.PropertyGrid}.  Generally it should not need to be used directly.
  102.  * @constructor
  103.  * @param {Ext.grid.Grid} grid The grid this store will be bound to
  104.  * @param {Object} source The source data config object
  105.  */
  106. Ext.grid.PropertyColumnModel = Ext.extend(Ext.grid.ColumnModel, {
  107.     // private - strings used for locale support
  108.     nameText : 'Name',
  109.     valueText : 'Value',
  110.     dateFormat : 'm/j/Y',
  111.     
  112.     constructor : function(grid, store){
  113.         var g = Ext.grid,
  114.         f = Ext.form;
  115.         
  116.     this.grid = grid;
  117.     g.PropertyColumnModel.superclass.constructor.call(this, [
  118.         {header: this.nameText, width:50, sortable: true, dataIndex:'name', id: 'name', menuDisabled:true},
  119.         {header: this.valueText, width:50, resizable:false, dataIndex: 'value', id: 'value', menuDisabled:true}
  120.     ]);
  121.     this.store = store;
  122.     var bfield = new f.Field({
  123.         autoCreate: {tag: 'select', children: [
  124.             {tag: 'option', value: 'true', html: 'true'},
  125.             {tag: 'option', value: 'false', html: 'false'}
  126.         ]},
  127.         getValue : function(){
  128.             return this.el.dom.value == 'true';
  129.         }
  130.     });
  131.     this.editors = {
  132.         'date' : new g.GridEditor(new f.DateField({selectOnFocus:true})),
  133.         'string' : new g.GridEditor(new f.TextField({selectOnFocus:true})),
  134.         'number' : new g.GridEditor(new f.NumberField({selectOnFocus:true, style:'text-align:left;'})),
  135.         'boolean' : new g.GridEditor(bfield, {
  136.             autoSize: 'both'
  137.         })
  138.     };
  139.     this.renderCellDelegate = this.renderCell.createDelegate(this);
  140.     this.renderPropDelegate = this.renderProp.createDelegate(this);
  141.     },
  142.     // private
  143.     renderDate : function(dateVal){
  144.         return dateVal.dateFormat(this.dateFormat);
  145.     },
  146.     // private
  147.     renderBool : function(bVal){
  148.         return bVal ? 'true' : 'false';
  149.     },
  150.     // private
  151.     isCellEditable : function(colIndex, rowIndex){
  152.         return colIndex == 1;
  153.     },
  154.     // private
  155.     getRenderer : function(col){
  156.         return col == 1 ?
  157.             this.renderCellDelegate : this.renderPropDelegate;
  158.     },
  159.     // private
  160.     renderProp : function(v){
  161.         return this.getPropertyName(v);
  162.     },
  163.     // private
  164.     renderCell : function(val){
  165.         var rv = val;
  166.         if(Ext.isDate(val)){
  167.             rv = this.renderDate(val);
  168.         }else if(typeof val == 'boolean'){
  169.             rv = this.renderBool(val);
  170.         }
  171.         return Ext.util.Format.htmlEncode(rv);
  172.     },
  173.     // private
  174.     getPropertyName : function(name){
  175.         var pn = this.grid.propertyNames;
  176.         return pn && pn[name] ? pn[name] : name;
  177.     },
  178.     // private
  179.     getCellEditor : function(colIndex, rowIndex){
  180.         var p = this.store.getProperty(rowIndex),
  181.             n = p.data.name, 
  182.             val = p.data.value;
  183.         if(this.grid.customEditors[n]){
  184.             return this.grid.customEditors[n];
  185.         }
  186.         if(Ext.isDate(val)){
  187.             return this.editors.date;
  188.         }else if(typeof val == 'number'){
  189.             return this.editors.number;
  190.         }else if(typeof val == 'boolean'){
  191.             return this.editors['boolean'];
  192.         }else{
  193.             return this.editors.string;
  194.         }
  195.     },
  196.     // inherit docs
  197.     destroy : function(){
  198.         Ext.grid.PropertyColumnModel.superclass.destroy.call(this);
  199.         for(var ed in this.editors){
  200.             Ext.destroy(this.editors[ed]);
  201.         }
  202.     }
  203. });
  204. /**
  205.  * @class Ext.grid.PropertyGrid
  206.  * @extends Ext.grid.EditorGridPanel
  207.  * A specialized grid implementation intended to mimic the traditional property grid as typically seen in
  208.  * development IDEs.  Each row in the grid represents a property of some object, and the data is stored
  209.  * as a set of name/value pairs in {@link Ext.grid.PropertyRecord}s.  Example usage:
  210.  * <pre><code>
  211. var grid = new Ext.grid.PropertyGrid({
  212.     title: 'Properties Grid',
  213.     autoHeight: true,
  214.     width: 300,
  215.     renderTo: 'grid-ct',
  216.     source: {
  217.         "(name)": "My Object",
  218.         "Created": new Date(Date.parse('10/15/2006')),
  219.         "Available": false,
  220.         "Version": .01,
  221.         "Description": "A test object"
  222.     }
  223. });
  224. </code></pre>
  225.  * @constructor
  226.  * @param {Object} config The grid config object
  227.  */
  228. Ext.grid.PropertyGrid = Ext.extend(Ext.grid.EditorGridPanel, {
  229.     /**
  230.     * @cfg {Object} propertyNames An object containing property name/display name pairs.
  231.     * If specified, the display name will be shown in the name column instead of the property name.
  232.     */
  233.     /**
  234.     * @cfg {Object} source A data object to use as the data source of the grid (see {@link #setSource} for details).
  235.     */
  236.     /**
  237.     * @cfg {Object} customEditors An object containing name/value pairs of custom editor type definitions that allow
  238.     * the grid to support additional types of editable fields.  By default, the grid supports strongly-typed editing
  239.     * of strings, dates, numbers and booleans using built-in form editors, but any custom type can be supported and
  240.     * associated with a custom input control by specifying a custom editor.  The name of the editor
  241.     * type should correspond with the name of the property that will use the editor.  Example usage:
  242.     * <pre><code>
  243. var grid = new Ext.grid.PropertyGrid({
  244.     ...
  245.     customEditors: {
  246.         'Start Time': new Ext.grid.GridEditor(new Ext.form.TimeField({selectOnFocus:true}))
  247.     },
  248.     source: {
  249.         'Start Time': '10:00 AM'
  250.     }
  251. });
  252. </code></pre>
  253.     */
  254.     // private config overrides
  255.     enableColumnMove:false,
  256.     stripeRows:false,
  257.     trackMouseOver: false,
  258.     clicksToEdit:1,
  259.     enableHdMenu : false,
  260.     viewConfig : {
  261.         forceFit:true
  262.     },
  263.     // private
  264.     initComponent : function(){
  265.         this.customEditors = this.customEditors || {};
  266.         this.lastEditRow = null;
  267.         var store = new Ext.grid.PropertyStore(this);
  268.         this.propStore = store;
  269.         var cm = new Ext.grid.PropertyColumnModel(this, store);
  270.         store.store.sort('name', 'ASC');
  271.         this.addEvents(
  272.             /**
  273.              * @event beforepropertychange
  274.              * Fires before a property value changes.  Handlers can return false to cancel the property change
  275.              * (this will internally call {@link Ext.data.Record#reject} on the property's record).
  276.              * @param {Object} source The source data object for the grid (corresponds to the same object passed in
  277.              * as the {@link #source} config property).
  278.              * @param {String} recordId The record's id in the data store
  279.              * @param {Mixed} value The current edited property value
  280.              * @param {Mixed} oldValue The original property value prior to editing
  281.              */
  282.             'beforepropertychange',
  283.             /**
  284.              * @event propertychange
  285.              * Fires after a property value has changed.
  286.              * @param {Object} source The source data object for the grid (corresponds to the same object passed in
  287.              * as the {@link #source} config property).
  288.              * @param {String} recordId The record's id in the data store
  289.              * @param {Mixed} value The current edited property value
  290.              * @param {Mixed} oldValue The original property value prior to editing
  291.              */
  292.             'propertychange'
  293.         );
  294.         this.cm = cm;
  295.         this.ds = store.store;
  296.         Ext.grid.PropertyGrid.superclass.initComponent.call(this);
  297. this.mon(this.selModel, 'beforecellselect', function(sm, rowIndex, colIndex){
  298.             if(colIndex === 0){
  299.                 this.startEditing.defer(200, this, [rowIndex, 1]);
  300.                 return false;
  301.             }
  302.         }, this);
  303.     },
  304.     // private
  305.     onRender : function(){
  306.         Ext.grid.PropertyGrid.superclass.onRender.apply(this, arguments);
  307.         this.getGridEl().addClass('x-props-grid');
  308.     },
  309.     // private
  310.     afterRender: function(){
  311.         Ext.grid.PropertyGrid.superclass.afterRender.apply(this, arguments);
  312.         if(this.source){
  313.             this.setSource(this.source);
  314.         }
  315.     },
  316.     /**
  317.      * Sets the source data object containing the property data.  The data object can contain one or more name/value
  318.      * pairs representing all of the properties of an object to display in the grid, and this data will automatically
  319.      * be loaded into the grid's {@link #store}.  The values should be supplied in the proper data type if needed,
  320.      * otherwise string type will be assumed.  If the grid already contains data, this method will replace any
  321.      * existing data.  See also the {@link #source} config value.  Example usage:
  322.      * <pre><code>
  323. grid.setSource({
  324.     "(name)": "My Object",
  325.     "Created": new Date(Date.parse('10/15/2006')),  // date type
  326.     "Available": false,  // boolean type
  327.     "Version": .01,      // decimal type
  328.     "Description": "A test object"
  329. });
  330. </code></pre>
  331.      * @param {Object} source The data object
  332.      */
  333.     setSource : function(source){
  334.         this.propStore.setSource(source);
  335.     },
  336.     /**
  337.      * Gets the source data object containing the property data.  See {@link #setSource} for details regarding the
  338.      * format of the data object.
  339.      * @return {Object} The data object
  340.      */
  341.     getSource : function(){
  342.         return this.propStore.getSource();
  343.     }
  344.     /**
  345.      * @cfg store
  346.      * @hide
  347.      */
  348.     /**
  349.      * @cfg colModel
  350.      * @hide
  351.      */
  352.     /**
  353.      * @cfg cm
  354.      * @hide
  355.      */
  356.     /**
  357.      * @cfg columns
  358.      * @hide
  359.      */
  360. });
  361. Ext.reg("propertygrid", Ext.grid.PropertyGrid);