docs/source/ListView.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.ListView"></div>/**\r
   9  * @class Ext.ListView\r
  10  * @extends Ext.DataView\r
  11  * <p>Ext.ListView is a fast and light-weight implentation of a\r
  12  * {@link Ext.grid.GridPanel Grid} like view with the following characteristics:</p>\r
  13  * <div class="mdetail-params"><ul>\r
  14  * <li>resizable columns</li>\r
  15  * <li>selectable</li>\r
  16  * <li>column widths are initially proportioned by percentage based on the container\r
  17  * width and number of columns</li>\r
  18  * <li>uses templates to render the data in any required format</li>\r
  19  * <li>no horizontal scrolling</li>\r
  20  * <li>no editing</li>\r
  21  * </ul></div>\r
  22  * <p>Example usage:</p>\r
  23  * <pre><code>\r
  24 // consume JSON of this form:\r
  25 {\r
  26    "images":[\r
  27       {\r
  28          "name":"dance_fever.jpg",\r
  29          "size":2067,\r
  30          "lastmod":1236974993000,\r
  31          "url":"images\/thumbs\/dance_fever.jpg"\r
  32       },\r
  33       {\r
  34          "name":"zack_sink.jpg",\r
  35          "size":2303,\r
  36          "lastmod":1236974993000,\r
  37          "url":"images\/thumbs\/zack_sink.jpg"\r
  38       }\r
  39    ]\r
  40 } \r
  41 var store = new Ext.data.JsonStore({\r
  42     url: 'get-images.php',\r
  43     root: 'images',\r
  44     fields: [\r
  45         'name', 'url',\r
  46         {name:'size', type: 'float'},\r
  47         {name:'lastmod', type:'date', dateFormat:'timestamp'}\r
  48     ]\r
  49 });\r
  50 store.load();\r
  51 \r
  52 var listView = new Ext.ListView({\r
  53     store: store,\r
  54     multiSelect: true,\r
  55     emptyText: 'No images to display',\r
  56     reserveScrollOffset: true,\r
  57     columns: [{\r
  58         header: 'File',\r
  59         width: .5,\r
  60         dataIndex: 'name'\r
  61     },{\r
  62         header: 'Last Modified',\r
  63         width: .35, \r
  64         dataIndex: 'lastmod',\r
  65         tpl: '{lastmod:date("m-d h:i a")}'\r
  66     },{\r
  67         header: 'Size',\r
  68         dataIndex: 'size',\r
  69         tpl: '{size:fileSize}', // format using Ext.util.Format.fileSize()\r
  70         align: 'right'\r
  71     }]\r
  72 });\r
  73 \r
  74 // put it in a Panel so it looks pretty\r
  75 var panel = new Ext.Panel({\r
  76     id:'images-view',\r
  77     width:425,\r
  78     height:250,\r
  79     collapsible:true,\r
  80     layout:'fit',\r
  81     title:'Simple ListView <i>(0 items selected)</i>',\r
  82     items: listView\r
  83 });\r
  84 panel.render(document.body);\r
  85 \r
  86 // little bit of feedback\r
  87 listView.on('selectionchange', function(view, nodes){\r
  88     var l = nodes.length;\r
  89     var s = l != 1 ? 's' : '';\r
  90     panel.setTitle('Simple ListView <i>('+l+' item'+s+' selected)</i>');\r
  91 });\r
  92  * </code></pre>\r
  93  * @constructor\r
  94  * @param {Object} config\r
  95  * @xtype listview\r
  96  */\r
  97 Ext.ListView = Ext.extend(Ext.DataView, {\r
  98     <div id="prop-Ext.ListView-disableHeaders"></div>/**\r
  99      * Set this property to <tt>true</tt> to disable the header click handler disabling sort\r
 100      * (defaults to <tt>false</tt>).\r
 101      * @type Boolean\r
 102      * @property disableHeaders\r
 103      */\r
 104     <div id="cfg-Ext.ListView-hideHeaders"></div>/**\r
 105      * @cfg {Boolean} hideHeaders\r
 106      * <tt>true</tt> to hide the {@link #internalTpl header row} (defaults to <tt>false</tt> so\r
 107      * the {@link #internalTpl header row} will be shown).\r
 108      */\r
 109     <div id="cfg-Ext.ListView-itemSelector"></div>/**\r
 110      * @cfg {String} itemSelector\r
 111      * Defaults to <tt>'dl'</tt> to work with the preconfigured <b><tt>{@link Ext.DataView#tpl tpl}</tt></b>.\r
 112      * This setting specifies the CSS selector (e.g. <tt>div.some-class</tt> or <tt>span:first-child</tt>)\r
 113      * that will be used to determine what nodes the ListView will be working with.   \r
 114      */\r
 115     itemSelector: 'dl',\r
 116     <div id="cfg-Ext.ListView-selectedClass"></div>/**\r
 117      * @cfg {String} selectedClass The CSS class applied to a selected row (defaults to\r
 118      * <tt>'x-list-selected'</tt>). An example overriding the default styling:\r
 119     <pre><code>\r
 120     .x-list-selected {background-color: yellow;}\r
 121     </code></pre>\r
 122      * @type String\r
 123      */\r
 124     selectedClass:'x-list-selected',\r
 125     <div id="cfg-Ext.ListView-overClass"></div>/**\r
 126      * @cfg {String} overClass The CSS class applied when over a row (defaults to\r
 127      * <tt>'x-list-over'</tt>). An example overriding the default styling:\r
 128     <pre><code>\r
 129     .x-list-over {background-color: orange;}\r
 130     </code></pre>\r
 131      * @type String\r
 132      */\r
 133     overClass:'x-list-over',\r
 134     <div id="cfg-Ext.ListView-reserveScrollOffset"></div>/**\r
 135      * @cfg {Boolean} reserveScrollOffset\r
 136      * By default will defer accounting for the configured <b><tt>{@link #scrollOffset}</tt></b>\r
 137      * for 10 milliseconds.  Specify <tt>true</tt> to account for the configured\r
 138      * <b><tt>{@link #scrollOffset}</tt></b> immediately.\r
 139      */\r
 140     <div id="cfg-Ext.ListView-scrollOffset"></div>/**\r
 141      * @cfg {Number} scrollOffset The amount of space to reserve for the scrollbar (defaults to\r
 142      * <tt>19</tt> pixels)\r
 143      */\r
 144     scrollOffset : 19,\r
 145     <div id="cfg-Ext.ListView-columnResize"></div>/**\r
 146      * @cfg {Boolean/Object} columnResize\r
 147      * Specify <tt>true</tt> or specify a configuration object for {@link Ext.ListView.ColumnResizer}\r
 148      * to enable the columns to be resizable (defaults to <tt>true</tt>).\r
 149      */\r
 150     columnResize: true,\r
 151     <div id="cfg-Ext.ListView-columns"></div>/**\r
 152      * @cfg {Array} columns An array of column configuration objects, for example:\r
 153      * <pre><code>\r
 154 {\r
 155     align: 'right',\r
 156     dataIndex: 'size',\r
 157     header: 'Size',\r
 158     tpl: '{size:fileSize}',\r
 159     width: .35\r
 160 }\r
 161      * </code></pre> \r
 162      * Acceptable properties for each column configuration object are:\r
 163      * <div class="mdetail-params"><ul>\r
 164      * <li><b><tt>align</tt></b> : String<div class="sub-desc">Set the CSS text-align property\r
 165      * of the column. Defaults to <tt>'left'</tt>.</div></li>\r
 166      * <li><b><tt>dataIndex</tt></b> : String<div class="sub-desc">See {@link Ext.grid.Column}.\r
 167      * {@link Ext.grid.Column#dataIndex dataIndex} for details.</div></li>\r
 168      * <li><b><tt>header</tt></b> : String<div class="sub-desc">See {@link Ext.grid.Column}.\r
 169      * {@link Ext.grid.Column#header header} for details.</div></li>\r
 170      * <li><b><tt>tpl</tt></b> : String<div class="sub-desc">Specify a string to pass as the\r
 171      * configuration string for {@link Ext.XTemplate}.  By default an {@link Ext.XTemplate}\r
 172      * will be implicitly created using the <tt>dataIndex</tt>.</div></li>\r
 173      * <li><b><tt>width</tt></b> : Number<div class="sub-desc">Percentage of the container width\r
 174      * this column should be allocated.  Columns that have no width specified will be\r
 175      * allocated with an equal percentage to fill 100% of the container width.  To easily take\r
 176      * advantage of the full container width, leave the width of at least one column undefined.\r
 177      * Note that if you do not want to take up the full width of the container, the width of\r
 178      * every column needs to be explicitly defined.</div></li>\r
 179      * </ul></div>\r
 180      */\r
 181     <div id="cfg-Ext.ListView-columnSort"></div>/**\r
 182      * @cfg {Boolean/Object} columnSort\r
 183      * Specify <tt>true</tt> or specify a configuration object for {@link Ext.ListView.Sorter}\r
 184      * to enable the columns to be sortable (defaults to <tt>true</tt>).\r
 185      */\r
 186     columnSort: true,\r
 187     <div id="cfg-Ext.ListView-internalTpl"></div>/**\r
 188      * @cfg {String/Array} internalTpl\r
 189      * The template to be used for the header row.  See {@link #tpl} for more details.\r
 190      */\r
 191 \r
 192     initComponent : function(){\r
 193         if(this.columnResize){\r
 194             this.colResizer = new Ext.ListView.ColumnResizer(this.colResizer);\r
 195             this.colResizer.init(this);\r
 196         }\r
 197         if(this.columnSort){\r
 198             this.colSorter = new Ext.ListView.Sorter(this.columnSort);\r
 199             this.colSorter.init(this);\r
 200         }\r
 201         if(!this.internalTpl){\r
 202             this.internalTpl = new Ext.XTemplate(\r
 203                 '<div class="x-list-header"><div class="x-list-header-inner">',\r
 204                     '<tpl for="columns">',\r
 205                     '<div style="width:{width}%;text-align:{align};"><em unselectable="on" id="',this.id, '-xlhd-{#}">',\r
 206                         '{header}',\r
 207                     '</em></div>',\r
 208                     '</tpl>',\r
 209                     '<div class="x-clear"></div>',\r
 210                 '</div></div>',\r
 211                 '<div class="x-list-body"><div class="x-list-body-inner">',\r
 212                 '</div></div>'\r
 213             );\r
 214         }\r
 215         if(!this.tpl){\r
 216             this.tpl = new Ext.XTemplate(\r
 217                 '<tpl for="rows">',\r
 218                     '<dl>',\r
 219                         '<tpl for="parent.columns">',\r
 220                         '<dt style="width:{width}%;text-align:{align};"><em unselectable="on">',\r
 221                             '{[values.tpl.apply(parent)]}',\r
 222                         '</em></dt>',\r
 223                         '</tpl>',\r
 224                         '<div class="x-clear"></div>',\r
 225                     '</dl>',\r
 226                 '</tpl>'\r
 227             );\r
 228         };\r
 229         var cs = this.columns, allocatedWidth = 0, colsWithWidth = 0, len = cs.length;\r
 230         for(var i = 0; i < len; i++){\r
 231             var c = cs[i];\r
 232             if(!c.tpl){\r
 233                 c.tpl = new Ext.XTemplate('{' + c.dataIndex + '}');\r
 234             }else if(Ext.isString(c.tpl)){\r
 235                 c.tpl = new Ext.XTemplate(c.tpl);\r
 236             }\r
 237             c.align = c.align || 'left';\r
 238             if(Ext.isNumber(c.width)){\r
 239                 c.width *= 100;\r
 240                 allocatedWidth += c.width;\r
 241                 colsWithWidth++;\r
 242             }\r
 243         }\r
 244         // auto calculate missing column widths\r
 245         if(colsWithWidth < len){\r
 246             var remaining = len - colsWithWidth;\r
 247             if(allocatedWidth < 100){\r
 248                 var perCol = ((100-allocatedWidth) / remaining);\r
 249                 for(var j = 0; j < len; j++){\r
 250                     var c = cs[j];\r
 251                     if(!Ext.isNumber(c.width)){\r
 252                         c.width = perCol;\r
 253                     }\r
 254                 }\r
 255             }\r
 256         }\r
 257         Ext.ListView.superclass.initComponent.call(this);\r
 258     },\r
 259 \r
 260     onRender : function(){\r
 261         Ext.ListView.superclass.onRender.apply(this, arguments);\r
 262 \r
 263         this.internalTpl.overwrite(this.el, {columns: this.columns});\r
 264         \r
 265         this.innerBody = Ext.get(this.el.dom.childNodes[1].firstChild);\r
 266         this.innerHd = Ext.get(this.el.dom.firstChild.firstChild);\r
 267 \r
 268         if(this.hideHeaders){\r
 269             this.el.dom.firstChild.style.display = 'none';\r
 270         }\r
 271     },\r
 272 \r
 273     getTemplateTarget : function(){\r
 274         return this.innerBody;\r
 275     },\r
 276 \r
 277     <div id="method-Ext.ListView-collectData"></div>/**\r
 278      * <p>Function which can be overridden which returns the data object passed to this\r
 279      * view's {@link #tpl template} to render the whole ListView. The returned object \r
 280      * shall contain the following properties:</p>\r
 281      * <div class="mdetail-params"><ul>\r
 282      * <li><b>columns</b> : String<div class="sub-desc">See <tt>{@link #columns}</tt></div></li>\r
 283      * <li><b>rows</b> : String<div class="sub-desc">See\r
 284      * <tt>{@link Ext.DataView}.{@link Ext.DataView#collectData collectData}</div></li>\r
 285      * </ul></div>\r
 286      * @param {Array} records An Array of {@link Ext.data.Record}s to be rendered into the DataView.\r
 287      * @param {Number} startIndex the index number of the Record being prepared for rendering.\r
 288      * @return {Object} A data object containing properties to be processed by a repeating\r
 289      * XTemplate as described above.\r
 290      */\r
 291     collectData : function(){\r
 292         var rs = Ext.ListView.superclass.collectData.apply(this, arguments);\r
 293         return {\r
 294             columns: this.columns,\r
 295             rows: rs\r
 296         }\r
 297     },\r
 298 \r
 299     verifyInternalSize : function(){\r
 300         if(this.lastSize){\r
 301             this.onResize(this.lastSize.width, this.lastSize.height);\r
 302         }\r
 303     },\r
 304 \r
 305     // private\r
 306     onResize : function(w, h){\r
 307         var bd = this.innerBody.dom;\r
 308         var hd = this.innerHd.dom\r
 309         if(!bd){\r
 310             return;\r
 311         }\r
 312         var bdp = bd.parentNode;\r
 313         if(Ext.isNumber(w)){\r
 314             var sw = w - this.scrollOffset;\r
 315             if(this.reserveScrollOffset || ((bdp.offsetWidth - bdp.clientWidth) > 10)){\r
 316                 bd.style.width = sw + 'px';\r
 317                 hd.style.width = sw + 'px';\r
 318             }else{\r
 319                 bd.style.width = w + 'px';\r
 320                 hd.style.width = w + 'px';\r
 321                 setTimeout(function(){\r
 322                     if((bdp.offsetWidth - bdp.clientWidth) > 10){\r
 323                         bd.style.width = sw + 'px';\r
 324                         hd.style.width = sw + 'px';\r
 325                     }\r
 326                 }, 10);\r
 327             }\r
 328         }\r
 329         if(Ext.isNumber(h == 'number')){\r
 330             bdp.style.height = (h - hd.parentNode.offsetHeight) + 'px';\r
 331         }\r
 332     },\r
 333 \r
 334     updateIndexes : function(){\r
 335         Ext.ListView.superclass.updateIndexes.apply(this, arguments);\r
 336         this.verifyInternalSize();\r
 337     },\r
 338 \r
 339     findHeaderIndex : function(hd){\r
 340         hd = hd.dom || hd;\r
 341         var pn = hd.parentNode, cs = pn.parentNode.childNodes;\r
 342         for(var i = 0, c; c = cs[i]; i++){\r
 343             if(c == pn){\r
 344                 return i;\r
 345             }\r
 346         }\r
 347         return -1;\r
 348     },\r
 349 \r
 350     setHdWidths : function(){\r
 351         var els = this.innerHd.dom.getElementsByTagName('div');\r
 352         for(var i = 0, cs = this.columns, len = cs.length; i < len; i++){\r
 353             els[i].style.width = cs[i].width + '%';\r
 354         }\r
 355     }\r
 356 });\r
 357 \r
 358 Ext.reg('listview', Ext.ListView);</pre>    \r
 359 </body>\r
 360 </html>