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