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

中间件编程

开发平台:

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.data.Field
  9.  * <p>This class encapsulates the field definition information specified in the field definition objects
  10.  * passed to {@link Ext.data.Record#create}.</p>
  11.  * <p>Developers do not need to instantiate this class. Instances are created by {@link Ext.data.Record.create}
  12.  * and cached in the {@link Ext.data.Record#fields fields} property of the created Record constructor's <b>prototype.</b></p>
  13.  */
  14. Ext.data.Field = function(config){
  15.     if(typeof config == "string"){
  16.         config = {name: config};
  17.     }
  18.     Ext.apply(this, config);
  19.     if(!this.type){
  20.         this.type = "auto";
  21.     }
  22.     var st = Ext.data.SortTypes;
  23.     // named sortTypes are supported, here we look them up
  24.     if(typeof this.sortType == "string"){
  25.         this.sortType = st[this.sortType];
  26.     }
  27.     // set default sortType for strings and dates
  28.     if(!this.sortType){
  29.         switch(this.type){
  30.             case "string":
  31.                 this.sortType = st.asUCString;
  32.                 break;
  33.             case "date":
  34.                 this.sortType = st.asDate;
  35.                 break;
  36.             default:
  37.                 this.sortType = st.none;
  38.         }
  39.     }
  40.     // define once
  41.     var stripRe = /[$,%]/g;
  42.     // prebuilt conversion function for this field, instead of
  43.     // switching every time we're reading a value
  44.     if(!this.convert){
  45.         var cv, dateFormat = this.dateFormat;
  46.         switch(this.type){
  47.             case "":
  48.             case "auto":
  49.             case undefined:
  50.                 cv = function(v){ return v; };
  51.                 break;
  52.             case "string":
  53.                 cv = function(v){ return (v === undefined || v === null) ? '' : String(v); };
  54.                 break;
  55.             case "int":
  56.                 cv = function(v){
  57.                     return v !== undefined && v !== null && v !== '' ?
  58.                            parseInt(String(v).replace(stripRe, ""), 10) : '';
  59.                     };
  60.                 break;
  61.             case "float":
  62.                 cv = function(v){
  63.                     return v !== undefined && v !== null && v !== '' ?
  64.                            parseFloat(String(v).replace(stripRe, ""), 10) : '';
  65.                     };
  66.                 break;
  67.             case "bool":
  68.             case "boolean":
  69.                 cv = function(v){ return v === true || v === "true" || v == 1; };
  70.                 break;
  71.             case "date":
  72.                 cv = function(v){
  73.                     if(!v){
  74.                         return '';
  75.                     }
  76.                     if(Ext.isDate(v)){
  77.                         return v;
  78.                     }
  79.                     if(dateFormat){
  80.                         if(dateFormat == "timestamp"){
  81.                             return new Date(v*1000);
  82.                         }
  83.                         if(dateFormat == "time"){
  84.                             return new Date(parseInt(v, 10));
  85.                         }
  86.                         return Date.parseDate(v, dateFormat);
  87.                     }
  88.                     var parsed = Date.parse(v);
  89.                     return parsed ? new Date(parsed) : null;
  90.                 };
  91.              break;
  92.         }
  93.         this.convert = cv;
  94.     }
  95. };
  96. Ext.data.Field.prototype = {
  97.     /**
  98.      * @cfg {String} name
  99.      * The name by which the field is referenced within the Record. This is referenced by, for example,
  100.      * the <tt>dataIndex</tt> property in column definition objects passed to {@link Ext.grid.ColumnModel}.
  101.      * <p>Note: In the simplest case, if no properties other than <tt>name</tt> are required, a field
  102.      * definition may consist of just a String for the field name.</p>
  103.      */
  104.     /**
  105.      * @cfg {String} type
  106.      * (Optional) The data type for conversion to displayable value if <tt>{@link Ext.data.Field#convert convert}</tt>
  107.      * has not been specified. Possible values are
  108.      * <div class="mdetail-params"><ul>
  109.      * <li>auto (Default, implies no conversion)</li>
  110.      * <li>string</li>
  111.      * <li>int</li>
  112.      * <li>float</li>
  113.      * <li>boolean</li>
  114.      * <li>date</li></ul></div>
  115.      */
  116.     /**
  117.      * @cfg {Function} convert
  118.      * (Optional) A function which converts the value provided by the Reader into an object that will be stored
  119.      * in the Record. It is passed the following parameters:<div class="mdetail-params"><ul>
  120.      * <li><b>v</b> : Mixed<div class="sub-desc">The data value as read by the Reader, if undefined will use
  121.      * the configured <tt>{@link Ext.data.Field#defaultValue defaultValue}</tt>.</div></li>
  122.      * <li><b>rec</b> : Mixed<div class="sub-desc">The data object containing the row as read by the Reader.
  123.      * Depending on the Reader type, this could be an Array ({@link Ext.data.ArrayReader ArrayReader}), an object
  124.      *  ({@link Ext.data.JsonReader JsonReader}), or an XML element ({@link Ext.data.XMLReader XMLReader}).</div></li>
  125.      * </ul></div>
  126.      * <pre><code>
  127. // example of convert function
  128. function fullName(v, record){
  129.     return record.name.last + ', ' + record.name.first;
  130. }
  131. function location(v, record){
  132.     return !record.city ? '' : (record.city + ', ' + record.state);
  133. }
  134. var Dude = Ext.data.Record.create([
  135.     {name: 'fullname',  convert: fullName},
  136.     {name: 'firstname', mapping: 'name.first'},
  137.     {name: 'lastname',  mapping: 'name.last'},
  138.     {name: 'city', defaultValue: 'homeless'},
  139.     'state',
  140.     {name: 'location',  convert: location}
  141. ]);
  142. // create the data store
  143. var store = new Ext.data.Store({
  144.     reader: new Ext.data.JsonReader(
  145.         {
  146.             idProperty: 'key',
  147.             root: 'daRoot',  
  148.             totalProperty: 'total'
  149.         },
  150.         Dude  // recordType
  151.     )
  152. });
  153. var myData = [
  154.     { key: 1,
  155.       name: { first: 'Fat',    last:  'Albert' }
  156.       // notice no city, state provided in data object
  157.     },
  158.     { key: 2,
  159.       name: { first: 'Barney', last:  'Rubble' },
  160.       city: 'Bedrock', state: 'Stoneridge'
  161.     },
  162.     { key: 3,
  163.       name: { first: 'Cliff',  last:  'Claven' },
  164.       city: 'Boston',  state: 'MA'
  165.     }
  166. ];
  167.      * </code></pre>
  168.      */
  169.     /**
  170.      * @cfg {String} dateFormat
  171.      * (Optional) A format string for the {@link Date#parseDate Date.parseDate} function, or "timestamp" if the
  172.      * value provided by the Reader is a UNIX timestamp, or "time" if the value provided by the Reader is a
  173.      * javascript millisecond timestamp.
  174.      */
  175.     dateFormat: null,
  176.     /**
  177.      * @cfg {Mixed} defaultValue
  178.      * (Optional) The default value used <b>when a Record is being created by a {@link Ext.data.Reader Reader}</b>
  179.      * when the item referenced by the <tt>{@link Ext.data.Field#mapping mapping}</tt> does not exist in the data
  180.      * object (i.e. undefined). (defaults to "")
  181.      */
  182.     defaultValue: "",
  183.     /**
  184.      * @cfg {String/Number} mapping
  185.      * <p>(Optional) A path expression for use by the {@link Ext.data.DataReader} implementation
  186.      * that is creating the {@link Ext.data.Record Record} to extract the Field value from the data object.
  187.      * If the path expression is the same as the field name, the mapping may be omitted.</p>
  188.      * <p>The form of the mapping expression depends on the Reader being used.</p>
  189.      * <div class="mdetail-params"><ul>
  190.      * <li>{@link Ext.data.JsonReader}<div class="sub-desc">The mapping is a string containing the javascript
  191.      * expression to reference the data from an element of the data item's {@link Ext.data.JsonReader#root root} Array. Defaults to the field name.</div></li>
  192.      * <li>{@link Ext.data.XmlReader}<div class="sub-desc">The mapping is an {@link Ext.DomQuery} path to the data
  193.      * item relative to the DOM element that represents the {@link Ext.data.XmlReader#record record}. Defaults to the field name.</div></li>
  194.      * <li>{@link Ext.data.ArrayReader}<div class="sub-desc">The mapping is a number indicating the Array index
  195.      * of the field's value. Defaults to the field specification's Array position.</div></li>
  196.      * </ul></div>
  197.      * <p>If a more complex value extraction strategy is required, then configure the Field with a {@link #convert}
  198.      * function. This is passed the whole row object, and may interrogate it in whatever way is necessary in order to
  199.      * return the desired data.</p>
  200.      */
  201.     mapping: null,
  202.     /**
  203.      * @cfg {Function} sortType
  204.      * (Optional) A function which converts a Field's value to a comparable value in order to ensure
  205.      * correct sort ordering. Predefined functions are provided in {@link Ext.data.SortTypes}. A custom
  206.      * sort example:<pre><code>
  207. // current sort     after sort we want
  208. // +-+------+          +-+------+
  209. // |1|First |          |1|First |
  210. // |2|Last  |          |3|Second|
  211. // |3|Second|          |2|Last  |
  212. // +-+------+          +-+------+
  213. sortType: function(value) {
  214.    switch (value.toLowerCase()) // native toLowerCase():
  215.    {
  216.       case 'first': return 1;
  217.       case 'second': return 2;
  218.       default: return 3;
  219.    }
  220. }
  221.      * </code></pre>
  222.      */
  223.     sortType : null,
  224.     /**
  225.      * @cfg {String} sortDir
  226.      * (Optional) Initial direction to sort (<tt>"ASC"</tt> or  <tt>"DESC"</tt>).  Defaults to
  227.      * <tt>"ASC"</tt>.
  228.      */
  229.     sortDir : "ASC",
  230. /**
  231.  * @cfg {Boolean} allowBlank 
  232.  * (Optional) Used for validating a {@link Ext.data.Record record}, defaults to <tt>true</tt>.
  233.  * An empty value here will cause {@link Ext.data.Record}.{@link Ext.data.Record#isValid isValid}
  234.  * to evaluate to <tt>false</tt>.
  235.  */
  236. allowBlank : true
  237. };