1 <html><head><title>/home/edward/gitlive/roojs1/Roo/data/Record.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
4 * Copyright(c) 2006-2007, Ext JS, LLC.
6 * Originally Released Under LGPL - original licence link has changed is not relivant.
9 * <script type="text/javascript">
13 * @class Roo.data.Record
14 * Instances of this class encapsulate both record <em>definition</em> information, and record
15 * <em>value</em> information for use in {@link Roo.data.Store} objects, or any code which needs
16 * to access Records cached in an {@link Roo.data.Store} object.<br>
18 * Constructors for this class are generated by passing an Array of field definition objects to {@link #create}.
19 * Instances are usually only created by {@link Roo.data.Reader} implementations when processing unformatted data
22 * Record objects generated by this constructor inherit all the methods of Roo.data.Record listed below.
24 * This constructor should not be used to create Record objects. Instead, use the constructor generated by
25 * {@link #create}. The parameters are the same.
26 * @param {Array} data An associative Array of data values keyed by the field name.
27 * @param {Object} id (Optional) The id of the record. This id should be unique, and is used by the
28 * {@link Roo.data.Store} object which owns the Record to index its collection of Records. If
29 * not specified an integer id is generated.
31 </span><span class="jsdoc-var">Roo.data.Record </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">data</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">id</span><span class="jsdoc-syntax">){
32 </span><span class="jsdoc-var">this.id </span><span class="jsdoc-syntax">= (</span><span class="jsdoc-var">id </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">id </span><span class="jsdoc-syntax">=== 0) ? </span><span class="jsdoc-var">id </span><span class="jsdoc-syntax">: ++</span><span class="jsdoc-var">Roo.data.Record.AUTO_ID</span><span class="jsdoc-syntax">;
33 </span><span class="jsdoc-var">this.data </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">data</span><span class="jsdoc-syntax">;
36 </span><span class="jsdoc-comment">/**
37 * Generate a constructor for a specific record layout.
38 * @param {Array} o An Array of field definition objects which specify field names, and optionally,
39 * data types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.
40 * Each field definition object may contain the following properties: <ul>
41 * <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,
42 * for example the <em>dataIndex</em> property in column definition objects passed to {@link Roo.grid.ColumnModel}</p></li>
43 * <li><b>mapping</b> : String<p style="margin-left:1em">(Optional) A path specification for use by the {@link Roo.data.Reader} implementation
44 * that is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader}
45 * is being used, then this is a string containing the javascript expression to reference the data relative to
46 * the record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path
47 * to the data item relative to the record element. If the mapping expression is the same as the field name,
48 * this may be omitted.</p></li>
49 * <li><b>type</b> : String<p style="margin-left:1em">(Optional) The data type for conversion to displayable value. Possible values are
50 * <ul><li>auto (Default, implies no conversion)</li>
51 * <li>string</li>
52 * <li>int</li>
53 * <li>float</li>
54 * <li>boolean</li>
55 * <li>date</li></ul></p></li>
56 * <li><b>sortType</b> : Mixed<p style="margin-left:1em">(Optional) A member of {@link Roo.data.SortTypes}.</p></li>
57 * <li><b>sortDir</b> : String<p style="margin-left:1em">(Optional) Initial direction to sort. "ASC" or "DESC"</p></li>
58 * <li><b>convert</b> : Function<p style="margin-left:1em">(Optional) A function which converts the value provided
59 * by the Reader into an object that will be stored in the Record. It is passed the
60 * following parameters:<ul>
61 * <li><b>v</b> : Mixed<p style="margin-left:1em">The data value as read by the Reader.</p></li>
62 * </ul></p></li>
63 * <li><b>dateFormat</b> : String<p style="margin-left:1em">(Optional) A format String for the Date.parseDate function.</p></li>
65 * <br>usage:<br><pre><code>
66 var TopicRecord = Roo.data.Record.create(
67 {name: 'title', mapping: 'topic_title'},
68 {name: 'author', mapping: 'username'},
69 {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},
70 {name: 'lastPost', mapping: 'post_time', type: 'date'},
71 {name: 'lastPoster', mapping: 'user2'},
72 {name: 'excerpt', mapping: 'post_text'}
75 var myNewRecord = new TopicRecord({
76 title: 'Do my job please',
81 excerpt: 'No way dude!'
83 myStore.add(myNewRecord);
84 </code></pre>
88 </span><span class="jsdoc-var">Roo.data.Record.create </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">o</span><span class="jsdoc-syntax">){
89 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">f </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
90 </span><span class="jsdoc-var">f.superclass.constructor.apply</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">arguments</span><span class="jsdoc-syntax">);
92 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">f</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.data.Record</span><span class="jsdoc-syntax">);
93 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">p </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">f.prototype</span><span class="jsdoc-syntax">;
94 </span><span class="jsdoc-var">p.fields </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">new </span><span class="jsdoc-var">Roo.util.MixedCollection</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">, </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">field</span><span class="jsdoc-syntax">){
95 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">field.name</span><span class="jsdoc-syntax">;
97 </span><span class="jsdoc-keyword">for</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">i </span><span class="jsdoc-syntax">= 0, </span><span class="jsdoc-var">len </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">o.length</span><span class="jsdoc-syntax">; </span><span class="jsdoc-var">i </span><span class="jsdoc-syntax">< </span><span class="jsdoc-var">len</span><span class="jsdoc-syntax">; </span><span class="jsdoc-var">i</span><span class="jsdoc-syntax">++){
98 </span><span class="jsdoc-var">p.fields.add</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">new </span><span class="jsdoc-var">Roo.data.Field</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">o</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">i</span><span class="jsdoc-syntax">]));
100 </span><span class="jsdoc-var">f.getField </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">){
101 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">p.fields.get</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">);
103 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">f</span><span class="jsdoc-syntax">;
106 </span><span class="jsdoc-var">Roo.data.Record.AUTO_ID </span><span class="jsdoc-syntax">= 1000;
107 </span><span class="jsdoc-var">Roo.data.Record.EDIT </span><span class="jsdoc-syntax">= </span><span class="jsdoc-string">'edit'</span><span class="jsdoc-syntax">;
108 </span><span class="jsdoc-var">Roo.data.Record.REJECT </span><span class="jsdoc-syntax">= </span><span class="jsdoc-string">'reject'</span><span class="jsdoc-syntax">;
109 </span><span class="jsdoc-var">Roo.data.Record.COMMIT </span><span class="jsdoc-syntax">= </span><span class="jsdoc-string">'commit'</span><span class="jsdoc-syntax">;
111 </span><span class="jsdoc-var">Roo.data.Record.prototype </span><span class="jsdoc-syntax">= {
112 </span><span class="jsdoc-comment">/**
113 * Readonly flag - true if this record has been modified.
116 </span><span class="jsdoc-var">dirty </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
117 </span><span class="jsdoc-var">editing </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
118 </span><span class="jsdoc-var">error</span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">,
119 </span><span class="jsdoc-var">modified</span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">,
121 </span><span class="jsdoc-comment">// private
122 </span><span class="jsdoc-var">join </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">store</span><span class="jsdoc-syntax">){
123 </span><span class="jsdoc-var">this.store </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">store</span><span class="jsdoc-syntax">;
126 </span><span class="jsdoc-comment">/**
127 * Set the named field to the specified value.
128 * @param {String} name The name of the field to set.
129 * @param {Object} value The value to set the field to.
131 </span><span class="jsdoc-var">set </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">value</span><span class="jsdoc-syntax">){
132 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.data</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">] == </span><span class="jsdoc-var">value</span><span class="jsdoc-syntax">){
133 </span><span class="jsdoc-keyword">return</span><span class="jsdoc-syntax">;
135 </span><span class="jsdoc-var">this.dirty </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">;
136 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(!</span><span class="jsdoc-var">this.modified</span><span class="jsdoc-syntax">){
137 </span><span class="jsdoc-var">this.modified </span><span class="jsdoc-syntax">= {};
139 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">this.modified</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">] == </span><span class="jsdoc-string">'undefined'</span><span class="jsdoc-syntax">){
140 </span><span class="jsdoc-var">this.modified</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">] = </span><span class="jsdoc-var">this.data</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">];
142 </span><span class="jsdoc-var">this.data</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">] = </span><span class="jsdoc-var">value</span><span class="jsdoc-syntax">;
143 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(!</span><span class="jsdoc-var">this.editing </span><span class="jsdoc-syntax">&& </span><span class="jsdoc-var">this.store</span><span class="jsdoc-syntax">){
144 </span><span class="jsdoc-var">this.store.afterEdit</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
148 </span><span class="jsdoc-comment">/**
149 * Get the value of the named field.
150 * @param {String} name The name of the field to get the value of.
151 * @return {Object} The value of the field.
153 </span><span class="jsdoc-var">get </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">){
154 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.data</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">];
157 </span><span class="jsdoc-comment">// private
158 </span><span class="jsdoc-var">beginEdit </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
159 </span><span class="jsdoc-var">this.editing </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">;
160 </span><span class="jsdoc-var">this.modified </span><span class="jsdoc-syntax">= {};
163 </span><span class="jsdoc-comment">// private
164 </span><span class="jsdoc-var">cancelEdit </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
165 </span><span class="jsdoc-var">this.editing </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">;
166 </span><span class="jsdoc-keyword">delete </span><span class="jsdoc-var">this.modified</span><span class="jsdoc-syntax">;
169 </span><span class="jsdoc-comment">// private
170 </span><span class="jsdoc-var">endEdit </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
171 </span><span class="jsdoc-var">this.editing </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">;
172 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.dirty </span><span class="jsdoc-syntax">&& </span><span class="jsdoc-var">this.store</span><span class="jsdoc-syntax">){
173 </span><span class="jsdoc-var">this.store.afterEdit</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
177 </span><span class="jsdoc-comment">/**
178 * Usually called by the {@link Roo.data.Store} which owns the Record.
179 * Rejects all changes made to the Record since either creation, or the last commit operation.
180 * Modified fields are reverted to their original values.
182 * Developers should subscribe to the {@link Roo.data.Store#update} event to have their code notified
183 * of reject operations.
185 </span><span class="jsdoc-var">reject </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
186 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">m </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.modified</span><span class="jsdoc-syntax">;
187 </span><span class="jsdoc-keyword">for</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">n </span><span class="jsdoc-keyword">in </span><span class="jsdoc-var">m</span><span class="jsdoc-syntax">){
188 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">m</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">n</span><span class="jsdoc-syntax">] != </span><span class="jsdoc-string">"function"</span><span class="jsdoc-syntax">){
189 </span><span class="jsdoc-var">this.data</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">n</span><span class="jsdoc-syntax">] = </span><span class="jsdoc-var">m</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">n</span><span class="jsdoc-syntax">];
192 </span><span class="jsdoc-var">this.dirty </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">;
193 </span><span class="jsdoc-keyword">delete </span><span class="jsdoc-var">this.modified</span><span class="jsdoc-syntax">;
194 </span><span class="jsdoc-var">this.editing </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">;
195 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.store</span><span class="jsdoc-syntax">){
196 </span><span class="jsdoc-var">this.store.afterReject</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
200 </span><span class="jsdoc-comment">/**
201 * Usually called by the {@link Roo.data.Store} which owns the Record.
202 * Commits all changes made to the Record since either creation, or the last commit operation.
204 * Developers should subscribe to the {@link Roo.data.Store#update} event to have their code notified
205 * of commit operations.
207 </span><span class="jsdoc-var">commit </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
208 </span><span class="jsdoc-var">this.dirty </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">;
209 </span><span class="jsdoc-keyword">delete </span><span class="jsdoc-var">this.modified</span><span class="jsdoc-syntax">;
210 </span><span class="jsdoc-var">this.editing </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">;
211 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.store</span><span class="jsdoc-syntax">){
212 </span><span class="jsdoc-var">this.store.afterCommit</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
216 </span><span class="jsdoc-comment">// private
217 </span><span class="jsdoc-var">hasError </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
218 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.error </span><span class="jsdoc-syntax">!= </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">;
221 </span><span class="jsdoc-comment">// private
222 </span><span class="jsdoc-var">clearError </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
223 </span><span class="jsdoc-var">this.error </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">;
226 </span><span class="jsdoc-comment">/**
227 * Creates a copy of this record.
228 * @param {String} id (optional) A new record id if you don't want to use this record's id
231 </span><span class="jsdoc-var">copy </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">newId</span><span class="jsdoc-syntax">) {
232 </span><span class="jsdoc-keyword">return new </span><span class="jsdoc-var">this.constructor</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.apply</span><span class="jsdoc-syntax">({}, </span><span class="jsdoc-var">this.data</span><span class="jsdoc-syntax">), </span><span class="jsdoc-var">newId </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">this.id</span><span class="jsdoc-syntax">);
234 };</span></code></body></html>