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