src/data/DataField.js

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