X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/output/Ext.data.Field.html

diff --git a/docs/output/Ext.data.Field.html b/docs/output/Ext.data.Field.html
deleted file mode 100644
index 314f4936..00000000
--- a/docs/output/Ext.data.Field.html
+++ /dev/null
@@ -1,113 +0,0 @@
-<div xmlns:ext="http://www.extjs.com" class="body-wrap"><h1>Class <a href="source/DataField.html#cls-Ext.data.Field">Ext.data.Field</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">DataField.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/DataField.html#cls-Ext.data.Field">Field</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description"><p>This class encapsulates the field definition information specified in the field definition objects
-passed to <a href="output/Ext.data.Record.html#Ext.data.Record-create" ext:member="create" ext:cls="Ext.data.Record">Ext.data.Record.create</a>.</p>
-<p>Developers do not need to instantiate this class. Instances are created by <a href="output/Ext.data.Record.create.html" ext:cls="Ext.data.Record.create">Ext.data.Record.create</a>
-and cached in the <a href="output/Ext.data.Record.html#Ext.data.Record-fields" ext:member="fields" ext:cls="Ext.data.Record">fields</a> property of the created Record constructor's <b>prototype.</b></p></div><div class="hr"></div><a id="Ext.data.Field-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Field-allowBlank"></a><b><a href="source/DataField.html#cfg-Ext.data.Field-allowBlank">allowBlank</a></b> : Boolean<div class="mdesc"><div class="short">Used for validating a record, defaults to true.
-An empty value here will cause Ext.data.Record.isValid
-to evaluate to...</div><div class="long">Used for validating a <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">record</a>, defaults to <tt>true</tt>.
-An empty value here will cause <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Ext.data.Record</a>.<a href="output/Ext.data.Record.html#Ext.data.Record-isValid" ext:member="isValid" ext:cls="Ext.data.Record">isValid</a>
-to evaluate to <tt>false</tt>.</div></div></td><td class="msource">Field</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Field-convert"></a><b><a href="source/DataField.html#cfg-Ext.data.Field-convert">convert</a></b> : Function<div class="mdesc"><div class="short">A function which converts the value provided by the Reader into an object that will be stored
-in the Record. It is pa...</div><div class="long">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><a href="output/Ext.data.Field.html#Ext.data.Field-defaultValue" ext:member="defaultValue" ext:cls="Ext.data.Field">defaultValue</a></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 (<a href="output/Ext.data.ArrayReader.html" ext:cls="Ext.data.ArrayReader">ArrayReader</a>), an object
-(<a href="output/Ext.data.JsonReader.html" ext:cls="Ext.data.JsonReader">JsonReader</a>), or an XML element (<a href="output/Ext.data.XMLReader.html" ext:cls="Ext.data.XMLReader">XMLReader</a>).</div></li>
-</ul></div>
-<pre><code><i>// example of convert <b>function</b></i>
-<b>function</b> fullName(v, record){
-    <b>return</b> record.name.last + <em>', '</em> + record.name.first;
-}
-
-<b>function</b> location(v, record){
-    <b>return</b> !record.city ? <em>''</em> : (record.city + <em>', '</em> + record.state);
-}
-
-<b>var</b> Dude = Ext.data.Record.create([
-    {name: <em>'fullname'</em>,  convert: fullName},
-    {name: <em>'firstname'</em>, mapping: <em>'name.first'</em>},
-    {name: <em>'lastname'</em>,  mapping: <em>'name.last'</em>},
-    {name: <em>'city'</em>, defaultValue: <em>'homeless'</em>},
-    <em>'state'</em>,
-    {name: <em>'location'</em>,  convert: location}
-]);
-
-<i>// create the data store</i>
-<b>var</b> store = <b>new</b> Ext.data.Store({
-    reader: <b>new</b> Ext.data.JsonReader(
-        {
-            idProperty: <em>'key'</em>,
-            root: <em>'daRoot'</em>,
-            totalProperty: <em>'total'</em>
-        },
-        Dude  <i>// recordType</i>
-    )
-});
-
-<b>var</b> myData = [
-    { key: 1,
-      name: { first: <em>'Fat'</em>,    last:  <em>'Albert'</em> }
-      <i>// notice no city, state provided <b>in</b> data object</i>
-    },
-    { key: 2,
-      name: { first: <em>'Barney'</em>, last:  <em>'Rubble'</em> },
-      city: <em>'Bedrock'</em>, state: <em>'Stoneridge'</em>
-    },
-    { key: 3,
-      name: { first: <em>'Cliff'</em>,  last:  <em>'Claven'</em> },
-      city: <em>'Boston'</em>,  state: <em>'MA'</em>
-    }
-];</code></pre></div></div></td><td class="msource">Field</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Field-dateFormat"></a><b><a href="source/DataField.html#cfg-Ext.data.Field-dateFormat">dateFormat</a></b> : String<div class="mdesc"><div class="short">A format string for the Date.parseDate function, or "timestamp" if the
-value provided by the Reader is a UNIX timesta...</div><div class="long">A format string for the <a href="output/Date.html#Date-parseDate" ext:member="parseDate" ext:cls="Date">Date.parseDate</a> 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.</div></div></td><td class="msource">Field</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Field-defaultValue"></a><b><a href="source/DataField.html#cfg-Ext.data.Field-defaultValue">defaultValue</a></b> : Mixed<div class="mdesc"><div class="short">The default value used when a Record is being created by a Reader
-when the item referenced by the mapping does not ex...</div><div class="long">The default value used <b>when a Record is being created by a <a href="output/Ext.data.Reader.html" ext:cls="Ext.data.Reader">Reader</a></b>
-when the item referenced by the <tt><a href="output/Ext.data.Field.html#Ext.data.Field-mapping" ext:member="mapping" ext:cls="Ext.data.Field">mapping</a></tt> does not exist in the data
-object (i.e. undefined). (defaults to "")</div></div></td><td class="msource">Field</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Field-mapping"></a><b><a href="source/DataField.html#cfg-Ext.data.Field-mapping">mapping</a></b> : String/Number<div class="mdesc"><div class="short">(Optional) A path expression for use by the Ext.data.DataReader implementation
-that is creating the Record to extract...</div><div class="long"><p>(Optional) A path expression for use by the <a href="output/Ext.data.DataReader.html" ext:cls="Ext.data.DataReader">Ext.data.DataReader</a> implementation
-that is creating the <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Record</a> 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><a href="output/Ext.data.JsonReader.html" ext:cls="Ext.data.JsonReader">Ext.data.JsonReader</a><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 <a href="output/Ext.data.JsonReader.html#Ext.data.JsonReader-root" ext:member="root" ext:cls="Ext.data.JsonReader">root</a> Array. Defaults to the field name.</div></li>
-<li><a href="output/Ext.data.XmlReader.html" ext:cls="Ext.data.XmlReader">Ext.data.XmlReader</a><div class="sub-desc">The mapping is an <a href="output/Ext.DomQuery.html" ext:cls="Ext.DomQuery">Ext.DomQuery</a> path to the data
-item relative to the DOM element that represents the <a href="output/Ext.data.XmlReader.html#Ext.data.XmlReader-record" ext:member="record" ext:cls="Ext.data.XmlReader">record</a>. Defaults to the field name.</div></li>
-<li><a href="output/Ext.data.ArrayReader.html" ext:cls="Ext.data.ArrayReader">Ext.data.ArrayReader</a><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 <a href="output/Ext.data.Field.html#Ext.data.Field-convert" ext:member="convert" ext:cls="Ext.data.Field">convert</a>
-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></div></div></td><td class="msource">Field</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Field-name"></a><b><a href="source/DataField.html#cfg-Ext.data.Field-name">name</a></b> : String<div class="mdesc"><div class="short">The name by which the field is referenced within the Record. This is referenced by, for example,
-the dataIndex proper...</div><div class="long">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 <a href="output/Ext.grid.ColumnModel.html" ext:cls="Ext.grid.ColumnModel">Ext.grid.ColumnModel</a>.
-<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></div></td><td class="msource">Field</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Field-sortDir"></a><b><a href="source/DataField.html#cfg-Ext.data.Field-sortDir">sortDir</a></b> : String<div class="mdesc">Initial direction to sort (<tt>"ASC"</tt> or  <tt>"DESC"</tt>).  Defaults to
-<tt>"ASC"</tt>.</div></td><td class="msource">Field</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Field-sortType"></a><b><a href="source/DataField.html#cfg-Ext.data.Field-sortType">sortType</a></b> : Function<div class="mdesc"><div class="short">A function which converts a Field's value to a comparable value in order to ensure
-correct sort ordering. Predefined ...</div><div class="long">A function which converts a Field's value to a comparable value in order to ensure
-correct sort ordering. Predefined functions are provided in <a href="output/Ext.data.SortTypes.html" ext:cls="Ext.data.SortTypes">Ext.data.SortTypes</a>. A custom
-sort example:<pre><code><i>// current sort     after sort we want</i>
-<i>// +-+------+          +-+------+</i>
-<i>// |1|First |          |1|First |</i>
-<i>// |2|Last  |          |3|Second|</i>
-<i>// |3|Second|          |2|Last  |</i>
-<i>// +-+------+          +-+------+</i>
-
-sortType: <b>function</b>(value) {
-   <b>switch</b> (value.toLowerCase()) <i>// native toLowerCase():</i>
-   {
-      <b>case</b> <em>'first'</em>: <b>return</b> 1;
-      <b>case</b> <em>'second'</em>: <b>return</b> 2;
-      <b>default</b>: <b>return</b> 3;
-   }
-}</code></pre></div></div></td><td class="msource">Field</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Field-type"></a><b><a href="source/DataField.html#cfg-Ext.data.Field-type">type</a></b> : String<div class="mdesc"><div class="short">The data type for conversion to displayable value if convert
-has not been specified. Possible values are
-&lt;div class="...</div><div class="long">The data type for conversion to displayable value if <tt><a href="output/Ext.data.Field.html#Ext.data.Field-convert" ext:member="convert" ext:cls="Ext.data.Field">convert</a></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></div></td><td class="msource">Field</td></tr></tbody></table><a id="Ext.data.Field-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.data.Field-methods"></a><h2>Public Methods</h2><div class="no-members">This class has no public methods.</div><a id="Ext.data.Field-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>
\ No newline at end of file

Package:	Ext.data
Defined In:	DataField.js
Class:	Field
Extends:	Object
Config Options		Defined By
	allowBlank : Boolean Used for validating a record, defaults to true. -An empty value here will cause Ext.data.Record.isValid -to evaluate to... Used for validating a record, defaults to `true`. -An empty value here will cause Ext.data.Record.isValid -to evaluate to `false`.	Field
	convert : Function A function which converts the value provided by the Reader into an object that will be stored -in the Record. It is pa... 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: - v : Mixed The data value as read by the Reader, if undefined will use -the configured `defaultValue`. - rec : Mixed The data object containing the row as read by the Reader. -Depending on the Reader type, this could be an Array (ArrayReader), an object -(JsonReader), or an XML element (XMLReader). - - // 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' - } -];	Field
	dateFormat : String A format string for the Date.parseDate function, or "timestamp" if the -value provided by the Reader is a UNIX timesta... A format string for the 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.	Field
	defaultValue : Mixed The default value used when a Record is being created by a Reader -when the item referenced by the mapping does not ex... The default value used when a Record is being created by a Reader -when the item referenced by the `mapping` does not exist in the data -object (i.e. undefined). (defaults to "")	Field
	mapping : String/Number (Optional) A path expression for use by the Ext.data.DataReader implementation -that is creating the Record to extract... (Optional) A path expression for use by the Ext.data.DataReader implementation -that is creating the 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. - The form of the mapping expression depends on the Reader being used. - - Ext.data.JsonReader The mapping is a string containing the javascript -expression to reference the data from an element of the data item's root Array. Defaults to the field name. - Ext.data.XmlReader The mapping is an Ext.DomQuery path to the data -item relative to the DOM element that represents the record. Defaults to the field name. - Ext.data.ArrayReader The mapping is a number indicating the Array index -of the field's value. Defaults to the field specification's Array position. - - If a more complex value extraction strategy is required, then configure the Field with a 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.	Field
	name : String The name by which the field is referenced within the Record. This is referenced by, for example, -the dataIndex proper... The name by which the field is referenced within the Record. This is referenced by, for example, -the `dataIndex` property in column definition objects passed to Ext.grid.ColumnModel. - Note: In the simplest case, if no properties other than `name` are required, a field -definition may consist of just a String for the field name.	Field
	sortDir : String Initial direction to sort (`"ASC"` or `"DESC"`). Defaults to -`"ASC"`.	Field
	sortType : Function A function which converts a Field's value to a comparable value in order to ensure -correct sort ordering. Predefined ... A function which converts a Field's value to a comparable value in order to ensure -correct sort ordering. Predefined functions are provided in Ext.data.SortTypes. A custom -sort example: `// 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; - } -}`	Field
	type : String The data type for conversion to displayable value if convert -has not been specified. Possible values are -<div class="... The data type for conversion to displayable value if `convert` -has not been specified. Possible values are - - auto (Default, implies no conversion) - string - int - float - boolean - date	Field