3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.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
130 initComponent : function(){
131 Ext.DataView.superclass.initComponent.call(this);
132 if(Ext.isString(this.tpl) || Ext.isArray(this.tpl)){
133 this.tpl = new Ext.XTemplate(this.tpl);
139 * Fires before a click is processed. Returns false to cancel the default action.
140 * @param {Ext.DataView} this
141 * @param {Number} index The index of the target node
142 * @param {HTMLElement} node The target node
143 * @param {Ext.EventObject} e The raw event object
148 * Fires when a template node is clicked.
149 * @param {Ext.DataView} this
150 * @param {Number} index The index of the target node
151 * @param {HTMLElement} node The target node
152 * @param {Ext.EventObject} e The raw event object
157 * Fires when the mouse enters a template node. trackOver:true or an overCls must be set to enable this event.
158 * @param {Ext.DataView} this
159 * @param {Number} index The index of the target node
160 * @param {HTMLElement} node The target node
161 * @param {Ext.EventObject} e The raw event object
166 * Fires when the mouse leaves a template node. trackOver:true or an overCls must be set to enable this event.
167 * @param {Ext.DataView} this
168 * @param {Number} index The index of the target node
169 * @param {HTMLElement} node The target node
170 * @param {Ext.EventObject} e The raw event object
174 * @event containerclick
175 * Fires when a click occurs and it is not on a template node.
176 * @param {Ext.DataView} this
177 * @param {Ext.EventObject} e The raw event object
182 * Fires when a template node is double clicked.
183 * @param {Ext.DataView} this
184 * @param {Number} index The index of the target node
185 * @param {HTMLElement} node The target node
186 * @param {Ext.EventObject} e The raw event object
191 * Fires when a template node is right clicked.
192 * @param {Ext.DataView} this
193 * @param {Number} index The index of the target node
194 * @param {HTMLElement} node The target node
195 * @param {Ext.EventObject} e The raw event object
199 * @event containercontextmenu
200 * Fires when a right click occurs that is not on a template node.
201 * @param {Ext.DataView} this
202 * @param {Ext.EventObject} e The raw event object
204 "containercontextmenu",
206 * @event selectionchange
207 * Fires when the selected nodes change.
208 * @param {Ext.DataView} this
209 * @param {Array} selections Array of the selected nodes
214 * @event beforeselect
215 * Fires before a selection is made. If any handlers return false, the selection is cancelled.
216 * @param {Ext.DataView} this
217 * @param {HTMLElement} node The node to be selected
218 * @param {Array} selections Array of currently selected nodes
223 this.store = Ext.StoreMgr.lookup(this.store);
224 this.all = new Ext.CompositeElementLite();
225 this.selected = new Ext.CompositeElementLite();
229 afterRender : function(){
230 Ext.DataView.superclass.afterRender.call(this);
232 this.mon(this.getTemplateTarget(), {
233 "click": this.onClick,
234 "dblclick": this.onDblClick,
235 "contextmenu": this.onContextMenu,
239 if(this.overClass || this.trackOver){
240 this.mon(this.getTemplateTarget(), {
241 "mouseover": this.onMouseOver,
242 "mouseout": this.onMouseOut,
248 this.bindStore(this.store, true);
253 * Refreshes the view by reloading the data from the store and re-rendering the template.
255 refresh : function(){
256 this.clearSelections(false, true);
257 var el = this.getTemplateTarget();
259 var records = this.store.getRange();
260 if(records.length < 1){
261 if(!this.deferEmptyText || this.hasSkippedEmptyText){
262 el.update(this.emptyText);
266 this.tpl.overwrite(el, this.collectData(records, 0));
267 this.all.fill(Ext.query(this.itemSelector, el.dom));
268 this.updateIndexes(0);
270 this.hasSkippedEmptyText = true;
273 getTemplateTarget: function(){
278 * Function which can be overridden to provide custom formatting for each Record that is used by this
279 * DataView's {@link #tpl template} to render each node.
280 * @param {Array/Object} data The raw data object that was used to create the Record.
281 * @param {Number} recordIndex the index number of the Record being prepared for rendering.
282 * @param {Record} record The Record being prepared for rendering.
283 * @return {Array/Object} The formatted data in a format expected by the internal {@link #tpl template}'s overwrite() method.
284 * (either an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}))
286 prepareData : function(data){
291 * <p>Function which can be overridden which returns the data object passed to this
292 * DataView's {@link #tpl template} to render the whole DataView.</p>
293 * <p>This is usually an Array of data objects, each element of which is processed by an
294 * {@link Ext.XTemplate XTemplate} which uses <tt>'<tpl for=".">'</tt> to iterate over its supplied
295 * data object as an Array. However, <i>named</i> properties may be placed into the data object to
296 * provide non-repeating data such as headings, totals etc.</p>
297 * @param {Array} records An Array of {@link Ext.data.Record}s to be rendered into the DataView.
298 * @param {Number} startIndex the index number of the Record being prepared for rendering.
299 * @return {Array} An Array of data objects to be processed by a repeating XTemplate. May also
300 * contain <i>named</i> properties.
302 collectData : function(records, startIndex){
304 for(var i = 0, len = records.length; i < len; i++){
305 r[r.length] = this.prepareData(records[i].data, startIndex+i, records[i]);
311 bufferRender : function(records){
312 var div = document.createElement('div');
313 this.tpl.overwrite(div, this.collectData(records));
314 return Ext.query(this.itemSelector, div);
318 onUpdate : function(ds, record){
319 var index = this.store.indexOf(record);
320 var sel = this.isSelected(index);
321 var original = this.all.elements[index];
322 var node = this.bufferRender([record], index)[0];
324 this.all.replaceElement(index, node, true);
326 this.selected.replaceElement(original, node);
327 this.all.item(index).addClass(this.selectedClass);
329 this.updateIndexes(index, index);
333 onAdd : function(ds, records, index){
334 if(this.all.getCount() === 0){
338 var nodes = this.bufferRender(records, index), n, a = this.all.elements;
339 if(index < this.all.getCount()){
340 n = this.all.item(index).insertSibling(nodes, 'before', true);
341 a.splice.apply(a, [index, 0].concat(nodes));
343 n = this.all.last().insertSibling(nodes, 'after', true);
344 a.push.apply(a, nodes);
346 this.updateIndexes(index);
350 onRemove : function(ds, record, index){
351 this.deselect(index);
352 this.all.removeElement(index, true);
353 this.updateIndexes(index);
354 if (this.store.getCount() === 0){
360 * Refreshes an individual node's data from the store.
361 * @param {Number} index The item's data index in the store
363 refreshNode : function(index){
364 this.onUpdate(this.store, this.store.getAt(index));
368 updateIndexes : function(startIndex, endIndex){
369 var ns = this.all.elements;
370 startIndex = startIndex || 0;
371 endIndex = endIndex || ((endIndex === 0) ? 0 : (ns.length - 1));
372 for(var i = startIndex; i <= endIndex; i++){
378 * Returns the store associated with this DataView.
379 * @return {Ext.data.Store} The store
381 getStore : function(){
386 * Changes the data store bound to this view and refreshes it.
387 * @param {Store} store The store to bind to this view
389 bindStore : function(store, initial){
390 if(!initial && this.store){
391 this.store.un("beforeload", this.onBeforeLoad, this);
392 this.store.un("datachanged", this.refresh, this);
393 this.store.un("add", this.onAdd, this);
394 this.store.un("remove", this.onRemove, this);
395 this.store.un("update", this.onUpdate, this);
396 this.store.un("clear", this.refresh, this);
397 if(store !== this.store && this.store.autoDestroy){
398 this.store.destroy();
402 store = Ext.StoreMgr.lookup(store);
405 beforeload: this.onBeforeLoad,
406 datachanged: this.refresh,
408 remove: this.onRemove,
409 update: this.onUpdate,
420 * Returns the template node the passed child belongs to, or null if it doesn't belong to one.
421 * @param {HTMLElement} node
422 * @return {HTMLElement} The template node
424 findItemFromChild : function(node){
425 return Ext.fly(node).findParent(this.itemSelector, this.getTemplateTarget());
429 onClick : function(e){
430 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
432 var index = this.indexOf(item);
433 if(this.onItemClick(item, index, e) !== false){
434 this.fireEvent("click", this, index, item, e);
437 if(this.fireEvent("containerclick", this, e) !== false){
438 this.onContainerClick(e);
443 onContainerClick : function(e){
444 this.clearSelections();
448 onContextMenu : function(e){
449 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
451 this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
453 this.fireEvent("containercontextmenu", this, e);
458 onDblClick : function(e){
459 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
461 this.fireEvent("dblclick", this, this.indexOf(item), item, e);
466 onMouseOver : function(e){
467 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
468 if(item && item !== this.lastItem){
469 this.lastItem = item;
470 Ext.fly(item).addClass(this.overClass);
471 this.fireEvent("mouseenter", this, this.indexOf(item), item, e);
476 onMouseOut : function(e){
478 if(!e.within(this.lastItem, true, true)){
479 Ext.fly(this.lastItem).removeClass(this.overClass);
480 this.fireEvent("mouseleave", this, this.indexOf(this.lastItem), this.lastItem, e);
481 delete this.lastItem;
487 onItemClick : function(item, index, e){
488 if(this.fireEvent("beforeclick", this, index, item, e) === false){
491 if(this.multiSelect){
492 this.doMultiSelection(item, index, e);
494 }else if(this.singleSelect){
495 this.doSingleSelection(item, index, e);
502 doSingleSelection : function(item, index, e){
503 if(e.ctrlKey && this.isSelected(index)){
504 this.deselect(index);
506 this.select(index, false);
511 doMultiSelection : function(item, index, e){
512 if(e.shiftKey && this.last !== false){
513 var last = this.last;
514 this.selectRange(last, index, e.ctrlKey);
515 this.last = last; // reset the last
517 if((e.ctrlKey||this.simpleSelect) && this.isSelected(index)){
518 this.deselect(index);
520 this.select(index, e.ctrlKey || e.shiftKey || this.simpleSelect);
526 * Gets the number of selected nodes.
527 * @return {Number} The node count
529 getSelectionCount : function(){
530 return this.selected.getCount();
534 * Gets the currently selected nodes.
535 * @return {Array} An array of HTMLElements
537 getSelectedNodes : function(){
538 return this.selected.elements;
542 * Gets the indexes of the selected nodes.
543 * @return {Array} An array of numeric indexes
545 getSelectedIndexes : function(){
546 var indexes = [], s = this.selected.elements;
547 for(var i = 0, len = s.length; i < len; i++){
548 indexes.push(s[i].viewIndex);
554 * Gets an array of the selected records
555 * @return {Array} An array of {@link Ext.data.Record} objects
557 getSelectedRecords : function(){
558 var r = [], s = this.selected.elements;
559 for(var i = 0, len = s.length; i < len; i++){
560 r[r.length] = this.store.getAt(s[i].viewIndex);
566 * Gets an array of the records from an array of nodes
567 * @param {Array} nodes The nodes to evaluate
568 * @return {Array} records The {@link Ext.data.Record} objects
570 getRecords : function(nodes){
571 var r = [], s = nodes;
572 for(var i = 0, len = s.length; i < len; i++){
573 r[r.length] = this.store.getAt(s[i].viewIndex);
579 * Gets a record from a node
580 * @param {HTMLElement} node The node to evaluate
581 * @return {Record} record The {@link Ext.data.Record} object
583 getRecord : function(node){
584 return this.store.getAt(node.viewIndex);
588 * Clears all selections.
589 * @param {Boolean} suppressEvent (optional) True to skip firing of the selectionchange event
591 clearSelections : function(suppressEvent, skipUpdate){
592 if((this.multiSelect || this.singleSelect) && this.selected.getCount() > 0){
594 this.selected.removeClass(this.selectedClass);
596 this.selected.clear();
599 this.fireEvent("selectionchange", this, this.selected.elements);
605 * Returns true if the passed node is selected, else false.
606 * @param {HTMLElement/Number} node The node or node index to check
607 * @return {Boolean} True if selected, else false
609 isSelected : function(node){
610 return this.selected.contains(this.getNode(node));
615 * @param {HTMLElement/Number} node The node to deselect
617 deselect : function(node){
618 if(this.isSelected(node)){
619 node = this.getNode(node);
620 this.selected.removeElement(node);
621 if(this.last == node.viewIndex){
624 Ext.fly(node).removeClass(this.selectedClass);
625 this.fireEvent("selectionchange", this, this.selected.elements);
630 * Selects a set of nodes.
631 * @param {Array/HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node,
632 * id of a template node or an array of any of those to select
633 * @param {Boolean} keepExisting (optional) true to keep existing selections
634 * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
636 select : function(nodeInfo, keepExisting, suppressEvent){
637 if(Ext.isArray(nodeInfo)){
639 this.clearSelections(true);
641 for(var i = 0, len = nodeInfo.length; i < len; i++){
642 this.select(nodeInfo[i], true, true);
645 this.fireEvent("selectionchange", this, this.selected.elements);
648 var node = this.getNode(nodeInfo);
650 this.clearSelections(true);
652 if(node && !this.isSelected(node)){
653 if(this.fireEvent("beforeselect", this, node, this.selected.elements) !== false){
654 Ext.fly(node).addClass(this.selectedClass);
655 this.selected.add(node);
656 this.last = node.viewIndex;
658 this.fireEvent("selectionchange", this, this.selected.elements);
666 * Selects a range of nodes. All nodes between start and end are selected.
667 * @param {Number} start The index of the first node in the range
668 * @param {Number} end The index of the last node in the range
669 * @param {Boolean} keepExisting (optional) True to retain existing selections
671 selectRange : function(start, end, keepExisting){
673 this.clearSelections(true);
675 this.select(this.getNodes(start, end), true);
679 * Gets a template node.
680 * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
681 * @return {HTMLElement} The node or null if it wasn't found
683 getNode : function(nodeInfo){
684 if(Ext.isString(nodeInfo)){
685 return document.getElementById(nodeInfo);
686 }else if(Ext.isNumber(nodeInfo)){
687 return this.all.elements[nodeInfo];
693 * Gets a range nodes.
694 * @param {Number} start (optional) The index of the first node in the range
695 * @param {Number} end (optional) The index of the last node in the range
696 * @return {Array} An array of nodes
698 getNodes : function(start, end){
699 var ns = this.all.elements;
701 end = !Ext.isDefined(end) ? Math.max(ns.length - 1, 0) : end;
704 for(i = start; i <= end && ns[i]; i++){
708 for(i = start; i >= end && ns[i]; i--){
716 * Finds the index of the passed node.
717 * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
718 * @return {Number} The index of the node or -1
720 indexOf : function(node){
721 node = this.getNode(node);
722 if(Ext.isNumber(node.viewIndex)){
723 return node.viewIndex;
725 return this.all.indexOf(node);
729 onBeforeLoad : function(){
730 if(this.loadingText){
731 this.clearSelections(false, true);
732 this.getTemplateTarget().update('<div class="loading-indicator">'+this.loadingText+'</div>');
737 onDestroy : function(){
738 Ext.DataView.superclass.onDestroy.call(this);
739 this.bindStore(null);
744 * Changes the data store bound to this view and refreshes it. (deprecated in favor of bindStore)
745 * @param {Store} store The store to bind to this view
747 Ext.DataView.prototype.setStore = Ext.DataView.prototype.bindStore;
749 Ext.reg('dataview', Ext.DataView);/**
\r
750 * @class Ext.ListView
\r
751 * @extends Ext.DataView
\r
752 * <p>Ext.ListView is a fast and light-weight implentation of a
\r
753 * {@link Ext.grid.GridPanel Grid} like view with the following characteristics:</p>
\r
754 * <div class="mdetail-params"><ul>
\r
755 * <li>resizable columns</li>
\r
756 * <li>selectable</li>
\r
757 * <li>column widths are initially proportioned by percentage based on the container
\r
758 * width and number of columns</li>
\r
759 * <li>uses templates to render the data in any required format</li>
\r
760 * <li>no horizontal scrolling</li>
\r
761 * <li>no editing</li>
\r
763 * <p>Example usage:</p>
\r
765 // consume JSON of this form:
\r
769 "name":"dance_fever.jpg",
\r
771 "lastmod":1236974993000,
\r
772 "url":"images\/thumbs\/dance_fever.jpg"
\r
775 "name":"zack_sink.jpg",
\r
777 "lastmod":1236974993000,
\r
778 "url":"images\/thumbs\/zack_sink.jpg"
\r
782 var store = new Ext.data.JsonStore({
\r
783 url: 'get-images.php',
\r
787 {name:'size', type: 'float'},
\r
788 {name:'lastmod', type:'date', dateFormat:'timestamp'}
\r
793 var listView = new Ext.ListView({
\r
796 emptyText: 'No images to display',
\r
797 reserveScrollOffset: true,
\r
803 header: 'Last Modified',
\r
805 dataIndex: 'lastmod',
\r
806 tpl: '{lastmod:date("m-d h:i a")}'
\r
810 tpl: '{size:fileSize}', // format using Ext.util.Format.fileSize()
\r
815 // put it in a Panel so it looks pretty
\r
816 var panel = new Ext.Panel({
\r
822 title:'Simple ListView <i>(0 items selected)</i>',
\r
825 panel.render(document.body);
\r
827 // little bit of feedback
\r
828 listView.on('selectionchange', function(view, nodes){
\r
829 var l = nodes.length;
\r
830 var s = l != 1 ? 's' : '';
\r
831 panel.setTitle('Simple ListView <i>('+l+' item'+s+' selected)</i>');
\r
835 * @param {Object} config
\r
838 Ext.ListView = Ext.extend(Ext.DataView, {
\r
840 * Set this property to <tt>true</tt> to disable the header click handler disabling sort
\r
841 * (defaults to <tt>false</tt>).
\r
843 * @property disableHeaders
\r
846 * @cfg {Boolean} hideHeaders
\r
847 * <tt>true</tt> to hide the {@link #internalTpl header row} (defaults to <tt>false</tt> so
\r
848 * the {@link #internalTpl header row} will be shown).
\r
851 * @cfg {String} itemSelector
\r
852 * Defaults to <tt>'dl'</tt> to work with the preconfigured <b><tt>{@link Ext.DataView#tpl tpl}</tt></b>.
\r
853 * This setting specifies the CSS selector (e.g. <tt>div.some-class</tt> or <tt>span:first-child</tt>)
\r
854 * that will be used to determine what nodes the ListView will be working with.
\r
856 itemSelector: 'dl',
\r
858 * @cfg {String} selectedClass The CSS class applied to a selected row (defaults to
\r
859 * <tt>'x-list-selected'</tt>). An example overriding the default styling:
\r
861 .x-list-selected {background-color: yellow;}
\r
865 selectedClass:'x-list-selected',
\r
867 * @cfg {String} overClass The CSS class applied when over a row (defaults to
\r
868 * <tt>'x-list-over'</tt>). An example overriding the default styling:
\r
870 .x-list-over {background-color: orange;}
\r
874 overClass:'x-list-over',
\r
876 * @cfg {Boolean} reserveScrollOffset
\r
877 * By default will defer accounting for the configured <b><tt>{@link #scrollOffset}</tt></b>
\r
878 * for 10 milliseconds. Specify <tt>true</tt> to account for the configured
\r
879 * <b><tt>{@link #scrollOffset}</tt></b> immediately.
\r
882 * @cfg {Number} scrollOffset The amount of space to reserve for the scrollbar (defaults to
\r
883 * <tt>19</tt> pixels)
\r
887 * @cfg {Boolean/Object} columnResize
\r
888 * Specify <tt>true</tt> or specify a configuration object for {@link Ext.ListView.ColumnResizer}
\r
889 * to enable the columns to be resizable (defaults to <tt>true</tt>).
\r
891 columnResize: true,
\r
893 * @cfg {Array} columns An array of column configuration objects, for example:
\r
899 tpl: '{size:fileSize}',
\r
903 * Acceptable properties for each column configuration object are:
\r
904 * <div class="mdetail-params"><ul>
\r
905 * <li><b><tt>align</tt></b> : String<div class="sub-desc">Set the CSS text-align property
\r
906 * of the column. Defaults to <tt>'left'</tt>.</div></li>
\r
907 * <li><b><tt>dataIndex</tt></b> : String<div class="sub-desc">See {@link Ext.grid.Column}.
\r
908 * {@link Ext.grid.Column#dataIndex dataIndex} for details.</div></li>
\r
909 * <li><b><tt>header</tt></b> : String<div class="sub-desc">See {@link Ext.grid.Column}.
\r
910 * {@link Ext.grid.Column#header header} for details.</div></li>
\r
911 * <li><b><tt>tpl</tt></b> : String<div class="sub-desc">Specify a string to pass as the
\r
912 * configuration string for {@link Ext.XTemplate}. By default an {@link Ext.XTemplate}
\r
913 * will be implicitly created using the <tt>dataIndex</tt>.</div></li>
\r
914 * <li><b><tt>width</tt></b> : Number<div class="sub-desc">Percentage of the container width
\r
915 * this column should be allocated. Columns that have no width specified will be
\r
916 * allocated with an equal percentage to fill 100% of the container width. To easily take
\r
917 * advantage of the full container width, leave the width of at least one column undefined.
\r
918 * Note that if you do not want to take up the full width of the container, the width of
\r
919 * every column needs to be explicitly defined.</div></li>
\r
923 * @cfg {Boolean/Object} columnSort
\r
924 * Specify <tt>true</tt> or specify a configuration object for {@link Ext.ListView.Sorter}
\r
925 * to enable the columns to be sortable (defaults to <tt>true</tt>).
\r
929 * @cfg {String/Array} internalTpl
\r
930 * The template to be used for the header row. See {@link #tpl} for more details.
\r
933 initComponent : function(){
\r
934 if(this.columnResize){
\r
935 this.colResizer = new Ext.ListView.ColumnResizer(this.colResizer);
\r
936 this.colResizer.init(this);
\r
938 if(this.columnSort){
\r
939 this.colSorter = new Ext.ListView.Sorter(this.columnSort);
\r
940 this.colSorter.init(this);
\r
942 if(!this.internalTpl){
\r
943 this.internalTpl = new Ext.XTemplate(
\r
944 '<div class="x-list-header"><div class="x-list-header-inner">',
\r
945 '<tpl for="columns">',
\r
946 '<div style="width:{width}%;text-align:{align};"><em unselectable="on" id="',this.id, '-xlhd-{#}">',
\r
950 '<div class="x-clear"></div>',
\r
952 '<div class="x-list-body"><div class="x-list-body-inner">',
\r
957 this.tpl = new Ext.XTemplate(
\r
958 '<tpl for="rows">',
\r
960 '<tpl for="parent.columns">',
\r
961 '<dt style="width:{width}%;text-align:{align};"><em unselectable="on">',
\r
962 '{[values.tpl.apply(parent)]}',
\r
965 '<div class="x-clear"></div>',
\r
970 var cs = this.columns, allocatedWidth = 0, colsWithWidth = 0, len = cs.length;
\r
971 for(var i = 0; i < len; i++){
\r
974 c.tpl = new Ext.XTemplate('{' + c.dataIndex + '}');
\r
975 }else if(Ext.isString(c.tpl)){
\r
976 c.tpl = new Ext.XTemplate(c.tpl);
\r
978 c.align = c.align || 'left';
\r
979 if(Ext.isNumber(c.width)){
\r
981 allocatedWidth += c.width;
\r
985 // auto calculate missing column widths
\r
986 if(colsWithWidth < len){
\r
987 var remaining = len - colsWithWidth;
\r
988 if(allocatedWidth < 100){
\r
989 var perCol = ((100-allocatedWidth) / remaining);
\r
990 for(var j = 0; j < len; j++){
\r
992 if(!Ext.isNumber(c.width)){
\r
998 Ext.ListView.superclass.initComponent.call(this);
\r
1001 onRender : function(){
\r
1002 Ext.ListView.superclass.onRender.apply(this, arguments);
\r
1004 this.internalTpl.overwrite(this.el, {columns: this.columns});
\r
1006 this.innerBody = Ext.get(this.el.dom.childNodes[1].firstChild);
\r
1007 this.innerHd = Ext.get(this.el.dom.firstChild.firstChild);
\r
1009 if(this.hideHeaders){
\r
1010 this.el.dom.firstChild.style.display = 'none';
\r
1014 getTemplateTarget : function(){
\r
1015 return this.innerBody;
\r
1019 * <p>Function which can be overridden which returns the data object passed to this
\r
1020 * view's {@link #tpl template} to render the whole ListView. The returned object
\r
1021 * shall contain the following properties:</p>
\r
1022 * <div class="mdetail-params"><ul>
\r
1023 * <li><b>columns</b> : String<div class="sub-desc">See <tt>{@link #columns}</tt></div></li>
\r
1024 * <li><b>rows</b> : String<div class="sub-desc">See
\r
1025 * <tt>{@link Ext.DataView}.{@link Ext.DataView#collectData collectData}</div></li>
\r
1027 * @param {Array} records An Array of {@link Ext.data.Record}s to be rendered into the DataView.
\r
1028 * @param {Number} startIndex the index number of the Record being prepared for rendering.
\r
1029 * @return {Object} A data object containing properties to be processed by a repeating
\r
1030 * XTemplate as described above.
\r
1032 collectData : function(){
\r
1033 var rs = Ext.ListView.superclass.collectData.apply(this, arguments);
\r
1035 columns: this.columns,
\r
1040 verifyInternalSize : function(){
\r
1041 if(this.lastSize){
\r
1042 this.onResize(this.lastSize.width, this.lastSize.height);
\r
1047 onResize : function(w, h){
\r
1048 var bd = this.innerBody.dom;
\r
1049 var hd = this.innerHd.dom
\r
1053 var bdp = bd.parentNode;
\r
1054 if(Ext.isNumber(w)){
\r
1055 var sw = w - this.scrollOffset;
\r
1056 if(this.reserveScrollOffset || ((bdp.offsetWidth - bdp.clientWidth) > 10)){
\r
1057 bd.style.width = sw + 'px';
\r
1058 hd.style.width = sw + 'px';
\r
1060 bd.style.width = w + 'px';
\r
1061 hd.style.width = w + 'px';
\r
1062 setTimeout(function(){
\r
1063 if((bdp.offsetWidth - bdp.clientWidth) > 10){
\r
1064 bd.style.width = sw + 'px';
\r
1065 hd.style.width = sw + 'px';
\r
1070 if(Ext.isNumber(h == 'number')){
\r
1071 bdp.style.height = (h - hd.parentNode.offsetHeight) + 'px';
\r
1075 updateIndexes : function(){
\r
1076 Ext.ListView.superclass.updateIndexes.apply(this, arguments);
\r
1077 this.verifyInternalSize();
\r
1080 findHeaderIndex : function(hd){
\r
1081 hd = hd.dom || hd;
\r
1082 var pn = hd.parentNode, cs = pn.parentNode.childNodes;
\r
1083 for(var i = 0, c; c = cs[i]; i++){
\r
1091 setHdWidths : function(){
\r
1092 var els = this.innerHd.dom.getElementsByTagName('div');
\r
1093 for(var i = 0, cs = this.columns, len = cs.length; i < len; i++){
\r
1094 els[i].style.width = cs[i].width + '%';
\r
1099 Ext.reg('listview', Ext.ListView);/**
\r
1100 * @class Ext.ListView.ColumnResizer
\r
1101 * @extends Ext.util.Observable
\r
1102 * <p>Supporting Class for Ext.ListView.</p>
\r
1104 * @param {Object} config
\r
1106 Ext.ListView.ColumnResizer = Ext.extend(Ext.util.Observable, {
\r
1108 * @cfg {Number} minPct The minimum percentage to allot for any column (defaults to <tt>.05</tt>)
\r
1112 constructor: function(config){
\r
1113 Ext.apply(this, config);
\r
1114 Ext.ListView.ColumnResizer.superclass.constructor.call(this);
\r
1116 init : function(listView){
\r
1117 this.view = listView;
\r
1118 listView.on('render', this.initEvents, this);
\r
1121 initEvents : function(view){
\r
1122 view.mon(view.innerHd, 'mousemove', this.handleHdMove, this);
\r
1123 this.tracker = new Ext.dd.DragTracker({
\r
1124 onBeforeStart: this.onBeforeStart.createDelegate(this),
\r
1125 onStart: this.onStart.createDelegate(this),
\r
1126 onDrag: this.onDrag.createDelegate(this),
\r
1127 onEnd: this.onEnd.createDelegate(this),
\r
1131 this.tracker.initEl(view.innerHd);
\r
1132 view.on('beforedestroy', this.tracker.destroy, this.tracker);
\r
1135 handleHdMove : function(e, t){
\r
1137 var x = e.getPageX();
\r
1138 var hd = e.getTarget('em', 3, true);
\r
1140 var r = hd.getRegion();
\r
1141 var ss = hd.dom.style;
\r
1142 var pn = hd.dom.parentNode;
\r
1144 if(x - r.left <= hw && pn != pn.parentNode.firstChild){
\r
1145 this.activeHd = Ext.get(pn.previousSibling.firstChild);
\r
1146 ss.cursor = Ext.isWebKit ? 'e-resize' : 'col-resize';
\r
1147 } else if(r.right - x <= hw && pn != pn.parentNode.lastChild.previousSibling){
\r
1148 this.activeHd = hd;
\r
1149 ss.cursor = Ext.isWebKit ? 'w-resize' : 'col-resize';
\r
1151 delete this.activeHd;
\r
1157 onBeforeStart : function(e){
\r
1158 this.dragHd = this.activeHd;
\r
1159 return !!this.dragHd;
\r
1162 onStart: function(e){
\r
1163 this.view.disableHeaders = true;
\r
1164 this.proxy = this.view.el.createChild({cls:'x-list-resizer'});
\r
1165 this.proxy.setHeight(this.view.el.getHeight());
\r
1167 var x = this.tracker.getXY()[0];
\r
1168 var w = this.view.innerHd.getWidth();
\r
1170 this.hdX = this.dragHd.getX();
\r
1171 this.hdIndex = this.view.findHeaderIndex(this.dragHd);
\r
1173 this.proxy.setX(this.hdX);
\r
1174 this.proxy.setWidth(x-this.hdX);
\r
1176 this.minWidth = w*this.minPct;
\r
1177 this.maxWidth = w - (this.minWidth*(this.view.columns.length-1-this.hdIndex));
\r
1180 onDrag: function(e){
\r
1181 var cursorX = this.tracker.getXY()[0];
\r
1182 this.proxy.setWidth((cursorX-this.hdX).constrain(this.minWidth, this.maxWidth));
\r
1185 onEnd: function(e){
\r
1186 var nw = this.proxy.getWidth();
\r
1187 this.proxy.remove();
\r
1189 var index = this.hdIndex;
\r
1190 var vw = this.view, cs = vw.columns, len = cs.length;
\r
1191 var w = this.view.innerHd.getWidth(), minPct = this.minPct * 100;
\r
1193 var pct = Math.ceil((nw*100) / w);
\r
1194 var diff = cs[index].width - pct;
\r
1195 var each = Math.floor(diff / (len-1-index));
\r
1196 var mod = diff - (each * (len-1-index));
\r
1198 for(var i = index+1; i < len; i++){
\r
1199 var cw = cs[i].width + each;
\r
1200 var ncw = Math.max(minPct, cw);
\r
1204 cs[i].width = ncw;
\r
1206 cs[index].width = pct;
\r
1207 cs[index+1].width += mod;
\r
1208 delete this.dragHd;
\r
1209 this.view.setHdWidths();
\r
1210 this.view.refresh();
\r
1211 setTimeout(function(){
\r
1212 vw.disableHeaders = false;
\r
1216 * @class Ext.ListView.Sorter
\r
1217 * @extends Ext.util.Observable
\r
1218 * <p>Supporting Class for Ext.ListView.</p>
\r
1220 * @param {Object} config
\r
1222 Ext.ListView.Sorter = Ext.extend(Ext.util.Observable, {
\r
1224 * @cfg {Array} sortClasses
\r
1225 * The CSS classes applied to a header when it is sorted. (defaults to <tt>["sort-asc", "sort-desc"]</tt>)
\r
1227 sortClasses : ["sort-asc", "sort-desc"],
\r
1229 constructor: function(config){
\r
1230 Ext.apply(this, config);
\r
1231 Ext.ListView.Sorter.superclass.constructor.call(this);
\r
1234 init : function(listView){
\r
1235 this.view = listView;
\r
1236 listView.on('render', this.initEvents, this);
\r
1239 initEvents : function(view){
\r
1240 view.mon(view.innerHd, 'click', this.onHdClick, this);
\r
1241 view.innerHd.setStyle('cursor', 'pointer');
\r
1242 view.mon(view.store, 'datachanged', this.updateSortState, this);
\r
1243 this.updateSortState.defer(10, this, [view.store]);
\r
1246 updateSortState : function(store){
\r
1247 var state = store.getSortState();
\r
1251 this.sortState = state;
\r
1252 var cs = this.view.columns, sortColumn = -1;
\r
1253 for(var i = 0, len = cs.length; i < len; i++){
\r
1254 if(cs[i].dataIndex == state.field){
\r
1259 if(sortColumn != -1){
\r
1260 var sortDir = state.direction;
\r
1261 this.updateSortIcon(sortColumn, sortDir);
\r
1265 updateSortIcon : function(col, dir){
\r
1266 var sc = this.sortClasses;
\r
1267 var hds = this.view.innerHd.select('em').removeClass(sc);
\r
1268 hds.item(col).addClass(sc[dir == "DESC" ? 1 : 0]);
\r
1271 onHdClick : function(e){
\r
1272 var hd = e.getTarget('em', 3);
\r
1273 if(hd && !this.view.disableHeaders){
\r
1274 var index = this.view.findHeaderIndex(hd);
\r
1275 this.view.store.sort(this.view.columns[index].dataIndex);
\r