3 * Copyright(c) 2006-2010 Sencha Inc.
5 * http://www.sencha.com/license
9 * @extends Ext.BoxComponent
10 * A mechanism for displaying data using custom layout templates and formatting. DataView uses an {@link Ext.XTemplate}
11 * as its internal templating mechanism, and is bound to an {@link Ext.data.Store}
12 * so that as the data in the store changes the view is automatically updated to reflect the changes. The view also
13 * provides built-in behavior for many common events that can occur for its contained items including click, doubleclick,
14 * mouseover, mouseout, etc. as well as a built-in selection model. <b>In order to use these features, an {@link #itemSelector}
15 * config must be provided for the DataView to determine what nodes it will be working with.</b>
17 * <p>The example below binds a DataView to a {@link Ext.data.Store} and renders it into an {@link Ext.Panel}.</p>
19 var store = new Ext.data.JsonStore({
20 url: 'get-images.php',
24 {name:'size', type: 'float'},
25 {name:'lastmod', type:'date', dateFormat:'timestamp'}
30 var tpl = new Ext.XTemplate(
31 '<tpl for=".">',
32 '<div class="thumb-wrap" id="{name}">',
33 '<div class="thumb"><img src="{url}" title="{name}"></div>',
34 '<span class="x-editable">{shortName}</span></div>',
36 '<div class="x-clear"></div>'
39 var panel = new Ext.Panel({
46 title:'Simple DataView',
48 items: new Ext.DataView({
53 overClass:'x-view-over',
54 itemSelector:'div.thumb-wrap',
55 emptyText: 'No images to display'
58 panel.render(document.body);
61 * Create a new DataView
62 * @param {Object} config The config object
65 Ext.DataView = Ext.extend(Ext.BoxComponent, {
67 * @cfg {String/Array} tpl
68 * The HTML fragment or an array of fragments that will make up the template used by this DataView. This should
69 * be specified in the same format expected by the constructor of {@link Ext.XTemplate}.
72 * @cfg {Ext.data.Store} store
73 * The {@link Ext.data.Store} to bind this DataView to.
76 * @cfg {String} itemSelector
77 * <b>This is a required setting</b>. A simple CSS selector (e.g. <tt>div.some-class</tt> or
78 * <tt>span:first-child</tt>) that will be used to determine what nodes this DataView will be
82 * @cfg {Boolean} multiSelect
83 * True to allow selection of more than one item at a time, false to allow selection of only a single item
84 * at a time or no selection at all, depending on the value of {@link #singleSelect} (defaults to false).
87 * @cfg {Boolean} singleSelect
88 * True to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false).
89 * Note that if {@link #multiSelect} = true, this value will be ignored.
92 * @cfg {Boolean} simpleSelect
93 * True to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl,
94 * false to force the user to hold Ctrl or Shift to select more than on item (defaults to false).
97 * @cfg {String} overClass
98 * A CSS class to apply to each item in the view on mouseover (defaults to undefined).
101 * @cfg {String} loadingText
102 * A string to display during data load operations (defaults to undefined). If specified, this text will be
103 * displayed in a loading div and the view's contents will be cleared while loading, otherwise the view's
104 * contents will continue to display normally until the new data is loaded and the contents are replaced.
107 * @cfg {String} selectedClass
108 * A CSS class to apply to each selected item in the view (defaults to 'x-view-selected').
110 selectedClass : "x-view-selected",
112 * @cfg {String} emptyText
113 * The text to display in the view when there is no data to display (defaults to '').
118 * @cfg {Boolean} deferEmptyText True to defer emptyText being applied until the store's first load
120 deferEmptyText: true,
122 * @cfg {Boolean} trackOver True to enable mouseenter and mouseleave events
127 * @cfg {Boolean} blockRefresh Set this to true to ignore datachanged events on the bound store. This is useful if
128 * you wish to provide custom transition animations via a plugin (defaults to false)
136 initComponent : function(){
137 Ext.DataView.superclass.initComponent.call(this);
138 if(Ext.isString(this.tpl) || Ext.isArray(this.tpl)){
139 this.tpl = new Ext.XTemplate(this.tpl);
145 * Fires before a click is processed. Returns false to cancel the default action.
146 * @param {Ext.DataView} this
147 * @param {Number} index The index of the target node
148 * @param {HTMLElement} node The target node
149 * @param {Ext.EventObject} e The raw event object
154 * Fires when a template node is clicked.
155 * @param {Ext.DataView} this
156 * @param {Number} index The index of the target node
157 * @param {HTMLElement} node The target node
158 * @param {Ext.EventObject} e The raw event object
163 * Fires when the mouse enters a template node. trackOver:true or an overClass must be set to enable this event.
164 * @param {Ext.DataView} this
165 * @param {Number} index The index of the target node
166 * @param {HTMLElement} node The target node
167 * @param {Ext.EventObject} e The raw event object
172 * Fires when the mouse leaves a template node. trackOver:true or an overClass must be set to enable this event.
173 * @param {Ext.DataView} this
174 * @param {Number} index The index of the target node
175 * @param {HTMLElement} node The target node
176 * @param {Ext.EventObject} e The raw event object
180 * @event containerclick
181 * Fires when a click occurs and it is not on a template node.
182 * @param {Ext.DataView} this
183 * @param {Ext.EventObject} e The raw event object
188 * Fires when a template node is double clicked.
189 * @param {Ext.DataView} this
190 * @param {Number} index The index of the target node
191 * @param {HTMLElement} node The target node
192 * @param {Ext.EventObject} e The raw event object
197 * Fires when a template node is right clicked.
198 * @param {Ext.DataView} this
199 * @param {Number} index The index of the target node
200 * @param {HTMLElement} node The target node
201 * @param {Ext.EventObject} e The raw event object
205 * @event containercontextmenu
206 * Fires when a right click occurs that is not on a template node.
207 * @param {Ext.DataView} this
208 * @param {Ext.EventObject} e The raw event object
210 "containercontextmenu",
212 * @event selectionchange
213 * Fires when the selected nodes change.
214 * @param {Ext.DataView} this
215 * @param {Array} selections Array of the selected nodes
220 * @event beforeselect
221 * Fires before a selection is made. If any handlers return false, the selection is cancelled.
222 * @param {Ext.DataView} this
223 * @param {HTMLElement} node The node to be selected
224 * @param {Array} selections Array of currently selected nodes
229 this.store = Ext.StoreMgr.lookup(this.store);
230 this.all = new Ext.CompositeElementLite();
231 this.selected = new Ext.CompositeElementLite();
235 afterRender : function(){
236 Ext.DataView.superclass.afterRender.call(this);
238 this.mon(this.getTemplateTarget(), {
239 "click": this.onClick,
240 "dblclick": this.onDblClick,
241 "contextmenu": this.onContextMenu,
245 if(this.overClass || this.trackOver){
246 this.mon(this.getTemplateTarget(), {
247 "mouseover": this.onMouseOver,
248 "mouseout": this.onMouseOut,
254 this.bindStore(this.store, true);
259 * Refreshes the view by reloading the data from the store and re-rendering the template.
261 refresh : function() {
262 this.clearSelections(false, true);
263 var el = this.getTemplateTarget(),
264 records = this.store.getRange();
267 if(records.length < 1){
268 if(!this.deferEmptyText || this.hasSkippedEmptyText){
269 el.update(this.emptyText);
273 this.tpl.overwrite(el, this.collectData(records, 0));
274 this.all.fill(Ext.query(this.itemSelector, el.dom));
275 this.updateIndexes(0);
277 this.hasSkippedEmptyText = true;
280 getTemplateTarget: function(){
285 * Function which can be overridden to provide custom formatting for each Record that is used by this
286 * DataView's {@link #tpl template} to render each node.
287 * @param {Array/Object} data The raw data object that was used to create the Record.
288 * @param {Number} recordIndex the index number of the Record being prepared for rendering.
289 * @param {Record} record The Record being prepared for rendering.
290 * @return {Array/Object} The formatted data in a format expected by the internal {@link #tpl template}'s overwrite() method.
291 * (either an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}))
293 prepareData : function(data){
298 * <p>Function which can be overridden which returns the data object passed to this
299 * DataView's {@link #tpl template} to render the whole DataView.</p>
300 * <p>This is usually an Array of data objects, each element of which is processed by an
301 * {@link Ext.XTemplate XTemplate} which uses <tt>'<tpl for=".">'</tt> to iterate over its supplied
302 * data object as an Array. However, <i>named</i> properties may be placed into the data object to
303 * provide non-repeating data such as headings, totals etc.</p>
304 * @param {Array} records An Array of {@link Ext.data.Record}s to be rendered into the DataView.
305 * @param {Number} startIndex the index number of the Record being prepared for rendering.
306 * @return {Array} An Array of data objects to be processed by a repeating XTemplate. May also
307 * contain <i>named</i> properties.
309 collectData : function(records, startIndex){
312 len = records.length;
314 r[r.length] = this.prepareData(records[i].data, startIndex + i, records[i]);
320 bufferRender : function(records, index){
321 var div = document.createElement('div');
322 this.tpl.overwrite(div, this.collectData(records, index));
323 return Ext.query(this.itemSelector, div);
327 onUpdate : function(ds, record){
328 var index = this.store.indexOf(record);
330 var sel = this.isSelected(index),
331 original = this.all.elements[index],
332 node = this.bufferRender([record], index)[0];
334 this.all.replaceElement(index, node, true);
336 this.selected.replaceElement(original, node);
337 this.all.item(index).addClass(this.selectedClass);
339 this.updateIndexes(index, index);
344 onAdd : function(ds, records, index){
345 if(this.all.getCount() === 0){
349 var nodes = this.bufferRender(records, index), n, a = this.all.elements;
350 if(index < this.all.getCount()){
351 n = this.all.item(index).insertSibling(nodes, 'before', true);
352 a.splice.apply(a, [index, 0].concat(nodes));
354 n = this.all.last().insertSibling(nodes, 'after', true);
355 a.push.apply(a, nodes);
357 this.updateIndexes(index);
361 onRemove : function(ds, record, index){
362 this.deselect(index);
363 this.all.removeElement(index, true);
364 this.updateIndexes(index);
365 if (this.store.getCount() === 0){
371 * Refreshes an individual node's data from the store.
372 * @param {Number} index The item's data index in the store
374 refreshNode : function(index){
375 this.onUpdate(this.store, this.store.getAt(index));
379 updateIndexes : function(startIndex, endIndex){
380 var ns = this.all.elements;
381 startIndex = startIndex || 0;
382 endIndex = endIndex || ((endIndex === 0) ? 0 : (ns.length - 1));
383 for(var i = startIndex; i <= endIndex; i++){
389 * Returns the store associated with this DataView.
390 * @return {Ext.data.Store} The store
392 getStore : function(){
397 * Changes the data store bound to this view and refreshes it.
398 * @param {Store} store The store to bind to this view
400 bindStore : function(store, initial){
401 if(!initial && this.store){
402 if(store !== this.store && this.store.autoDestroy){
403 this.store.destroy();
405 this.store.un("beforeload", this.onBeforeLoad, this);
406 this.store.un("datachanged", this.onDataChanged, this);
407 this.store.un("add", this.onAdd, this);
408 this.store.un("remove", this.onRemove, this);
409 this.store.un("update", this.onUpdate, this);
410 this.store.un("clear", this.refresh, this);
417 store = Ext.StoreMgr.lookup(store);
420 beforeload: this.onBeforeLoad,
421 datachanged: this.onDataChanged,
423 remove: this.onRemove,
424 update: this.onUpdate,
436 * Calls this.refresh if this.blockRefresh is not true
438 onDataChanged: function() {
439 if (this.blockRefresh !== true) {
440 this.refresh.apply(this, arguments);
445 * Returns the template node the passed child belongs to, or null if it doesn't belong to one.
446 * @param {HTMLElement} node
447 * @return {HTMLElement} The template node
449 findItemFromChild : function(node){
450 return Ext.fly(node).findParent(this.itemSelector, this.getTemplateTarget());
454 onClick : function(e){
455 var item = e.getTarget(this.itemSelector, this.getTemplateTarget()),
458 index = this.indexOf(item);
459 if(this.onItemClick(item, index, e) !== false){
460 this.fireEvent("click", this, index, item, e);
463 if(this.fireEvent("containerclick", this, e) !== false){
464 this.onContainerClick(e);
469 onContainerClick : function(e){
470 this.clearSelections();
474 onContextMenu : function(e){
475 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
477 this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
479 this.fireEvent("containercontextmenu", this, e);
484 onDblClick : function(e){
485 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
487 this.fireEvent("dblclick", this, this.indexOf(item), item, e);
492 onMouseOver : function(e){
493 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
494 if(item && item !== this.lastItem){
495 this.lastItem = item;
496 Ext.fly(item).addClass(this.overClass);
497 this.fireEvent("mouseenter", this, this.indexOf(item), item, e);
502 onMouseOut : function(e){
504 if(!e.within(this.lastItem, true, true)){
505 Ext.fly(this.lastItem).removeClass(this.overClass);
506 this.fireEvent("mouseleave", this, this.indexOf(this.lastItem), this.lastItem, e);
507 delete this.lastItem;
513 onItemClick : function(item, index, e){
514 if(this.fireEvent("beforeclick", this, index, item, e) === false){
517 if(this.multiSelect){
518 this.doMultiSelection(item, index, e);
520 }else if(this.singleSelect){
521 this.doSingleSelection(item, index, e);
528 doSingleSelection : function(item, index, e){
529 if(e.ctrlKey && this.isSelected(index)){
530 this.deselect(index);
532 this.select(index, false);
537 doMultiSelection : function(item, index, e){
538 if(e.shiftKey && this.last !== false){
539 var last = this.last;
540 this.selectRange(last, index, e.ctrlKey);
541 this.last = last; // reset the last
543 if((e.ctrlKey||this.simpleSelect) && this.isSelected(index)){
544 this.deselect(index);
546 this.select(index, e.ctrlKey || e.shiftKey || this.simpleSelect);
552 * Gets the number of selected nodes.
553 * @return {Number} The node count
555 getSelectionCount : function(){
556 return this.selected.getCount();
560 * Gets the currently selected nodes.
561 * @return {Array} An array of HTMLElements
563 getSelectedNodes : function(){
564 return this.selected.elements;
568 * Gets the indexes of the selected nodes.
569 * @return {Array} An array of numeric indexes
571 getSelectedIndexes : function(){
573 selected = this.selected.elements,
575 len = selected.length;
578 indexes.push(selected[i].viewIndex);
584 * Gets an array of the selected records
585 * @return {Array} An array of {@link Ext.data.Record} objects
587 getSelectedRecords : function(){
588 return this.getRecords(this.selected.elements);
592 * Gets an array of the records from an array of nodes
593 * @param {Array} nodes The nodes to evaluate
594 * @return {Array} records The {@link Ext.data.Record} objects
596 getRecords : function(nodes){
602 records[records.length] = this.store.getAt(nodes[i].viewIndex);
608 * Gets a record from a node
609 * @param {HTMLElement} node The node to evaluate
610 * @return {Record} record The {@link Ext.data.Record} object
612 getRecord : function(node){
613 return this.store.getAt(node.viewIndex);
617 * Clears all selections.
618 * @param {Boolean} suppressEvent (optional) True to skip firing of the selectionchange event
620 clearSelections : function(suppressEvent, skipUpdate){
621 if((this.multiSelect || this.singleSelect) && this.selected.getCount() > 0){
623 this.selected.removeClass(this.selectedClass);
625 this.selected.clear();
628 this.fireEvent("selectionchange", this, this.selected.elements);
634 * Returns true if the passed node is selected, else false.
635 * @param {HTMLElement/Number/Ext.data.Record} node The node, node index or record to check
636 * @return {Boolean} True if selected, else false
638 isSelected : function(node){
639 return this.selected.contains(this.getNode(node));
644 * @param {HTMLElement/Number/Record} node The node, node index or record to deselect
646 deselect : function(node){
647 if(this.isSelected(node)){
648 node = this.getNode(node);
649 this.selected.removeElement(node);
650 if(this.last == node.viewIndex){
653 Ext.fly(node).removeClass(this.selectedClass);
654 this.fireEvent("selectionchange", this, this.selected.elements);
659 * Selects a set of nodes.
660 * @param {Array/HTMLElement/String/Number/Ext.data.Record} nodeInfo An HTMLElement template node, index of a template node,
661 * id of a template node, record associated with a node or an array of any of those to select
662 * @param {Boolean} keepExisting (optional) true to keep existing selections
663 * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
665 select : function(nodeInfo, keepExisting, suppressEvent){
666 if(Ext.isArray(nodeInfo)){
668 this.clearSelections(true);
670 for(var i = 0, len = nodeInfo.length; i < len; i++){
671 this.select(nodeInfo[i], true, true);
674 this.fireEvent("selectionchange", this, this.selected.elements);
677 var node = this.getNode(nodeInfo);
679 this.clearSelections(true);
681 if(node && !this.isSelected(node)){
682 if(this.fireEvent("beforeselect", this, node, this.selected.elements) !== false){
683 Ext.fly(node).addClass(this.selectedClass);
684 this.selected.add(node);
685 this.last = node.viewIndex;
687 this.fireEvent("selectionchange", this, this.selected.elements);
695 * Selects a range of nodes. All nodes between start and end are selected.
696 * @param {Number} start The index of the first node in the range
697 * @param {Number} end The index of the last node in the range
698 * @param {Boolean} keepExisting (optional) True to retain existing selections
700 selectRange : function(start, end, keepExisting){
702 this.clearSelections(true);
704 this.select(this.getNodes(start, end), true);
708 * Gets a template node.
709 * @param {HTMLElement/String/Number/Ext.data.Record} nodeInfo An HTMLElement template node, index of a template node,
710 * the id of a template node or the record associated with the node.
711 * @return {HTMLElement} The node or null if it wasn't found
713 getNode : function(nodeInfo){
714 if(Ext.isString(nodeInfo)){
715 return document.getElementById(nodeInfo);
716 }else if(Ext.isNumber(nodeInfo)){
717 return this.all.elements[nodeInfo];
718 }else if(nodeInfo instanceof Ext.data.Record){
719 var idx = this.store.indexOf(nodeInfo);
720 return this.all.elements[idx];
726 * Gets a range nodes.
727 * @param {Number} start (optional) The index of the first node in the range
728 * @param {Number} end (optional) The index of the last node in the range
729 * @return {Array} An array of nodes
731 getNodes : function(start, end){
732 var ns = this.all.elements,
737 end = !Ext.isDefined(end) ? Math.max(ns.length - 1, 0) : end;
739 for(i = start; i <= end && ns[i]; i++){
743 for(i = start; i >= end && ns[i]; i--){
751 * Finds the index of the passed node.
752 * @param {HTMLElement/String/Number/Record} nodeInfo An HTMLElement template node, index of a template node, the id of a template node
753 * or a record associated with a node.
754 * @return {Number} The index of the node or -1
756 indexOf : function(node){
757 node = this.getNode(node);
758 if(Ext.isNumber(node.viewIndex)){
759 return node.viewIndex;
761 return this.all.indexOf(node);
765 onBeforeLoad : function(){
766 if(this.loadingText){
767 this.clearSelections(false, true);
768 this.getTemplateTarget().update('<div class="loading-indicator">'+this.loadingText+'</div>');
773 onDestroy : function(){
775 this.selected.clear();
776 Ext.DataView.superclass.onDestroy.call(this);
777 this.bindStore(null);
782 * Changes the data store bound to this view and refreshes it. (deprecated in favor of bindStore)
783 * @param {Store} store The store to bind to this view
785 Ext.DataView.prototype.setStore = Ext.DataView.prototype.bindStore;
787 Ext.reg('dataview', Ext.DataView);
789 * @class Ext.list.ListView
790 * @extends Ext.DataView
791 * <p>Ext.list.ListView is a fast and light-weight implentation of a
792 * {@link Ext.grid.GridPanel Grid} like view with the following characteristics:</p>
793 * <div class="mdetail-params"><ul>
794 * <li>resizable columns</li>
795 * <li>selectable</li>
796 * <li>column widths are initially proportioned by percentage based on the container
797 * width and number of columns</li>
798 * <li>uses templates to render the data in any required format</li>
799 * <li>no horizontal scrolling</li>
800 * <li>no editing</li>
802 * <p>Example usage:</p>
804 // consume JSON of this form:
808 "name":"dance_fever.jpg",
810 "lastmod":1236974993000,
811 "url":"images\/thumbs\/dance_fever.jpg"
814 "name":"zack_sink.jpg",
816 "lastmod":1236974993000,
817 "url":"images\/thumbs\/zack_sink.jpg"
821 var store = new Ext.data.JsonStore({
822 url: 'get-images.php',
826 {name:'size', type: 'float'},
827 {name:'lastmod', type:'date', dateFormat:'timestamp'}
832 var listView = new Ext.list.ListView({
835 emptyText: 'No images to display',
836 reserveScrollOffset: true,
842 header: 'Last Modified',
844 dataIndex: 'lastmod',
845 tpl: '{lastmod:date("m-d h:i a")}'
849 tpl: '{size:fileSize}', // format using Ext.util.Format.fileSize()
854 // put it in a Panel so it looks pretty
855 var panel = new Ext.Panel({
861 title:'Simple ListView <i>(0 items selected)</i>',
864 panel.render(document.body);
866 // little bit of feedback
867 listView.on('selectionchange', function(view, nodes){
868 var l = nodes.length;
869 var s = l != 1 ? 's' : '';
870 panel.setTitle('Simple ListView <i>('+l+' item'+s+' selected)</i>');
874 * @param {Object} config
877 Ext.list.ListView = Ext.extend(Ext.DataView, {
879 * Set this property to <tt>true</tt> to disable the header click handler disabling sort
880 * (defaults to <tt>false</tt>).
882 * @property disableHeaders
885 * @cfg {Boolean} hideHeaders
886 * <tt>true</tt> to hide the {@link #internalTpl header row} (defaults to <tt>false</tt> so
887 * the {@link #internalTpl header row} will be shown).
890 * @cfg {String} itemSelector
891 * Defaults to <tt>'dl'</tt> to work with the preconfigured <b><tt>{@link Ext.DataView#tpl tpl}</tt></b>.
892 * This setting specifies the CSS selector (e.g. <tt>div.some-class</tt> or <tt>span:first-child</tt>)
893 * that will be used to determine what nodes the ListView will be working with.
897 * @cfg {String} selectedClass The CSS class applied to a selected row (defaults to
898 * <tt>'x-list-selected'</tt>). An example overriding the default styling:
900 .x-list-selected {background-color: yellow;}
904 selectedClass:'x-list-selected',
906 * @cfg {String} overClass The CSS class applied when over a row (defaults to
907 * <tt>'x-list-over'</tt>). An example overriding the default styling:
909 .x-list-over {background-color: orange;}
913 overClass:'x-list-over',
915 * @cfg {Boolean} reserveScrollOffset
916 * By default will defer accounting for the configured <b><tt>{@link #scrollOffset}</tt></b>
917 * for 10 milliseconds. Specify <tt>true</tt> to account for the configured
918 * <b><tt>{@link #scrollOffset}</tt></b> immediately.
921 * @cfg {Number} scrollOffset The amount of space to reserve for the scrollbar (defaults to
922 * <tt>undefined</tt>). If an explicit value isn't specified, this will be automatically
925 scrollOffset : undefined,
927 * @cfg {Boolean/Object} columnResize
928 * Specify <tt>true</tt> or specify a configuration object for {@link Ext.list.ListView.ColumnResizer}
929 * to enable the columns to be resizable (defaults to <tt>true</tt>).
933 * @cfg {Array} columns An array of column configuration objects, for example:
939 tpl: '{size:fileSize}',
943 * Acceptable properties for each column configuration object are:
944 * <div class="mdetail-params"><ul>
945 * <li><b><tt>align</tt></b> : String<div class="sub-desc">Set the CSS text-align property
946 * of the column. Defaults to <tt>'left'</tt>.</div></li>
947 * <li><b><tt>dataIndex</tt></b> : String<div class="sub-desc">See {@link Ext.grid.Column}.
948 * {@link Ext.grid.Column#dataIndex dataIndex} for details.</div></li>
949 * <li><b><tt>header</tt></b> : String<div class="sub-desc">See {@link Ext.grid.Column}.
950 * {@link Ext.grid.Column#header header} for details.</div></li>
951 * <li><b><tt>tpl</tt></b> : String<div class="sub-desc">Specify a string to pass as the
952 * configuration string for {@link Ext.XTemplate}. By default an {@link Ext.XTemplate}
953 * will be implicitly created using the <tt>dataIndex</tt>.</div></li>
954 * <li><b><tt>width</tt></b> : Number<div class="sub-desc">Percentage of the container width
955 * this column should be allocated. Columns that have no width specified will be
956 * allocated with an equal percentage to fill 100% of the container width. To easily take
957 * advantage of the full container width, leave the width of at least one column undefined.
958 * Note that if you do not want to take up the full width of the container, the width of
959 * every column needs to be explicitly defined.</div></li>
963 * @cfg {Boolean/Object} columnSort
964 * Specify <tt>true</tt> or specify a configuration object for {@link Ext.list.ListView.Sorter}
965 * to enable the columns to be sortable (defaults to <tt>true</tt>).
969 * @cfg {String/Array} internalTpl
970 * The template to be used for the header row. See {@link #tpl} for more details.
974 * IE has issues when setting percentage based widths to 100%. Default to 99.
976 maxColumnWidth: Ext.isIE ? 99 : 100,
978 initComponent : function(){
979 if(this.columnResize){
980 this.colResizer = new Ext.list.ColumnResizer(this.colResizer);
981 this.colResizer.init(this);
984 this.colSorter = new Ext.list.Sorter(this.columnSort);
985 this.colSorter.init(this);
987 if(!this.internalTpl){
988 this.internalTpl = new Ext.XTemplate(
989 '<div class="x-list-header"><div class="x-list-header-inner">',
990 '<tpl for="columns">',
991 '<div style="width:{[values.width*100]}%;text-align:{align};"><em unselectable="on" id="',this.id, '-xlhd-{#}">',
995 '<div class="x-clear"></div>',
997 '<div class="x-list-body"><div class="x-list-body-inner">',
1002 this.tpl = new Ext.XTemplate(
1005 '<tpl for="parent.columns">',
1006 '<dt style="width:{[values.width*100]}%;text-align:{align};">',
1007 '<em unselectable="on"<tpl if="cls"> class="{cls}</tpl>">',
1008 '{[values.tpl.apply(parent)]}',
1011 '<div class="x-clear"></div>',
1017 var cs = this.columns,
1023 for(var i = 0; i < len; i++){
1026 c.xtype = c.xtype ? (/^lv/.test(c.xtype) ? c.xtype : 'lv' + c.xtype) : 'lvcolumn';
1030 allocatedWidth += c.width*100;
1031 if(allocatedWidth > this.maxColumnWidth){
1032 c.width -= (allocatedWidth - this.maxColumnWidth) / 100;
1039 cs = this.columns = columns;
1041 // auto calculate missing column widths
1042 if(colsWithWidth < len){
1043 var remaining = len - colsWithWidth;
1044 if(allocatedWidth < this.maxColumnWidth){
1045 var perCol = ((this.maxColumnWidth-allocatedWidth) / remaining)/100;
1046 for(var j = 0; j < len; j++){
1054 Ext.list.ListView.superclass.initComponent.call(this);
1057 onRender : function(){
1061 Ext.list.ListView.superclass.onRender.apply(this, arguments);
1063 this.internalTpl.overwrite(this.el, {columns: this.columns});
1065 this.innerBody = Ext.get(this.el.dom.childNodes[1].firstChild);
1066 this.innerHd = Ext.get(this.el.dom.firstChild.firstChild);
1068 if(this.hideHeaders){
1069 this.el.dom.firstChild.style.display = 'none';
1073 getTemplateTarget : function(){
1074 return this.innerBody;
1078 * <p>Function which can be overridden which returns the data object passed to this
1079 * view's {@link #tpl template} to render the whole ListView. The returned object
1080 * shall contain the following properties:</p>
1081 * <div class="mdetail-params"><ul>
1082 * <li><b>columns</b> : String<div class="sub-desc">See <tt>{@link #columns}</tt></div></li>
1083 * <li><b>rows</b> : String<div class="sub-desc">See
1084 * <tt>{@link Ext.DataView}.{@link Ext.DataView#collectData collectData}</div></li>
1086 * @param {Array} records An Array of {@link Ext.data.Record}s to be rendered into the DataView.
1087 * @param {Number} startIndex the index number of the Record being prepared for rendering.
1088 * @return {Object} A data object containing properties to be processed by a repeating
1089 * XTemplate as described above.
1091 collectData : function(){
1092 var rs = Ext.list.ListView.superclass.collectData.apply(this, arguments);
1094 columns: this.columns,
1099 verifyInternalSize : function(){
1101 this.onResize(this.lastSize.width, this.lastSize.height);
1106 onResize : function(w, h){
1107 var body = this.innerBody.dom,
1108 header = this.innerHd.dom,
1109 scrollWidth = w - Ext.num(this.scrollOffset, Ext.getScrollBarWidth()) + 'px',
1115 parentNode = body.parentNode;
1116 if(Ext.isNumber(w)){
1117 if(this.reserveScrollOffset || ((parentNode.offsetWidth - parentNode.clientWidth) > 10)){
1118 body.style.width = scrollWidth;
1119 header.style.width = scrollWidth;
1121 body.style.width = w + 'px';
1122 header.style.width = w + 'px';
1123 setTimeout(function(){
1124 if((parentNode.offsetWidth - parentNode.clientWidth) > 10){
1125 body.style.width = scrollWidth;
1126 header.style.width = scrollWidth;
1131 if(Ext.isNumber(h)){
1132 parentNode.style.height = Math.max(0, h - header.parentNode.offsetHeight) + 'px';
1136 updateIndexes : function(){
1137 Ext.list.ListView.superclass.updateIndexes.apply(this, arguments);
1138 this.verifyInternalSize();
1141 findHeaderIndex : function(header){
1142 header = header.dom || header;
1143 var parentNode = header.parentNode,
1144 children = parentNode.parentNode.childNodes,
1147 for(; c = children[i]; i++){
1148 if(c == parentNode){
1155 setHdWidths : function(){
1156 var els = this.innerHd.dom.getElementsByTagName('div'),
1158 columns = this.columns,
1159 len = columns.length;
1161 for(; i < len; i++){
1162 els[i].style.width = (columns[i].width*100) + '%';
1167 Ext.reg('listview', Ext.list.ListView);
1169 // Backwards compatibility alias
1170 Ext.ListView = Ext.list.ListView;/**
1171 * @class Ext.list.Column
1172 * <p>This class encapsulates column configuration data to be used in the initialization of a
1173 * {@link Ext.list.ListView ListView}.</p>
1174 * <p>While subclasses are provided to render data in different ways, this class renders a passed
1175 * data field unchanged and is usually used for textual columns.</p>
1177 Ext.list.Column = Ext.extend(Object, {
1180 * @cfg {Boolean} isColumn
1181 * Used by ListView constructor method to avoid reprocessing a Column
1182 * if <code>isColumn</code> is not set ListView will recreate a new Ext.list.Column
1188 * @cfg {String} align
1189 * Set the CSS text-align property of the column. Defaults to <tt>'left'</tt>.
1193 * @cfg {String} header Optional. The header text to be used as innerHTML
1194 * (html tags are accepted) to display in the ListView. <b>Note</b>: to
1195 * have a clickable header with no text displayed use <tt>' '</tt>.
1200 * @cfg {Number} width Optional. Percentage of the container width
1201 * this column should be allocated. Columns that have no width specified will be
1202 * allocated with an equal percentage to fill 100% of the container width. To easily take
1203 * advantage of the full container width, leave the width of at least one column undefined.
1204 * Note that if you do not want to take up the full width of the container, the width of
1205 * every column needs to be explicitly defined.
1210 * @cfg {String} cls Optional. This option can be used to add a CSS class to the cell of each
1211 * row for this column.
1216 * @cfg {String} tpl Optional. Specify a string to pass as the
1217 * configuration string for {@link Ext.XTemplate}. By default an {@link Ext.XTemplate}
1218 * will be implicitly created using the <tt>dataIndex</tt>.
1222 * @cfg {String} dataIndex <p><b>Required</b>. The name of the field in the
1223 * ListViews's {@link Ext.data.Store}'s {@link Ext.data.Record} definition from
1224 * which to draw the column's value.</p>
1227 constructor : function(c){
1229 c.tpl = new Ext.XTemplate('{' + c.dataIndex + '}');
1231 else if(Ext.isString(c.tpl)){
1232 c.tpl = new Ext.XTemplate(c.tpl);
1239 Ext.reg('lvcolumn', Ext.list.Column);
1242 * @class Ext.list.NumberColumn
1243 * @extends Ext.list.Column
1244 * <p>A Column definition class which renders a numeric data field according to a {@link #format} string. See the
1245 * {@link Ext.list.Column#xtype xtype} config option of {@link Ext.list.Column} for more details.</p>
1247 Ext.list.NumberColumn = Ext.extend(Ext.list.Column, {
1249 * @cfg {String} format
1250 * A formatting string as used by {@link Ext.util.Format#number} to format a numeric value for this Column
1251 * (defaults to <tt>'0,000.00'</tt>).
1255 constructor : function(c) {
1256 c.tpl = c.tpl || new Ext.XTemplate('{' + c.dataIndex + ':number("' + (c.format || this.format) + '")}');
1257 Ext.list.NumberColumn.superclass.constructor.call(this, c);
1261 Ext.reg('lvnumbercolumn', Ext.list.NumberColumn);
1264 * @class Ext.list.DateColumn
1265 * @extends Ext.list.Column
1266 * <p>A Column definition class which renders a passed date according to the default locale, or a configured
1267 * {@link #format}. See the {@link Ext.list.Column#xtype xtype} config option of {@link Ext.list.Column}
1268 * for more details.</p>
1270 Ext.list.DateColumn = Ext.extend(Ext.list.Column, {
1272 constructor : function(c) {
1273 c.tpl = c.tpl || new Ext.XTemplate('{' + c.dataIndex + ':date("' + (c.format || this.format) + '")}');
1274 Ext.list.DateColumn.superclass.constructor.call(this, c);
1277 Ext.reg('lvdatecolumn', Ext.list.DateColumn);
1280 * @class Ext.list.BooleanColumn
1281 * @extends Ext.list.Column
1282 * <p>A Column definition class which renders boolean data fields. See the {@link Ext.list.Column#xtype xtype}
1283 * config option of {@link Ext.list.Column} for more details.</p>
1285 Ext.list.BooleanColumn = Ext.extend(Ext.list.Column, {
1287 * @cfg {String} trueText
1288 * The string returned by the renderer when the column value is not falsey (defaults to <tt>'true'</tt>).
1292 * @cfg {String} falseText
1293 * The string returned by the renderer when the column value is falsey (but not undefined) (defaults to
1294 * <tt>'false'</tt>).
1298 * @cfg {String} undefinedText
1299 * The string returned by the renderer when the column value is undefined (defaults to <tt>' '</tt>).
1301 undefinedText: ' ',
1303 constructor : function(c) {
1304 c.tpl = c.tpl || new Ext.XTemplate('{' + c.dataIndex + ':this.format}');
1306 var t = this.trueText, f = this.falseText, u = this.undefinedText;
1307 c.tpl.format = function(v){
1308 if(v === undefined){
1311 if(!v || v === 'false'){
1317 Ext.list.DateColumn.superclass.constructor.call(this, c);
1321 Ext.reg('lvbooleancolumn', Ext.list.BooleanColumn);/**
1322 * @class Ext.list.ColumnResizer
1323 * @extends Ext.util.Observable
1324 * <p>Supporting Class for Ext.list.ListView</p>
1326 * @param {Object} config
1328 Ext.list.ColumnResizer = Ext.extend(Ext.util.Observable, {
1330 * @cfg {Number} minPct The minimum percentage to allot for any column (defaults to <tt>.05</tt>)
1334 constructor: function(config){
1335 Ext.apply(this, config);
1336 Ext.list.ColumnResizer.superclass.constructor.call(this);
1338 init : function(listView){
1339 this.view = listView;
1340 listView.on('render', this.initEvents, this);
1343 initEvents : function(view){
1344 view.mon(view.innerHd, 'mousemove', this.handleHdMove, this);
1345 this.tracker = new Ext.dd.DragTracker({
1346 onBeforeStart: this.onBeforeStart.createDelegate(this),
1347 onStart: this.onStart.createDelegate(this),
1348 onDrag: this.onDrag.createDelegate(this),
1349 onEnd: this.onEnd.createDelegate(this),
1353 this.tracker.initEl(view.innerHd);
1354 view.on('beforedestroy', this.tracker.destroy, this.tracker);
1357 handleHdMove : function(e, t){
1358 var handleWidth = 5,
1360 header = e.getTarget('em', 3, true);
1362 var region = header.getRegion(),
1363 style = header.dom.style,
1364 parentNode = header.dom.parentNode;
1366 if(x - region.left <= handleWidth && parentNode != parentNode.parentNode.firstChild){
1367 this.activeHd = Ext.get(parentNode.previousSibling.firstChild);
1368 style.cursor = Ext.isWebKit ? 'e-resize' : 'col-resize';
1369 } else if(region.right - x <= handleWidth && parentNode != parentNode.parentNode.lastChild.previousSibling){
1370 this.activeHd = header;
1371 style.cursor = Ext.isWebKit ? 'w-resize' : 'col-resize';
1373 delete this.activeHd;
1379 onBeforeStart : function(e){
1380 this.dragHd = this.activeHd;
1381 return !!this.dragHd;
1384 onStart: function(e){
1388 dragHeader = me.dragHd,
1389 x = me.tracker.getXY()[0];
1391 me.proxy = view.el.createChild({cls:'x-list-resizer'});
1392 me.dragX = dragHeader.getX();
1393 me.headerIndex = view.findHeaderIndex(dragHeader);
1395 me.headersDisabled = view.disableHeaders;
1396 view.disableHeaders = true;
1398 me.proxy.setHeight(view.el.getHeight());
1399 me.proxy.setX(me.dragX);
1400 me.proxy.setWidth(x - me.dragX);
1402 this.setBoundaries();
1406 // Sets up the boundaries for the drag/drop operation
1407 setBoundaries: function(relativeX){
1408 var view = this.view,
1409 headerIndex = this.headerIndex,
1410 width = view.innerHd.getWidth(),
1411 relativeX = view.innerHd.getX(),
1412 minWidth = Math.ceil(width * this.minPct),
1413 maxWidth = width - minWidth,
1414 numColumns = view.columns.length,
1415 headers = view.innerHd.select('em', true),
1416 minX = minWidth + relativeX,
1417 maxX = maxWidth + relativeX,
1420 if (numColumns == 2) {
1424 header = headers.item(headerIndex + 2);
1425 this.minX = headers.item(headerIndex).getX() + minWidth;
1426 this.maxX = header ? header.getX() - minWidth : maxX;
1427 if (headerIndex == 0) {
1430 } else if (headerIndex == numColumns - 2) {
1437 onDrag: function(e){
1439 cursorX = me.tracker.getXY()[0].constrain(me.minX, me.maxX);
1441 me.proxy.setWidth(cursorX - this.dragX);
1445 /* calculate desired width by measuring proxy and then remove it */
1446 var newWidth = this.proxy.getWidth(),
1447 index = this.headerIndex,
1449 columns = view.columns,
1450 width = view.innerHd.getWidth(),
1451 newPercent = Math.ceil(newWidth * view.maxColumnWidth / width) / 100,
1452 disabled = this.headersDisabled,
1453 headerCol = columns[index],
1454 otherCol = columns[index + 1],
1455 totalPercent = headerCol.width + otherCol.width;
1457 this.proxy.remove();
1459 headerCol.width = newPercent;
1460 otherCol.width = totalPercent - newPercent;
1466 setTimeout(function(){
1467 view.disableHeaders = disabled;
1472 // Backwards compatibility alias
1473 Ext.ListView.ColumnResizer = Ext.list.ColumnResizer;/**
1474 * @class Ext.list.Sorter
1475 * @extends Ext.util.Observable
1476 * <p>Supporting Class for Ext.list.ListView</p>
1478 * @param {Object} config
1480 Ext.list.Sorter = Ext.extend(Ext.util.Observable, {
1482 * @cfg {Array} sortClasses
1483 * The CSS classes applied to a header when it is sorted. (defaults to <tt>["sort-asc", "sort-desc"]</tt>)
1485 sortClasses : ["sort-asc", "sort-desc"],
1487 constructor: function(config){
1488 Ext.apply(this, config);
1489 Ext.list.Sorter.superclass.constructor.call(this);
1492 init : function(listView){
1493 this.view = listView;
1494 listView.on('render', this.initEvents, this);
1497 initEvents : function(view){
1498 view.mon(view.innerHd, 'click', this.onHdClick, this);
1499 view.innerHd.setStyle('cursor', 'pointer');
1500 view.mon(view.store, 'datachanged', this.updateSortState, this);
1501 this.updateSortState.defer(10, this, [view.store]);
1504 updateSortState : function(store){
1505 var state = store.getSortState();
1509 this.sortState = state;
1510 var cs = this.view.columns, sortColumn = -1;
1511 for(var i = 0, len = cs.length; i < len; i++){
1512 if(cs[i].dataIndex == state.field){
1517 if(sortColumn != -1){
1518 var sortDir = state.direction;
1519 this.updateSortIcon(sortColumn, sortDir);
1523 updateSortIcon : function(col, dir){
1524 var sc = this.sortClasses;
1525 var hds = this.view.innerHd.select('em').removeClass(sc);
1526 hds.item(col).addClass(sc[dir == "DESC" ? 1 : 0]);
1529 onHdClick : function(e){
1530 var hd = e.getTarget('em', 3);
1531 if(hd && !this.view.disableHeaders){
1532 var index = this.view.findHeaderIndex(hd);
1533 this.view.store.sort(this.view.columns[index].dataIndex);
1538 // Backwards compatibility alias
1539 Ext.ListView.Sorter = Ext.list.Sorter;