Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / docs / source / RowNumberer.html
1 <html>\r
2 <head>\r
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
4   <title>The source code</title>\r
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
7 </head>\r
8 <body  onload="prettyPrint();">\r
9     <pre class="prettyprint lang-js"><div id="cls-Ext.grid.RowNumberer"></div>/**
10  * @class Ext.grid.RowNumberer
11  * This is a utility class that can be passed into a {@link Ext.grid.ColumnModel} as a column config that provides
12  * an automatic row numbering column.
13  * <br>Usage:<br>
14  <pre><code>
15  // This is a typical column config with the first column providing row numbers
16  var colModel = new Ext.grid.ColumnModel([
17     new Ext.grid.RowNumberer(),
18     {header: "Name", width: 80, sortable: true},
19     {header: "Code", width: 50, sortable: true},
20     {header: "Description", width: 200, sortable: true}
21  ]);
22  </code></pre>
23  * @constructor
24  * @param {Object} config The configuration options
25  */
26 Ext.grid.RowNumberer = Ext.extend(Object, {
27     <div id="cfg-Ext.grid.RowNumberer-header"></div>/**
28      * @cfg {String} header Any valid text or HTML fragment to display in the header cell for the row
29      * number column (defaults to '').
30      */
31     header: "",
32     <div id="cfg-Ext.grid.RowNumberer-width"></div>/**
33      * @cfg {Number} width The default width in pixels of the row number column (defaults to 23).
34      */
35     width: 23,
36     <div id="cfg-Ext.grid.RowNumberer-sortable"></div>/**
37      * @cfg {Boolean} sortable True if the row number column is sortable (defaults to false).
38      * @hide
39      */
40     sortable: false,
41     
42     constructor : function(config){
43         Ext.apply(this, config);
44         if(this.rowspan){
45             this.renderer = this.renderer.createDelegate(this);
46         }
47     },
48
49     // private
50     fixed:true,
51     menuDisabled:true,
52     dataIndex: '',
53     id: 'numberer',
54     rowspan: undefined,
55
56     // private
57     renderer : function(v, p, record, rowIndex){
58         if(this.rowspan){
59             p.cellAttr = 'rowspan="'+this.rowspan+'"';
60         }
61         return rowIndex+1;
62     }
63 });</pre>    \r
64 </body>\r
65 </html>