PropertyGrid.js
上传用户:shuoshiled
上传日期:2018-01-28
资源大小:10124k
文件大小:13k
源码类别:

中间件编程

开发平台:

JavaScript

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