+++ /dev/null
- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.data.Record-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.data.Record-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.data.Record-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="bookmark" href="../docs/?class=Ext.data.Record"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <h1>Class Ext.data.Record</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"><a href="../src/Record.js" target="_blank">Record.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">Record</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
- </table>
- <div class="description">
- *
-<p>Instances of this class encapsulate both Record <em>definition</em> information, and Record
-<em>value</em> information for use in <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a> objects, or any code which needs
-to access Records cached in an <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a> object.</p>
-<p>Constructors for this class are generated by passing an Array of field definition objects to <a ext:cls="Ext.data.Record" ext:member="create" href="output/Ext.data.Record.html#create">create</a>.
-Instances are usually only created by <a ext:cls="Ext.data.Reader" href="output/Ext.data.Reader.html">Ext.data.Reader</a> implementations when processing unformatted data
-objects.</p>
-<p>Note that an instance of a Record class may only belong to one <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Store</a> at a time.
-In order to copy data from one Store to another, use the <a ext:cls="Ext.data.Record" ext:member="copy" href="output/Ext.data.Record.html#copy">copy</a> method to create an exact
-copy of the Record, and insert the new instance into the other Store.</p>
-<p>When serializing a Record for submission to the server, be aware that it contains many private
-properties, and also a reference to its owning Store which in turn holds references to its Records.
-This means that a Record may not be encoded using <a ext:cls="Ext.util.JSON.encode" href="output/Ext.util.JSON.encode.html">Ext.util.JSON.encode</a>. Instead, use the
-<a ext:cls="data" href="output/data.html">data</a> and <a ext:cls="id" href="output/id.html">id</a> properties.</p>
-Record objects generated by this constructor inherit all the methods of Ext.data.Record listed below. </div>
-
- <div class="hr"></div>
- <a id="Ext.data.Record-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-data"></a>\r
- <b>data</b> : Object <div class="mdesc">\r
- <div class="short">
-An object hash representing the data for this Record. Every field name in the Record definition
-is represented by a ...</div>\r
- <div class="long">\r
-
-An object hash representing the data for this Record. Every field name in the Record definition
-is represented by a property of that name in this object. Note that unless you specified a field
-with name "id" in the Record definition, this will <b>not</b> contain an <tt>id</tt> property. </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-dirty"></a>\r
- <b>dirty</b> : Boolean <div class="mdesc">\r
-
-Readonly flag - true if this Record has been modified. </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="property-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-fields"></a>\r
- <b>fields</b> : Ext.util.MixedCollection <div class="mdesc">\r
- <div class="short">This property is stored in the Record definition's prototype
-A MixedCollection containing the defined Fields for this...</div>\r
- <div class="long">\r
- <p><b>This property is stored in the Record definition's <u>prototype</u></b></p>
-A MixedCollection containing the defined <a ext:cls="Ext.data.Field" href="output/Ext.data.Field.html">Field</a>s for this Record. Read-only. </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-id"></a>\r
- <b>id</b> : Object <div class="mdesc">\r
-
-The unique ID of the Record as specified at construction time. </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="property-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-modified"></a>\r
- <b>modified</b> : Object <div class="mdesc">\r
- <div class="short">This object contains a key and value storing the original values of all modified fields or is null if no fields have ...</div>\r
- <div class="long">\r
- This object contains a key and value storing the original values of all modified fields or is null if no fields have been modified. </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- </table>
- <a id="Ext.data.Record-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-Record"></a>\r
- <b>Record</b>( <code>Array data</code>, <span class="optional" title="Optional">[<code>Object id</code>]</span> ) <div class="mdesc">\r
- <div class="short">This constructor should not be used to create Record objects. Instead, use the constructor generated by
-create. The p...</div>\r
- <div class="long">\r
- This constructor should not be used to create Record objects. Instead, use the constructor generated by
-<a ext:cls="Ext.data.Record" ext:member="create" href="output/Ext.data.Record.html#create">create</a>. The parameters are the same. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>data</code> : Array<div class="sub-desc">An object, the properties of which provide values for the new Record's fields.</div></li><li><code>id</code> : Object<div class="sub-desc">(Optional) The id of the Record. This id should be unique, and is used by the
-<a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a> object which owns the Record to index its collection of Records. If
-not specified an integer id is generated.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code></code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-beginEdit"></a>\r
- <b>beginEdit</b>() : void <div class="mdesc">\r
- <div class="short">Begin an edit. While in edit mode, no events are relayed to the containing store.</div>\r
- <div class="long">\r
- Begin an edit. While in edit mode, no events are relayed to the containing store. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-cancelEdit"></a>\r
- <b>cancelEdit</b>() : void <div class="mdesc">\r
- <div class="short">Cancels all changes made in the current edit operation.</div>\r
- <div class="long">\r
- Cancels all changes made in the current edit operation. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-commit"></a>\r
- <b>commit</b>( <span class="optional" title="Optional">[<code>Boolean silent</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Usually called by the Ext.data.Store which owns the Record.
-Commits all changes made to the Record since either creat...</div>\r
- <div class="long">\r
- Usually called by the <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a> which owns the Record.
-Commits all changes made to the Record since either creation, or the last commit operation.
-<p>
-Developers should subscribe to the <a ext:cls="Ext.data.Store" ext:member="update" href="output/Ext.data.Store.html#update">Ext.data.Store.update</a> event to have their code notified
-of commit operations. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>silent</code> : Boolean<div class="sub-desc">(optional) True to skip notification of the owning store of the change (defaults to false)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-copy"></a>\r
- <b>copy</b>( <span class="optional" title="Optional">[<code>String id</code>]</span> ) : Record <div class="mdesc">\r
- <div class="short">Creates a copy of this Record.</div>\r
- <div class="long">\r
- Creates a copy of this Record. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>id</code> : String<div class="sub-desc">(optional) A new Record id if you don't want to use this Record's id</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Record</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-create"></a>\r
- <b>create</b>( <span class="optional" title="Optional">[<code>Array o</code>]</span> ) : function <div class="mdesc">\r
- <div class="short"><static> Generate a constructor for a specific Record layout.</div>\r
- <div class="long">\r
- <static> Generate a constructor for a specific Record layout. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>o</code> : Array<div class="sub-desc">An Array of field definition objects which specify field names, and optionally,
-data types, and a mapping for an <a ext:cls="Ext.data.Reader" href="output/Ext.data.Reader.html">Ext.data.Reader</a> to extract the field's value from a data object.
-Each field definition object may contain the following properties: <ul>
-<li><b>name</b> : String<div class="sub-desc">The name by which the field is referenced within the Record. This is referenced by,
-for example, the <em>dataIndex</em> property in column definition objects passed to <a ext:cls="Ext.grid.ColumnModel" href="output/Ext.grid.ColumnModel.html">Ext.grid.ColumnModel</a></div></li>
-<li><b>mapping</b> : String<div class="sub-desc">(Optional) A path specification for use by the <a ext:cls="Ext.data.Reader" href="output/Ext.data.Reader.html">Ext.data.Reader</a> implementation
-that is creating the Record to access the data value from the data object. If an <a ext:cls="Ext.data.JsonReader" href="output/Ext.data.JsonReader.html">Ext.data.JsonReader</a>
-is being used, then this is a string containing the javascript expression to reference the data relative to
-the Record item's root. If an <a ext:cls="Ext.data.XmlReader" href="output/Ext.data.XmlReader.html">Ext.data.XmlReader</a> is being used, this is an <a ext:cls="Ext.DomQuery" href="output/Ext.DomQuery.html">Ext.DomQuery</a> path
-to the data item relative to the Record element. If the mapping expression is the same as the field name,
-this may be omitted.</div></li>
-<li><b>type</b> : String<div class="sub-desc">(Optional) The data type for conversion to displayable value. Possible values are
-<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></li>
-<li><b>sortType</b> : Function<div class="sub-desc">(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 <a ext:cls="Ext.data.SortTypes" href="output/Ext.data.SortTypes.html">Ext.data.SortTypes</a>.</div></li>
-<li><b>sortDir</b> : String<div class="sub-desc">(Optional) Initial direction to sort. "ASC" or "DESC"</div></li>
-<li><b>convert</b> : Function<div class="sub-desc">(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:<ul>
-<li><b>v</b> : Mixed<div class="sub-desc">The data value as read by the Reader.</div></li>
-<li><b>rec</b> : Mixed<div class="sub-desc">The data object containing the row as read by the Reader.
-Depending on Reader type, this could be an Array, an object, or an XML element.</div></li>
-</ul></div></li>
-<li><b>dateFormat</b> : String<div class="sub-desc">(Optional) A format string for the <a ext:cls="Date" ext:member="parseDate" href="output/Date.html#parseDate">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></li>
-<li><b>defaultValue</b> : Mixed<div class="sub-desc">(Optional) The default value used <b>when a Record is being created by a
-<a ext:cls="Ext.data.Reader" href="output/Ext.data.Reader.html">Reader</a></b> when the item referenced by the <b><tt>mapping</tt></b> does not exist in the data object
-(i.e. undefined). (defaults to "")</div></li>
-</ul>
-The constructor generated by this method may be used to create new Record instances. The data object must contain properties
-named after the field <b>names</b>.
-<br>usage:<br><pre><code>var TopicRecord = Ext.data.Record.create([
- {name: <em>'title'</em>, mapping: <em>'topic_title'</em>},
- {name: <em>'author'</em>, mapping: <em>'username'</em>},
- {name: <em>'totalPosts'</em>, mapping: <em>'topic_replies'</em>, type: <em>'int'</em>},
- {name: <em>'lastPost'</em>, mapping: <em>'post_time'</em>, type: <em>'date'</em>},
- {name: <em>'lastPoster'</em>, mapping: <em>'user2'</em>},
- {name: <em>'excerpt'</em>, mapping: <em>'post_text'</em>}
-]);
-
-<b>var</b> myNewRecord = <b>new</b> TopicRecord({
- title: <em>'Do my job please'</em>,
- author: <em>'noobie'</em>,
- totalPosts: 1,
- lastPost: <b>new</b> Date(),
- lastPoster: <em>'Animal'</em>,
- excerpt: <em>'No way dude!'</em>
-});
-myStore.add(myNewRecord);</code></pre>
-<p>In the simplest case, if no properties other than <tt>name</tt> are required, a field definition
-may consist of just a field name string.</p></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>function</code><div class="sub-desc">A constructor which is used to create new Records according to the definition.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-endEdit"></a>\r
- <b>endEdit</b>() : void <div class="mdesc">\r
- <div class="short">End an edit. If any data was modified, the containing store is notified.</div>\r
- <div class="long">\r
- End an edit. If any data was modified, the containing store is notified. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-get"></a>\r
- <b>get</b>( <code>String name</code> ) : Object <div class="mdesc">\r
- <div class="short">Get the value of the named field.</div>\r
- <div class="long">\r
- Get the value of the named field. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>name</code> : String<div class="sub-desc">The name of the field to get the value of.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">The value of the field.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-getChanges"></a>\r
- <b>getChanges</b>() : Object <div class="mdesc">\r
- <div class="short">Gets a hash of only the fields that have been modified since this Record was created or commited.</div>\r
- <div class="long">\r
- Gets a hash of only the fields that have been modified since this Record was created or commited. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-isModified"></a>\r
- <b>isModified</b>( <code>String fieldName</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Returns true if the field passed has been modified since the load or last commit.</div>\r
- <div class="long">\r
- Returns true if the field passed has been modified since the load or last commit. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>fieldName</code> : String<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-reject"></a>\r
- <b>reject</b>( <span class="optional" title="Optional">[<code>Boolean silent</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Usually called by the Ext.data.Store which owns the Record.
-Rejects all changes made to the Record since either creat...</div>\r
- <div class="long">\r
- Usually called by the <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a> which owns the Record.
-Rejects all changes made to the Record since either creation, or the last commit operation.
-Modified fields are reverted to their original values.
-<p>
-Developers should subscribe to the <a ext:cls="Ext.data.Store" ext:member="update" href="output/Ext.data.Store.html#update">Ext.data.Store.update</a> event to have their code notified
-of reject operations. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>silent</code> : Boolean<div class="sub-desc">(optional) True to skip notification of the owning store of the change (defaults to false)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Record-set"></a>\r
- <b>set</b>( <code>String name</code>, <code>Object value</code> ) : void <div class="mdesc">\r
- <div class="short">Set the named field to the specified value.</div>\r
- <div class="long">\r
- Set the named field to the specified value. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>name</code> : String<div class="sub-desc">The name of the field to set.</div></li><li><code>value</code> : Object<div class="sub-desc">The value to set the field to.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Record</td>\r
- </tr>\r
- </table>
- <a id="Ext.data.Record-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff