docs/source/DataField.html

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