commit extjs-2.2.1
[extjs.git] / docs / output / Ext.grid.RowNumberer.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.grid.RowNumberer-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.grid.RowNumberer-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.grid.RowNumberer-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                             <a class="inner-link" href="#Ext.grid.RowNumberer-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7                         <a class="bookmark" href="../docs/?class=Ext.grid.RowNumberer"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8         </div>
9                 <h1>Class Ext.grid.RowNumberer</h1>
10         <table cellspacing="0">
11             <tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr>
12             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/RowNumberer.js" target="_blank">RowNumberer.js</a></td></tr>
13             <tr><td class="label">Class:</td><td class="hd-info">RowNumberer</td></tr>
14                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
15                     </table>
16         <div class="description">
17             *
18 This is a utility class that can be passed into a <a ext:cls="Ext.grid.ColumnModel" href="output/Ext.grid.ColumnModel.html">Ext.grid.ColumnModel</a> as a column config that provides
19 an automatic row numbering column.
20 <br>Usage:<br>\r
21  <pre><code><i>// This is a typical column config <b>with</b> the first column providing row numbers</i>
22  <b>var</b> colModel = <b>new</b> Ext.grid.ColumnModel([
23     <b>new</b> Ext.grid.RowNumberer(),
24     {header: <em>"Name"</em>, width: 80, sortable: true},
25     {header: <em>"Code"</em>, width: 50, sortable: true},
26     {header: <em>"Description"</em>, width: 200, sortable: true}
27  ]);</code></pre>        </div>
28         
29         <div class="hr"></div>
30                 <a id="Ext.grid.RowNumberer-configs"></a>
31         <h2>Config Options</h2>
32         <table cellspacing="0" class="member-table">
33             <tr>
34                 <th class="sig-header" colspan="2">Config Options</th>
35                 <th class="msource-header">Defined By</th>
36             </tr>
37                 <tr class="config-row">\r
38         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
39         <td class="sig">\r
40         <a id="Ext.grid.RowNumberer-header"></a>\r
41             <b>header</b> : String            <div class="mdesc">\r
42                             Any valid text or HTML fragment to display in the header cell for the row number column (defaults to '').                        </div>\r
43         </td>\r
44         <td class="msource">RowNumberer</td>\r
45     </tr>\r
46         <tr class="config-row alt">\r
47         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
48         <td class="sig">\r
49         <a id="Ext.grid.RowNumberer-width"></a>\r
50             <b>width</b> : Number            <div class="mdesc">\r
51                             The default width in pixels of the row number column (defaults to 23).                        </div>\r
52         </td>\r
53         <td class="msource">RowNumberer</td>\r
54     </tr>\r
55             </table>
56                 <a id="Ext.grid.RowNumberer-props"></a>
57         <h2>Public Properties</h2>
58         <div class="no-members">This class has no public properties.</div>        <a id="Ext.grid.RowNumberer-methods"></a>
59         <h2>Public Methods</h2>
60                 <table cellspacing="0" class="member-table">
61             <tr>
62                 <th class="sig-header" colspan="2">Method</th>
63                 <th class="msource-header">Defined By</th>
64             </tr>
65                 <tr class="method-row expandable">\r
66         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
67         <td class="sig">\r
68         <a id="Ext.grid.RowNumberer-RowNumberer"></a>\r
69             <b>RowNumberer</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">\r
70                         <div class="short"></div>\r
71             <div class="long">\r
72                     <div class="mdetail-params">\r
73         <strong>Parameters:</strong>\r
74         <ul><li><code>config</code> : Object<div class="sub-desc">The configuration options</div></li>        </ul>\r
75         <strong>Returns:</strong>\r
76         <ul>\r
77             <li><code></code></li>\r
78         </ul>\r
79     </div>\r
80                 </div>\r
81                         </div>\r
82         </td>\r
83         <td class="msource">RowNumberer</td>\r
84     </tr>\r
85             </table>
86                 <a id="Ext.grid.RowNumberer-events"></a>
87         <h2>Public Events</h2>
88         <div class="no-members">This class has no public events.</div>
89         </div>