<html>
|
<head>
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<title>The source code</title>
|
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
|
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>
|
</head>
|
<body onload="prettyPrint();">
|
<pre class="prettyprint lang-js"><div id="cls-Ext.data.Field"></div>/**
|
* @class Ext.data.Field
|
* <p>This class encapsulates the field definition information specified in the field definition objects
|
* passed to {@link Ext.data.Record#create}.</p>
|
* <p>Developers do not need to instantiate this class. Instances are created by {@link Ext.data.Record.create}
|
* and cached in the {@link Ext.data.Record#fields fields} property of the created Record constructor's <b>prototype.</b></p>
|
*/
|
Ext.data.Field = function(config){
|
if(typeof config == "string"){
|
config = {name: config};
|
}
|
Ext.apply(this, config);
|
|
if(!this.type){
|
this.type = "auto";
|
}
|
|
var st = Ext.data.SortTypes;
|
// named sortTypes are supported, here we look them up
|
if(typeof this.sortType == "string"){
|
this.sortType = st[this.sortType];
|
}
|
|
// set default sortType for strings and dates
|
if(!this.sortType){
|
switch(this.type){
|
case "string":
|
this.sortType = st.asUCString;
|
break;
|
case "date":
|
this.sortType = st.asDate;
|
break;
|
default:
|
this.sortType = st.none;
|
}
|
}
|
|
// define once
|
var stripRe = /[\$,%]/g;
|
|
// prebuilt conversion function for this field, instead of
|
// switching every time we're reading a value
|
if(!this.convert){
|
var cv, dateFormat = this.dateFormat;
|
switch(this.type){
|
case "":
|
case "auto":
|
case undefined:
|
cv = function(v){ return v; };
|
break;
|
case "string":
|
cv = function(v){ return (v === undefined || v === null) ? '' : String(v); };
|
break;
|
case "int":
|
cv = function(v){
|
return v !== undefined && v !== null && v !== '' ?
|
parseInt(String(v).replace(stripRe, ""), 10) : '';
|
};
|
break;
|
case "float":
|
cv = function(v){
|
return v !== undefined && v !== null && v !== '' ?
|
parseFloat(String(v).replace(stripRe, ""), 10) : '';
|
};
|
break;
|
case "bool":
|
cv = function(v){ return v === true || v === "true" || v == 1; };
|
break;
|
case "date":
|
cv = function(v){
|
if(!v){
|
return '';
|
}
|
if(Ext.isDate(v)){
|
return v;
|
}
|
if(dateFormat){
|
if(dateFormat == "timestamp"){
|
return new Date(v*1000);
|
}
|
if(dateFormat == "time"){
|
return new Date(parseInt(v, 10));
|
}
|
return Date.parseDate(v, dateFormat);
|
}
|
var parsed = Date.parse(v);
|
return parsed ? new Date(parsed) : null;
|
};
|
break;
|
default:
|
cv = function(v){ return v; };
|
break;
|
|
}
|
this.convert = cv;
|
}
|
};
|
|
Ext.data.Field.prototype = {
|
<div id="cfg-Ext.data.Field-name"></div>/**
|
* @cfg {String} name
|
* The name by which the field is referenced within the Record. This is referenced by, for example,
|
* the <tt>dataIndex</tt> property in column definition objects passed to {@link Ext.grid.ColumnModel}.
|
* <p>Note: In the simplest case, if no properties other than <tt>name</tt> are required, a field
|
* definition may consist of just a String for the field name.</p>
|
*/
|
<div id="cfg-Ext.data.Field-type"></div>/**
|
* @cfg {String} type
|
* (Optional) The data type for conversion to displayable value if <tt>{@link Ext.data.Field#convert convert}</tt>
|
* has not been specified. Possible values are
|
* <div class="mdetail-params"><ul>
|
* <li>auto (Default, implies no conversion)</li>
|
* <li>string</li>
|
* <li>int</li>
|
* <li>float</li>
|
* <li>boolean</li>
|
* <li>date</li></ul></div>
|
*/
|
<div id="cfg-Ext.data.Field-convert"></div>/**
|
* @cfg {Function} convert
|
* (Optional) A function which converts the value provided by the Reader into an object that will be stored
|
* in the Record. It is passed the following parameters:<div class="mdetail-params"><ul>
|
* <li><b>v</b> : Mixed<div class="sub-desc">The data value as read by the Reader, if undefined will use
|
* the configured <tt>{@link Ext.data.Field#defaultValue defaultValue}</tt>.</div></li>
|
* <li><b>rec</b> : Mixed<div class="sub-desc">The data object containing the row as read by the Reader.
|
* Depending on the Reader type, this could be an Array ({@link Ext.data.ArrayReader ArrayReader}), an object
|
* ({@link Ext.data.JsonReader JsonReader}), or an XML element ({@link Ext.data.XMLReader XMLReader}).</div></li>
|
* </ul></div>
|
* <pre><code>
|
// example of convert function
|
function fullName(v, record){
|
return record.name.last + ', ' + record.name.first;
|
}
|
|
function location(v, record){
|
return !record.city ? '' : (record.city + ', ' + record.state);
|
}
|
|
var Dude = Ext.data.Record.create([
|
{name: 'fullname', convert: fullName},
|
{name: 'firstname', mapping: 'name.first'},
|
{name: 'lastname', mapping: 'name.last'},
|
{name: 'city', defaultValue: 'homeless'},
|
'state',
|
{name: 'location', convert: location}
|
]);
|
|
// create the data store
|
var store = new Ext.data.Store({
|
reader: new Ext.data.JsonReader(
|
{
|
idProperty: 'key',
|
root: 'daRoot',
|
totalProperty: 'total'
|
},
|
Dude // recordType
|
)
|
});
|
|
var myData = [
|
{ key: 1,
|
name: { first: 'Fat', last: 'Albert' }
|
// notice no city, state provided in data object
|
},
|
{ key: 2,
|
name: { first: 'Barney', last: 'Rubble' },
|
city: 'Bedrock', state: 'Stoneridge'
|
},
|
{ key: 3,
|
name: { first: 'Cliff', last: 'Claven' },
|
city: 'Boston', state: 'MA'
|
}
|
];
|
* </code></pre>
|
*/
|
<div id="cfg-Ext.data.Field-dateFormat"></div>/**
|
* @cfg {String} dateFormat
|
* (Optional) A format string for the {@link Date#parseDate Date.parseDate} function, or "timestamp" if the
|
* value provided by the Reader is a UNIX timestamp, or "time" if the value provided by the Reader is a
|
* javascript millisecond timestamp.
|
*/
|
dateFormat: null,
|
<div id="cfg-Ext.data.Field-defaultValue"></div>/**
|
* @cfg {Mixed} defaultValue
|
* (Optional) The default value used <b>when a Record is being created by a {@link Ext.data.Reader Reader}</b>
|
* when the item referenced by the <tt>{@link Ext.data.Field#mapping mapping}</tt> does not exist in the data
|
* object (i.e. undefined). (defaults to "")
|
*/
|
defaultValue: "",
|
<div id="cfg-Ext.data.Field-mapping"></div>/**
|
* @cfg {String/Number} mapping
|
* <p>(Optional) A path expression for use by the {@link Ext.data.DataReader} implementation
|
* that is creating the {@link Ext.data.Record Record} to extract the Field value from the data object.
|
* If the path expression is the same as the field name, the mapping may be omitted.</p>
|
* <p>The form of the mapping expression depends on the Reader being used.</p>
|
* <div class="mdetail-params"><ul>
|
* <li>{@link Ext.data.JsonReader}<div class="sub-desc">The mapping is a string containing the javascript
|
* 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>
|
* <li>{@link Ext.data.XmlReader}<div class="sub-desc">The mapping is an {@link Ext.DomQuery} path to the data
|
* item relative to the DOM element that represents the {@link Ext.data.XmlReader#record record}. Defaults to the field name.</div></li>
|
* <li>{@link Ext.data.ArrayReader}<div class="sub-desc">The mapping is a number indicating the Array index
|
* of the field's value. Defaults to the field specification's Array position.</div></li>
|
* </ul></div>
|
* <p>If a more complex value extraction strategy is required, then configure the Field with a {@link #convert}
|
* function. This is passed the whole row object, and may interrogate it in whatever way is necessary in order to
|
* return the desired data.</p>
|
*/
|
mapping: null,
|
<div id="cfg-Ext.data.Field-sortType"></div>/**
|
* @cfg {Function} sortType
|
* (Optional) A function which converts a Field's value to a comparable value in order to ensure
|
* correct sort ordering. Predefined functions are provided in {@link Ext.data.SortTypes}. A custom
|
* sort example:<pre><code>
|
// current sort after sort we want
|
// +-+------+ +-+------+
|
// |1|First | |1|First |
|
// |2|Last | |3|Second|
|
// |3|Second| |2|Last |
|
// +-+------+ +-+------+
|
|
sortType: function(value) {
|
switch (value.toLowerCase()) // native toLowerCase():
|
{
|
case 'first': return 1;
|
case 'second': return 2;
|
default: return 3;
|
}
|
}
|
* </code></pre>
|
*/
|
sortType : null,
|
<div id="cfg-Ext.data.Field-sortDir"></div>/**
|
* @cfg {String} sortDir
|
* (Optional) Initial direction to sort (<tt>"ASC"</tt> or <tt>"DESC"</tt>). Defaults to
|
* <tt>"ASC"</tt>.
|
*/
|
sortDir : "ASC",
|
<div id="cfg-Ext.data.Field-allowBlank"></div>/**
|
* @cfg {Boolean} allowBlank
|
* (Optional) Used for validating a {@link Ext.data.Record record}, defaults to <tt>true</tt>.
|
* An empty value here will cause {@link Ext.data.Record}.{@link Ext.data.Record#isValid isValid}
|
* to evaluate to <tt>false</tt>.
|
*/
|
allowBlank : true
|
};</pre>
|
</body>
|
</html>
|
