make sure the README will appear on github
[extjs.git] / docs / output / Ext.grid.PropertyRecord.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.grid.PropertyRecord-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.grid.PropertyRecord-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.grid.PropertyRecord-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                         <a class="bookmark" href="../docs/?class=Ext.grid.PropertyRecord"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
7         </div>
8                 <h1>Class Ext.grid.PropertyRecord</h1>
9         <table cellspacing="0">
10             <tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr>
11             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/PropertyGrid.js" target="_blank">PropertyGrid.js</a></td></tr>
12             <tr><td class="label">Class:</td><td class="hd-info">PropertyRecord</td></tr>
13                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
14                     </table>
15         <div class="description">
16             *
17 A specific <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Ext.data.Record</a> type that represents a name/value pair and is made to work with the
18 <a ext:cls="Ext.grid.PropertyGrid" href="output/Ext.grid.PropertyGrid.html">Ext.grid.PropertyGrid</a>.  Typically, PropertyRecords do not need to be created directly as they can be
19 created implicitly by simply using the appropriate data configs either via the <a ext:cls="Ext.grid.PropertyGrid" ext:member="source" href="output/Ext.grid.PropertyGrid.html#source">Ext.grid.PropertyGrid.source</a>
20 config property or by calling <a ext:cls="Ext.grid.PropertyGrid" ext:member="setSource" href="output/Ext.grid.PropertyGrid.html#setSource">Ext.grid.PropertyGrid.setSource</a>.  However, if the need arises, these records
21 can also be created explicitly as shwon below.  Example usage:
22 <pre><code>var rec = <b>new</b> Ext.grid.PropertyRecord({
23     name: <em>'Birthday'</em>,
24     value: <b>new</b> Date(Date.parse(<em>'05/26/1972'</em>))
25 });
26 <i>// Add record to an already populated grid</i>
27 grid.store.addSorted(rec);</code></pre>        </div>
28         
29         <div class="hr"></div>
30                 <a id="Ext.grid.PropertyRecord-props"></a>
31         <h2>Public Properties</h2>
32         <div class="no-members">This class has no public properties.</div>        <a id="Ext.grid.PropertyRecord-methods"></a>
33         <h2>Public Methods</h2>
34                 <table cellspacing="0" class="member-table">
35             <tr>
36                 <th class="sig-header" colspan="2">Method</th>
37                 <th class="msource-header">Defined By</th>
38             </tr>
39                 <tr class="method-row expandable">\r
40         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
41         <td class="sig">\r
42         <a id="Ext.grid.PropertyRecord-PropertyRecord"></a>\r
43             <b>PropertyRecord</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">\r
44                         <div class="short"></div>\r
45             <div class="long">\r
46                     <div class="mdetail-params">\r
47         <strong>Parameters:</strong>\r
48         <ul><li><code>config</code> : Object<div class="sub-desc">A data object in the format: {name: [name], value: [value]}. The specified value's type
49 will be read automatically by the grid to determine the type of editor to use when displaying it.</div></li>        </ul>\r
50         <strong>Returns:</strong>\r
51         <ul>\r
52             <li><code></code></li>\r
53         </ul>\r
54     </div>\r
55                 </div>\r
56                         </div>\r
57         </td>\r
58         <td class="msource">PropertyRecord</td>\r
59     </tr>\r
60             </table>
61                 <a id="Ext.grid.PropertyRecord-events"></a>
62         <h2>Public Events</h2>
63         <div class="no-members">This class has no public events.</div>
64         </div>