tvheadend/vendor/ext-3.4.1/docs/source/ArrayReader.html
Adam Sutton bafcfff42d webui: restructure webui/extjs source files
I want to keep the 3rd-party packages away from the main source
where possible.
2013-06-03 17:11:01 +01:00

116 lines
4.6 KiB
HTML

<!DOCTYPE html>
<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>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
<script type="text/javascript">
function highlight() {
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
}
</script>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Ext-data-ArrayReader-method-constructor'><span id='Ext-data-ArrayReader'>/**
</span></span> * @class Ext.data.ArrayReader
* @extends Ext.data.JsonReader
* &lt;p&gt;Data reader class to create an Array of {@link Ext.data.Record} objects from an Array.
* Each element of that Array represents a row of data fields. The
* fields are pulled into a Record object using as a subscript, the &lt;code&gt;mapping&lt;/code&gt; property
* of the field definition if it exists, or the field's ordinal position in the definition.&lt;/p&gt;
* &lt;p&gt;Example code:&lt;/p&gt;
* &lt;pre&gt;&lt;code&gt;
var Employee = Ext.data.Record.create([
{name: 'name', mapping: 1}, // &quot;mapping&quot; only needed if an &quot;id&quot; field is present which
{name: 'occupation', mapping: 2} // precludes using the ordinal position as the index.
]);
var myReader = new Ext.data.ArrayReader({
{@link #idIndex}: 0
}, Employee);
&lt;/code&gt;&lt;/pre&gt;
* &lt;p&gt;This would consume an Array like this:&lt;/p&gt;
* &lt;pre&gt;&lt;code&gt;
[ [1, 'Bill', 'Gardener'], [2, 'Ben', 'Horticulturalist'] ]
* &lt;/code&gt;&lt;/pre&gt;
* @constructor
* Create a new ArrayReader
* @param {Object} meta Metadata configuration options.
* @param {Array/Object} recordType
* &lt;p&gt;Either an Array of {@link Ext.data.Field Field} definition objects (which
* will be passed to {@link Ext.data.Record#create}, or a {@link Ext.data.Record Record}
* constructor created from {@link Ext.data.Record#create}.&lt;/p&gt;
*/
Ext.data.ArrayReader = Ext.extend(Ext.data.JsonReader, {
<span id='Ext-data-ArrayReader-cfg-successProperty'> /**
</span> * @cfg {String} successProperty
* @hide
*/
<span id='Ext-data-ArrayReader-cfg-id'> /**
</span> * @cfg {Number} id (optional) The subscript within row Array that provides an ID for the Record.
* Deprecated. Use {@link #idIndex} instead.
*/
<span id='Ext-data-ArrayReader-cfg-idIndex'> /**
</span> * @cfg {Number} idIndex (optional) The subscript within row Array that provides an ID for the Record.
*/
<span id='Ext-data-ArrayReader-method-readRecords'> /**
</span> * Create a data block containing Ext.data.Records from an Array.
* @param {Object} o An Array of row objects which represents the dataset.
* @return {Object} data A data block which is used by an Ext.data.Store object as
* a cache of Ext.data.Records.
*/
readRecords : function(o){
this.arrayData = o;
var s = this.meta,
sid = s ? Ext.num(s.idIndex, s.id) : null,
recordType = this.recordType,
fields = recordType.prototype.fields,
records = [],
success = true,
v;
var root = this.getRoot(o);
for(var i = 0, len = root.length; i &lt; len; i++) {
var n = root[i],
values = {},
id = ((sid || sid === 0) &amp;&amp; n[sid] !== undefined &amp;&amp; n[sid] !== &quot;&quot; ? n[sid] : null);
for(var j = 0, jlen = fields.length; j &lt; jlen; j++) {
var f = fields.items[j],
k = f.mapping !== undefined &amp;&amp; f.mapping !== null ? f.mapping : j;
v = n[k] !== undefined ? n[k] : f.defaultValue;
v = f.convert(v, n);
values[f.name] = v;
}
var record = new recordType(values, id);
record.json = n;
records[records.length] = record;
}
var totalRecords = records.length;
if(s.totalProperty) {
v = parseInt(this.getTotal(o), 10);
if(!isNaN(v)) {
totalRecords = v;
}
}
if(s.successProperty){
v = this.getSuccess(o);
if(v === false || v === 'false'){
success = false;
}
}
return {
success : success,
records : records,
totalRecords : totalRecords
};
}
});</pre>
</body>
</html>