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

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