--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=undefined" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+
+ <title>JsDoc Reference - Roo.data.Record</title>
+
+
+ <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
+ <link rel="stylesheet" type="text/css" href="../default.css" />
+
+
+ <script type="text/javascript" src="../page.js">
+
+ </script>
+
+
+ </head>
+
+ <body onload="RooDocsPage.onload();">
+
+
+<div class="body-wrap">
+
+ <!-- ============================== links to methods. ================================= -->
+
+ <div class="top-tools">
+ <!--
+ <a class="inner-link" href="#Roo.data.Record-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+ <a class="inner-link" href="#Roo.data.Record-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+ <a class="inner-link" href="#Roo.data.Record-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+ <a class="inner-link" href="#Roo.data.Record-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+ <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+ -->
+ </div>
+
+
+<!-- ============================== inheritance Block. ================================= -->
+
+<!-- ============================== class title / details ============================ -->
+
+
+ <h1 class="classTitle">
+
+ Class Roo.data.Record
+ </h1>
+
+ <table cellspacing="0" class="class-summary-table">
+
+ <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
+
+ <tr><td class="label">Defined In:</td><td class="hd-info">
+
+ <a href="./src/Roo_data_Record.js.html">Roo/data/Record.js</a>.
+
+ </td></tr>
+ <tr><td class="label">Class:</td><td class="hd-info">Record</td></tr>
+
+
+
+
+ </table>
+
+
+<!-- ============================== class summary ========================== -->
+ <div class="description">
+ Instances of this class encapsulate both record <em>definition</em> information, and record<br/><em>value</em> information for use in {<b>link</b> Roo.data.Store} objects, or any code which needs<br/>to access Records cached in an {<b>link</b> Roo.data.Store} object.<br><br/><p><br/>Constructors for this class are generated by passing an Array of field definition objects to {<b>link</b> <b>create</b>}.<br/>Instances are usually only created by {<b>link</b> Roo.data.Reader} implementations when processing unformatted data<br/>objects.<br><br/><p><br/>Record objects generated by this constructor inherit all the methods of Roo.data.Record listed below.
+ </div>
+
+
+<!-- ============================== Class comment block... ========================== -->
+
+<div class="comments">
+ <b>Class Comments / Notes</B> =>
+ <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.Record';">[Add Your comment/notes about this class]</u>
+ <br/>
+ <iframe frameborder="0" id="comments-Roo.data" style="border: none;width:100%;"
+ src="/blog.php/GtkDjsComments/Roo.data.Record.html"></iframe>
+</div>
+
+
+
+<!-- ============================== config options ========================== -->
+
+
+
+
+ <div class="hr"></div>
+ <a id="Roo.data.Record-configs"></a>
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Config Options - Has None</caption>
+ </table>
+
+
+
+
+
+
+
+
+
+
+
+
+ <!-- ============================== public properties ==================== -->
+
+
+
+ <a id="Roo.data.Record-props"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Public Properties - Has None</caption>
+ </table>
+
+
+
+
+ <!-- ============================== methods summary / details ======================== -->
+
+
+ <a id="Roo.data.Record-methods"></a>
+ <!-- constructor?? -->
+
+ <!-- static's first
+
+
+ -->
+
+ <!-- then dynamics first -->
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Public Methods</caption>
+ <tr>
+ <th class="sig-header" colspan="2">Method</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+
+
+
+
+
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data-method-Record" name=".Record"></a>
+ <div class="fixedFont">
+ <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">Record</b>
+
+ (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a> <B><i>data</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>id</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+
+ <div class="short">Create a new Roo.data.Record</div>
+
+
+ <div class="long">
+
+
+
+ Create a new Roo.data.Record
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> <b>data</b>
+
+ </dt>
+ <dd>An associative Array of data values keyed by the field name.</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>id</b>
+
+ </dt>
+ <dd>(Optional) The id of the record. This id should be unique, and is used by the<br/>{<b>link</b> Roo.data.Store} object which owns the Record to index its collection of Records. If<br/>not specified an integer id is generated.</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Record-method-create" name=".create"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.data.Record.</span><b class="itemname">create</b>
+
+ (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a> <B><i>o</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Generate a constructor for a specific record layout.</div>
+
+
+
+ <div class="long">
+
+ Generate a constructor for a specific record layout.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> <b>o</b>
+
+ </dt>
+ <dd>An Array of field definition objects which specify field names, and optionally,<br/>data types, and a mapping for an {<b>link</b> Roo.data.Reader} to extract the field's value from a data object.<br/>Each field definition object may contain the following properties: <ul><br/><li><b>name</b> : String<p style="margin-left:1em">The name by which the field is referenced within the Record. This is referenced by,<br/>for example the <em>dataIndex</em> property in column definition objects passed to {<b>link</b> Roo.grid.ColumnModel}</p></li><br/><li><b>mapping</b> : String<p style="margin-left:1em">(Optional) A path specification for use by the {<b>link</b> Roo.data.Reader} implementation<br/>that is creating the Record to access the data value from the data object. If an {<b>link</b> Roo.data.JsonReader}<br/>is being used, then this is a string containing the javascript expression to reference the data relative to <br/>the record item's root. If an {<b>link</b> Roo.data.XmlReader} is being used, this is an {<b>link</b> Roo.DomQuery} path<br/>to the data item relative to the record element. If the mapping expression is the same as the field name,<br/>this may be omitted.</p></li><br/><li><b>type</b> : String<p style="margin-left:1em">(Optional) The data type for conversion to displayable value. Possible values are<br/><ul><li>auto (Default, implies no conversion)</li><br/><li>string</li><br/><li>int</li><br/><li>float</li><br/><li>boolean</li><br/><li>date</li></ul></p></li><br/><li><b>sortType</b> : Mixed<p style="margin-left:1em">(Optional) A member of {<b>link</b> Roo.data.SortTypes}.</p></li><br/><li><b>sortDir</b> : String<p style="margin-left:1em">(Optional) Initial direction to sort. "ASC" or "DESC"</p></li><br/><li><b>convert</b> : Function<p style="margin-left:1em">(Optional) A function which converts the value provided<br/>by the Reader into an object that will be stored in the Record. It is passed the<br/>following parameters:<ul><br/><li><b>v</b> : Mixed<p style="margin-left:1em">The data value as read by the Reader.</p></li><br/></ul></p></li><br/><li><b>dateFormat</b> : String<p style="margin-left:1em">(Optional) A format String for the Date.parseDate function.</p></li><br/></ul><br/><br>usage:<br><pre><code><br/>var TopicRecord = Roo.data.Record.create(<br/> {name: 'title', mapping: 'topic_title'},<br/> {name: 'author', mapping: 'username'},<br/> {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},<br/> {name: 'lastPost', mapping: 'post_time', type: 'date'},<br/> {name: 'lastPoster', mapping: 'user2'},<br/> {name: 'excerpt', mapping: 'post_text'}<br/>);<br/><br/>var myNewRecord = new TopicRecord({<br/> title: 'Do my job please',<br/> author: 'noobie',<br/> totalPosts: 1,<br/> lastPost: new Date(),<br/> lastPoster: 'Animal',<br/> excerpt: 'No way dude!'<br/>});<br/>myStore.add(myNewRecord);<br/></code></pre></dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Record
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Record-method-commit" name=".commit"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">commit</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Usually called by the {<b>link</b> Roo.data.Store} which owns the Record.</div>
+
+
+
+ <div class="long">
+
+ Usually called by the {<b>link</b> Roo.data.Store} which owns the Record.<br/>Commits all changes made to the Record since either creation, or the last commit operation.<br/><p><br/>Developers should subscribe to the {<b>link</b> Roo.data.Store<b>update</b>} event to have their code notified<br/>of commit operations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Record
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Record-method-copy" name=".copy"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">copy</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
+
+
+ :
+
+
+ Record
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Creates a copy of this record.</div>
+
+
+
+ <div class="long">
+
+ Creates a copy of this record.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
+
+ </dt>
+ <dd>(optional) A new record id if you don't want to use this record's id</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">Record</span> </dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Record
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Record-method-get" name=".get"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">get</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>)
+
+
+ :
+
+
+ <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Get the value of the named field.</div>
+
+
+
+ <div class="long">
+
+ Get the value of the named field.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
+
+ </dt>
+ <dd>The name of the field to get the value of.</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> The value of the field.</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Record
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Record-method-reject" name=".reject"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">reject</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Usually called by the {<b>link</b> Roo.data.Store} which owns the Record.</div>
+
+
+
+ <div class="long">
+
+ Usually called by the {<b>link</b> Roo.data.Store} which owns the Record.<br/>Rejects all changes made to the Record since either creation, or the last commit operation.<br/>Modified fields are reverted to their original values.<br/><p><br/>Developers should subscribe to the {<b>link</b> Roo.data.Store<b>update</b>} event to have their code notified<br/>of reject operations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Record
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.data.Record-method-set" name=".set"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">set</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>name</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>value</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Set the named field to the specified value.</div>
+
+
+
+ <div class="long">
+
+ Set the named field to the specified value.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>name</b>
+
+ </dt>
+ <dd>The name of the field to set.</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>value</b>
+
+ </dt>
+ <dd>The value to set the field to.</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.data.Record
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+ <!-- ============================== events summary / details ======================== -->
+
+
+ <a id="Roo.data.Record-events"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Events - Has None</caption>
+ </table>
+
+
+
+
+
+
+
+
+
+<!-- ============================== footer ================================= -->
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT)
+ Based on
+ <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
+ </div>
+ </body>
+</html>
projects / roojs1 / blobdiff