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 overClass 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 overClass 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);
321 var sel = this.isSelected(index);
322 var original = this.all.elements[index];
323 var node = this.bufferRender([record], index)[0];
325 this.all.replaceElement(index, node, true);
327 this.selected.replaceElement(original, node);
328 this.all.item(index).addClass(this.selectedClass);
330 this.updateIndexes(index, index);
335 onAdd : function(ds, records, index){
336 if(this.all.getCount() === 0){
340 var nodes = this.bufferRender(records, index), n, a = this.all.elements;
341 if(index < this.all.getCount()){
342 n = this.all.item(index).insertSibling(nodes, 'before', true);
343 a.splice.apply(a, [index, 0].concat(nodes));
345 n = this.all.last().insertSibling(nodes, 'after', true);
346 a.push.apply(a, nodes);
348 this.updateIndexes(index);
352 onRemove : function(ds, record, index){
353 this.deselect(index);
354 this.all.removeElement(index, true);
355 this.updateIndexes(index);
356 if (this.store.getCount() === 0){
362 * Refreshes an individual node's data from the store.
363 * @param {Number} index The item's data index in the store
365 refreshNode : function(index){
366 this.onUpdate(this.store, this.store.getAt(index));
370 updateIndexes : function(startIndex, endIndex){
371 var ns = this.all.elements;
372 startIndex = startIndex || 0;
373 endIndex = endIndex || ((endIndex === 0) ? 0 : (ns.length - 1));
374 for(var i = startIndex; i <= endIndex; i++){
380 * Returns the store associated with this DataView.
381 * @return {Ext.data.Store} The store
383 getStore : function(){
388 * Changes the data store bound to this view and refreshes it.
389 * @param {Store} store The store to bind to this view
391 bindStore : function(store, initial){
392 if(!initial && this.store){
393 if(store !== this.store && this.store.autoDestroy){
394 this.store.destroy();
396 this.store.un("beforeload", this.onBeforeLoad, this);
397 this.store.un("datachanged", this.refresh, this);
398 this.store.un("add", this.onAdd, this);
399 this.store.un("remove", this.onRemove, this);
400 this.store.un("update", this.onUpdate, this);
401 this.store.un("clear", this.refresh, this);
408 store = Ext.StoreMgr.lookup(store);
411 beforeload: this.onBeforeLoad,
412 datachanged: this.refresh,
414 remove: this.onRemove,
415 update: this.onUpdate,
426 * Returns the template node the passed child belongs to, or null if it doesn't belong to one.
427 * @param {HTMLElement} node
428 * @return {HTMLElement} The template node
430 findItemFromChild : function(node){
431 return Ext.fly(node).findParent(this.itemSelector, this.getTemplateTarget());
435 onClick : function(e){
436 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
438 var index = this.indexOf(item);
439 if(this.onItemClick(item, index, e) !== false){
440 this.fireEvent("click", this, index, item, e);
443 if(this.fireEvent("containerclick", this, e) !== false){
444 this.onContainerClick(e);
449 onContainerClick : function(e){
450 this.clearSelections();
454 onContextMenu : function(e){
455 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
457 this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
459 this.fireEvent("containercontextmenu", this, e);
464 onDblClick : function(e){
465 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
467 this.fireEvent("dblclick", this, this.indexOf(item), item, e);
472 onMouseOver : function(e){
473 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
474 if(item && item !== this.lastItem){
475 this.lastItem = item;
476 Ext.fly(item).addClass(this.overClass);
477 this.fireEvent("mouseenter", this, this.indexOf(item), item, e);
482 onMouseOut : function(e){
484 if(!e.within(this.lastItem, true, true)){
485 Ext.fly(this.lastItem).removeClass(this.overClass);
486 this.fireEvent("mouseleave", this, this.indexOf(this.lastItem), this.lastItem, e);
487 delete this.lastItem;
493 onItemClick : function(item, index, e){
494 if(this.fireEvent("beforeclick", this, index, item, e) === false){
497 if(this.multiSelect){
498 this.doMultiSelection(item, index, e);
500 }else if(this.singleSelect){
501 this.doSingleSelection(item, index, e);
508 doSingleSelection : function(item, index, e){
509 if(e.ctrlKey && this.isSelected(index)){
510 this.deselect(index);
512 this.select(index, false);
517 doMultiSelection : function(item, index, e){
518 if(e.shiftKey && this.last !== false){
519 var last = this.last;
520 this.selectRange(last, index, e.ctrlKey);
521 this.last = last; // reset the last
523 if((e.ctrlKey||this.simpleSelect) && this.isSelected(index)){
524 this.deselect(index);
526 this.select(index, e.ctrlKey || e.shiftKey || this.simpleSelect);
532 * Gets the number of selected nodes.
533 * @return {Number} The node count
535 getSelectionCount : function(){
536 return this.selected.getCount();
540 * Gets the currently selected nodes.
541 * @return {Array} An array of HTMLElements
543 getSelectedNodes : function(){
544 return this.selected.elements;
548 * Gets the indexes of the selected nodes.
549 * @return {Array} An array of numeric indexes
551 getSelectedIndexes : function(){
552 var indexes = [], s = this.selected.elements;
553 for(var i = 0, len = s.length; i < len; i++){
554 indexes.push(s[i].viewIndex);
560 * Gets an array of the selected records
561 * @return {Array} An array of {@link Ext.data.Record} objects
563 getSelectedRecords : function(){
564 var r = [], s = this.selected.elements;
565 for(var i = 0, len = s.length; i < len; i++){
566 r[r.length] = this.store.getAt(s[i].viewIndex);
572 * Gets an array of the records from an array of nodes
573 * @param {Array} nodes The nodes to evaluate
574 * @return {Array} records The {@link Ext.data.Record} objects
576 getRecords : function(nodes){
577 var r = [], s = nodes;
578 for(var i = 0, len = s.length; i < len; i++){
579 r[r.length] = this.store.getAt(s[i].viewIndex);
585 * Gets a record from a node
586 * @param {HTMLElement} node The node to evaluate
587 * @return {Record} record The {@link Ext.data.Record} object
589 getRecord : function(node){
590 return this.store.getAt(node.viewIndex);
594 * Clears all selections.
595 * @param {Boolean} suppressEvent (optional) True to skip firing of the selectionchange event
597 clearSelections : function(suppressEvent, skipUpdate){
598 if((this.multiSelect || this.singleSelect) && this.selected.getCount() > 0){
600 this.selected.removeClass(this.selectedClass);
602 this.selected.clear();
605 this.fireEvent("selectionchange", this, this.selected.elements);
611 * Returns true if the passed node is selected, else false.
612 * @param {HTMLElement/Number} node The node or node index to check
613 * @return {Boolean} True if selected, else false
615 isSelected : function(node){
616 return this.selected.contains(this.getNode(node));
621 * @param {HTMLElement/Number} node The node to deselect
623 deselect : function(node){
624 if(this.isSelected(node)){
625 node = this.getNode(node);
626 this.selected.removeElement(node);
627 if(this.last == node.viewIndex){
630 Ext.fly(node).removeClass(this.selectedClass);
631 this.fireEvent("selectionchange", this, this.selected.elements);
636 * Selects a set of nodes.
637 * @param {Array/HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node,
638 * id of a template node or an array of any of those to select
639 * @param {Boolean} keepExisting (optional) true to keep existing selections
640 * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
642 select : function(nodeInfo, keepExisting, suppressEvent){
643 if(Ext.isArray(nodeInfo)){
645 this.clearSelections(true);
647 for(var i = 0, len = nodeInfo.length; i < len; i++){
648 this.select(nodeInfo[i], true, true);
651 this.fireEvent("selectionchange", this, this.selected.elements);
654 var node = this.getNode(nodeInfo);
656 this.clearSelections(true);
658 if(node && !this.isSelected(node)){
659 if(this.fireEvent("beforeselect", this, node, this.selected.elements) !== false){
660 Ext.fly(node).addClass(this.selectedClass);
661 this.selected.add(node);
662 this.last = node.viewIndex;
664 this.fireEvent("selectionchange", this, this.selected.elements);
672 * Selects a range of nodes. All nodes between start and end are selected.
673 * @param {Number} start The index of the first node in the range
674 * @param {Number} end The index of the last node in the range
675 * @param {Boolean} keepExisting (optional) True to retain existing selections
677 selectRange : function(start, end, keepExisting){
679 this.clearSelections(true);
681 this.select(this.getNodes(start, end), true);
685 * Gets a template node.
686 * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
687 * @return {HTMLElement} The node or null if it wasn't found
689 getNode : function(nodeInfo){
690 if(Ext.isString(nodeInfo)){
691 return document.getElementById(nodeInfo);
692 }else if(Ext.isNumber(nodeInfo)){
693 return this.all.elements[nodeInfo];
699 * Gets a range nodes.
700 * @param {Number} start (optional) The index of the first node in the range
701 * @param {Number} end (optional) The index of the last node in the range
702 * @return {Array} An array of nodes
704 getNodes : function(start, end){
705 var ns = this.all.elements;
707 end = !Ext.isDefined(end) ? Math.max(ns.length - 1, 0) : end;
710 for(i = start; i <= end && ns[i]; i++){
714 for(i = start; i >= end && ns[i]; i--){
722 * Finds the index of the passed node.
723 * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
724 * @return {Number} The index of the node or -1
726 indexOf : function(node){
727 node = this.getNode(node);
728 if(Ext.isNumber(node.viewIndex)){
729 return node.viewIndex;
731 return this.all.indexOf(node);
735 onBeforeLoad : function(){
736 if(this.loadingText){
737 this.clearSelections(false, true);
738 this.getTemplateTarget().update('<div class="loading-indicator">'+this.loadingText+'</div>');
743 onDestroy : function(){
745 this.selected.clear();
746 Ext.DataView.superclass.onDestroy.call(this);
747 this.bindStore(null);
752 * Changes the data store bound to this view and refreshes it. (deprecated in favor of bindStore)
753 * @param {Store} store The store to bind to this view
755 Ext.DataView.prototype.setStore = Ext.DataView.prototype.bindStore;
757 Ext.reg('dataview', Ext.DataView);
759 * @class Ext.list.ListView
\r
760 * @extends Ext.DataView
\r
761 * <p>Ext.list.ListView is a fast and light-weight implentation of a
\r
762 * {@link Ext.grid.GridPanel Grid} like view with the following characteristics:</p>
\r
763 * <div class="mdetail-params"><ul>
\r
764 * <li>resizable columns</li>
\r
765 * <li>selectable</li>
\r
766 * <li>column widths are initially proportioned by percentage based on the container
\r
767 * width and number of columns</li>
\r
768 * <li>uses templates to render the data in any required format</li>
\r
769 * <li>no horizontal scrolling</li>
\r
770 * <li>no editing</li>
\r
772 * <p>Example usage:</p>
\r
774 // consume JSON of this form:
\r
778 "name":"dance_fever.jpg",
\r
780 "lastmod":1236974993000,
\r
781 "url":"images\/thumbs\/dance_fever.jpg"
\r
784 "name":"zack_sink.jpg",
\r
786 "lastmod":1236974993000,
\r
787 "url":"images\/thumbs\/zack_sink.jpg"
\r
791 var store = new Ext.data.JsonStore({
\r
792 url: 'get-images.php',
\r
796 {name:'size', type: 'float'},
\r
797 {name:'lastmod', type:'date', dateFormat:'timestamp'}
\r
802 var listView = new Ext.list.ListView({
\r
805 emptyText: 'No images to display',
\r
806 reserveScrollOffset: true,
\r
812 header: 'Last Modified',
\r
814 dataIndex: 'lastmod',
\r
815 tpl: '{lastmod:date("m-d h:i a")}'
\r
819 tpl: '{size:fileSize}', // format using Ext.util.Format.fileSize()
\r
824 // put it in a Panel so it looks pretty
\r
825 var panel = new Ext.Panel({
\r
831 title:'Simple ListView <i>(0 items selected)</i>',
\r
834 panel.render(document.body);
\r
836 // little bit of feedback
\r
837 listView.on('selectionchange', function(view, nodes){
\r
838 var l = nodes.length;
\r
839 var s = l != 1 ? 's' : '';
\r
840 panel.setTitle('Simple ListView <i>('+l+' item'+s+' selected)</i>');
\r
844 * @param {Object} config
\r
847 Ext.list.ListView = Ext.extend(Ext.DataView, {
\r
849 * Set this property to <tt>true</tt> to disable the header click handler disabling sort
\r
850 * (defaults to <tt>false</tt>).
\r
852 * @property disableHeaders
\r
855 * @cfg {Boolean} hideHeaders
\r
856 * <tt>true</tt> to hide the {@link #internalTpl header row} (defaults to <tt>false</tt> so
\r
857 * the {@link #internalTpl header row} will be shown).
\r
860 * @cfg {String} itemSelector
\r
861 * Defaults to <tt>'dl'</tt> to work with the preconfigured <b><tt>{@link Ext.DataView#tpl tpl}</tt></b>.
\r
862 * This setting specifies the CSS selector (e.g. <tt>div.some-class</tt> or <tt>span:first-child</tt>)
\r
863 * that will be used to determine what nodes the ListView will be working with.
\r
865 itemSelector: 'dl',
\r
867 * @cfg {String} selectedClass The CSS class applied to a selected row (defaults to
\r
868 * <tt>'x-list-selected'</tt>). An example overriding the default styling:
\r
870 .x-list-selected {background-color: yellow;}
\r
874 selectedClass:'x-list-selected',
\r
876 * @cfg {String} overClass The CSS class applied when over a row (defaults to
\r
877 * <tt>'x-list-over'</tt>). An example overriding the default styling:
\r
879 .x-list-over {background-color: orange;}
\r
883 overClass:'x-list-over',
\r
885 * @cfg {Boolean} reserveScrollOffset
\r
886 * By default will defer accounting for the configured <b><tt>{@link #scrollOffset}</tt></b>
\r
887 * for 10 milliseconds. Specify <tt>true</tt> to account for the configured
\r
888 * <b><tt>{@link #scrollOffset}</tt></b> immediately.
\r
891 * @cfg {Number} scrollOffset The amount of space to reserve for the scrollbar (defaults to
\r
892 * <tt>undefined</tt>). If an explicit value isn't specified, this will be automatically
\r
895 scrollOffset : undefined,
\r
897 * @cfg {Boolean/Object} columnResize
\r
898 * Specify <tt>true</tt> or specify a configuration object for {@link Ext.list.ListView.ColumnResizer}
\r
899 * to enable the columns to be resizable (defaults to <tt>true</tt>).
\r
901 columnResize: true,
\r
903 * @cfg {Array} columns An array of column configuration objects, for example:
\r
909 tpl: '{size:fileSize}',
\r
913 * Acceptable properties for each column configuration object are:
\r
914 * <div class="mdetail-params"><ul>
\r
915 * <li><b><tt>align</tt></b> : String<div class="sub-desc">Set the CSS text-align property
\r
916 * of the column. Defaults to <tt>'left'</tt>.</div></li>
\r
917 * <li><b><tt>dataIndex</tt></b> : String<div class="sub-desc">See {@link Ext.grid.Column}.
\r
918 * {@link Ext.grid.Column#dataIndex dataIndex} for details.</div></li>
\r
919 * <li><b><tt>header</tt></b> : String<div class="sub-desc">See {@link Ext.grid.Column}.
\r
920 * {@link Ext.grid.Column#header header} for details.</div></li>
\r
921 * <li><b><tt>tpl</tt></b> : String<div class="sub-desc">Specify a string to pass as the
\r
922 * configuration string for {@link Ext.XTemplate}. By default an {@link Ext.XTemplate}
\r
923 * will be implicitly created using the <tt>dataIndex</tt>.</div></li>
\r
924 * <li><b><tt>width</tt></b> : Number<div class="sub-desc">Percentage of the container width
\r
925 * this column should be allocated. Columns that have no width specified will be
\r
926 * allocated with an equal percentage to fill 100% of the container width. To easily take
\r
927 * advantage of the full container width, leave the width of at least one column undefined.
\r
928 * Note that if you do not want to take up the full width of the container, the width of
\r
929 * every column needs to be explicitly defined.</div></li>
\r
933 * @cfg {Boolean/Object} columnSort
\r
934 * Specify <tt>true</tt> or specify a configuration object for {@link Ext.list.ListView.Sorter}
\r
935 * to enable the columns to be sortable (defaults to <tt>true</tt>).
\r
939 * @cfg {String/Array} internalTpl
\r
940 * The template to be used for the header row. See {@link #tpl} for more details.
\r
944 * IE has issues when setting percentage based widths to 100%. Default to 99.
\r
946 maxWidth: Ext.isIE ? 99 : 100,
\r
948 initComponent : function(){
\r
949 if(this.columnResize){
\r
950 this.colResizer = new Ext.list.ColumnResizer(this.colResizer);
\r
951 this.colResizer.init(this);
\r
953 if(this.columnSort){
\r
954 this.colSorter = new Ext.list.Sorter(this.columnSort);
\r
955 this.colSorter.init(this);
\r
957 if(!this.internalTpl){
\r
958 this.internalTpl = new Ext.XTemplate(
\r
959 '<div class="x-list-header"><div class="x-list-header-inner">',
\r
960 '<tpl for="columns">',
\r
961 '<div style="width:{[values.width*100]}%;text-align:{align};"><em unselectable="on" id="',this.id, '-xlhd-{#}">',
\r
965 '<div class="x-clear"></div>',
\r
967 '<div class="x-list-body"><div class="x-list-body-inner">',
\r
972 this.tpl = new Ext.XTemplate(
\r
973 '<tpl for="rows">',
\r
975 '<tpl for="parent.columns">',
\r
976 '<dt style="width:{[values.width*100]}%;text-align:{align};">',
\r
977 '<em unselectable="on"<tpl if="cls"> class="{cls}</tpl>">',
\r
978 '{[values.tpl.apply(parent)]}',
\r
981 '<div class="x-clear"></div>',
\r
987 var cs = this.columns,
\r
988 allocatedWidth = 0,
\r
989 colsWithWidth = 0,
\r
993 for(var i = 0; i < len; i++){
\r
996 c.xtype = c.xtype ? (/^lv/.test(c.xtype) ? c.xtype : 'lv' + c.xtype) : 'lvcolumn';
\r
1000 allocatedWidth += c.width*100;
\r
1006 cs = this.columns = columns;
\r
1008 // auto calculate missing column widths
\r
1009 if(colsWithWidth < len){
\r
1010 var remaining = len - colsWithWidth;
\r
1011 if(allocatedWidth < this.maxWidth){
\r
1012 var perCol = ((this.maxWidth-allocatedWidth) / remaining)/100;
\r
1013 for(var j = 0; j < len; j++){
\r
1021 Ext.list.ListView.superclass.initComponent.call(this);
\r
1024 onRender : function(){
\r
1026 cls: 'x-list-wrap'
\r
1028 Ext.list.ListView.superclass.onRender.apply(this, arguments);
\r
1030 this.internalTpl.overwrite(this.el, {columns: this.columns});
\r
1032 this.innerBody = Ext.get(this.el.dom.childNodes[1].firstChild);
\r
1033 this.innerHd = Ext.get(this.el.dom.firstChild.firstChild);
\r
1035 if(this.hideHeaders){
\r
1036 this.el.dom.firstChild.style.display = 'none';
\r
1040 getTemplateTarget : function(){
\r
1041 return this.innerBody;
\r
1045 * <p>Function which can be overridden which returns the data object passed to this
\r
1046 * view's {@link #tpl template} to render the whole ListView. The returned object
\r
1047 * shall contain the following properties:</p>
\r
1048 * <div class="mdetail-params"><ul>
\r
1049 * <li><b>columns</b> : String<div class="sub-desc">See <tt>{@link #columns}</tt></div></li>
\r
1050 * <li><b>rows</b> : String<div class="sub-desc">See
\r
1051 * <tt>{@link Ext.DataView}.{@link Ext.DataView#collectData collectData}</div></li>
\r
1053 * @param {Array} records An Array of {@link Ext.data.Record}s to be rendered into the DataView.
\r
1054 * @param {Number} startIndex the index number of the Record being prepared for rendering.
\r
1055 * @return {Object} A data object containing properties to be processed by a repeating
\r
1056 * XTemplate as described above.
\r
1058 collectData : function(){
\r
1059 var rs = Ext.list.ListView.superclass.collectData.apply(this, arguments);
\r
1061 columns: this.columns,
\r
1066 verifyInternalSize : function(){
\r
1067 if(this.lastSize){
\r
1068 this.onResize(this.lastSize.width, this.lastSize.height);
\r
1073 onResize : function(w, h){
\r
1074 var bd = this.innerBody.dom;
\r
1075 var hd = this.innerHd.dom
\r
1079 var bdp = bd.parentNode;
\r
1080 if(Ext.isNumber(w)){
\r
1081 var sw = w - Ext.num(this.scrollOffset, Ext.getScrollBarWidth());
\r
1082 if(this.reserveScrollOffset || ((bdp.offsetWidth - bdp.clientWidth) > 10)){
\r
1083 bd.style.width = sw + 'px';
\r
1084 hd.style.width = sw + 'px';
\r
1086 bd.style.width = w + 'px';
\r
1087 hd.style.width = w + 'px';
\r
1088 setTimeout(function(){
\r
1089 if((bdp.offsetWidth - bdp.clientWidth) > 10){
\r
1090 bd.style.width = sw + 'px';
\r
1091 hd.style.width = sw + 'px';
\r
1096 if(Ext.isNumber(h)){
\r
1097 bdp.style.height = (h - hd.parentNode.offsetHeight) + 'px';
\r
1101 updateIndexes : function(){
\r
1102 Ext.list.ListView.superclass.updateIndexes.apply(this, arguments);
\r
1103 this.verifyInternalSize();
\r
1106 findHeaderIndex : function(hd){
\r
1107 hd = hd.dom || hd;
\r
1108 var pn = hd.parentNode, cs = pn.parentNode.childNodes;
\r
1109 for(var i = 0, c; c = cs[i]; i++){
\r
1117 setHdWidths : function(){
\r
1118 var els = this.innerHd.dom.getElementsByTagName('div');
\r
1119 for(var i = 0, cs = this.columns, len = cs.length; i < len; i++){
\r
1120 els[i].style.width = (cs[i].width*100) + '%';
\r
1125 Ext.reg('listview', Ext.list.ListView);
\r
1127 // Backwards compatibility alias
\r
1128 Ext.ListView = Ext.list.ListView;/**
1129 * @class Ext.list.Column
1130 * <p>This class encapsulates column configuration data to be used in the initialization of a
1131 * {@link Ext.list.ListView ListView}.</p>
1132 * <p>While subclasses are provided to render data in different ways, this class renders a passed
1133 * data field unchanged and is usually used for textual columns.</p>
1135 Ext.list.Column = Ext.extend(Object, {
1138 * @cfg {Boolean} isColumn
1139 * Used by ListView constructor method to avoid reprocessing a Column
1140 * if <code>isColumn</code> is not set ListView will recreate a new Ext.list.Column
1146 * @cfg {String} align
1147 * Set the CSS text-align property of the column. Defaults to <tt>'left'</tt>.
1151 * @cfg {String} header Optional. The header text to be used as innerHTML
1152 * (html tags are accepted) to display in the ListView. <b>Note</b>: to
1153 * have a clickable header with no text displayed use <tt>' '</tt>.
1158 * @cfg {Number} width Optional. Percentage of the container width
1159 * this column should be allocated. Columns that have no width specified will be
1160 * allocated with an equal percentage to fill 100% of the container width. To easily take
1161 * advantage of the full container width, leave the width of at least one column undefined.
1162 * Note that if you do not want to take up the full width of the container, the width of
1163 * every column needs to be explicitly defined.
1168 * @cfg {String} cls Optional. This option can be used to add a CSS class to the cell of each
1169 * row for this column.
1174 * @cfg {String} tpl Optional. Specify a string to pass as the
1175 * configuration string for {@link Ext.XTemplate}. By default an {@link Ext.XTemplate}
1176 * will be implicitly created using the <tt>dataIndex</tt>.
1180 * @cfg {String} dataIndex <p><b>Required</b>. The name of the field in the
1181 * ListViews's {@link Ext.data.Store}'s {@link Ext.data.Record} definition from
1182 * which to draw the column's value.</p>
1185 constructor : function(c){
1187 c.tpl = new Ext.XTemplate('{' + c.dataIndex + '}');
1189 else if(Ext.isString(c.tpl)){
1190 c.tpl = new Ext.XTemplate(c.tpl);
1197 Ext.reg('lvcolumn', Ext.list.Column);
1200 * @class Ext.list.NumberColumn
1201 * @extends Ext.list.Column
1202 * <p>A Column definition class which renders a numeric data field according to a {@link #format} string. See the
1203 * {@link Ext.list.Column#xtype xtype} config option of {@link Ext.list.Column} for more details.</p>
1205 Ext.list.NumberColumn = Ext.extend(Ext.list.Column, {
1207 * @cfg {String} format
1208 * A formatting string as used by {@link Ext.util.Format#number} to format a numeric value for this Column
1209 * (defaults to <tt>'0,000.00'</tt>).
1213 constructor : function(c) {
1214 c.tpl = c.tpl || new Ext.XTemplate('{' + c.dataIndex + ':number("' + (c.format || this.format) + '")}');
1215 Ext.list.NumberColumn.superclass.constructor.call(this, c);
1219 Ext.reg('lvnumbercolumn', Ext.list.NumberColumn);
1222 * @class Ext.list.DateColumn
1223 * @extends Ext.list.Column
1224 * <p>A Column definition class which renders a passed date according to the default locale, or a configured
1225 * {@link #format}. See the {@link Ext.list.Column#xtype xtype} config option of {@link Ext.list.Column}
1226 * for more details.</p>
1228 Ext.list.DateColumn = Ext.extend(Ext.list.Column, {
1230 constructor : function(c) {
1231 c.tpl = c.tpl || new Ext.XTemplate('{' + c.dataIndex + ':date("' + (c.format || this.format) + '")}');
1232 Ext.list.DateColumn.superclass.constructor.call(this, c);
1235 Ext.reg('lvdatecolumn', Ext.list.DateColumn);
1238 * @class Ext.list.BooleanColumn
1239 * @extends Ext.list.Column
1240 * <p>A Column definition class which renders boolean data fields. See the {@link Ext.list.Column#xtype xtype}
1241 * config option of {@link Ext.list.Column} for more details.</p>
1243 Ext.list.BooleanColumn = Ext.extend(Ext.list.Column, {
1245 * @cfg {String} trueText
1246 * The string returned by the renderer when the column value is not falsey (defaults to <tt>'true'</tt>).
1250 * @cfg {String} falseText
1251 * The string returned by the renderer when the column value is falsey (but not undefined) (defaults to
1252 * <tt>'false'</tt>).
1256 * @cfg {String} undefinedText
1257 * The string returned by the renderer when the column value is undefined (defaults to <tt>' '</tt>).
1259 undefinedText: ' ',
1261 constructor : function(c) {
1262 c.tpl = c.tpl || new Ext.XTemplate('{' + c.dataIndex + ':this.format}');
1264 var t = this.trueText, f = this.falseText, u = this.undefinedText;
1265 c.tpl.format = function(v){
1266 if(v === undefined){
1269 if(!v || v === 'false'){
1275 Ext.list.DateColumn.superclass.constructor.call(this, c);
1279 Ext.reg('lvbooleancolumn', Ext.list.BooleanColumn);/**
\r
1280 * @class Ext.list.ColumnResizer
\r
1281 * @extends Ext.util.Observable
\r
1282 * <p>Supporting Class for Ext.list.ListView</p>
\r
1284 * @param {Object} config
\r
1286 Ext.list.ColumnResizer = Ext.extend(Ext.util.Observable, {
\r
1288 * @cfg {Number} minPct The minimum percentage to allot for any column (defaults to <tt>.05</tt>)
\r
1292 constructor: function(config){
\r
1293 Ext.apply(this, config);
\r
1294 Ext.list.ColumnResizer.superclass.constructor.call(this);
\r
1296 init : function(listView){
\r
1297 this.view = listView;
\r
1298 listView.on('render', this.initEvents, this);
\r
1301 initEvents : function(view){
\r
1302 view.mon(view.innerHd, 'mousemove', this.handleHdMove, this);
\r
1303 this.tracker = new Ext.dd.DragTracker({
\r
1304 onBeforeStart: this.onBeforeStart.createDelegate(this),
\r
1305 onStart: this.onStart.createDelegate(this),
\r
1306 onDrag: this.onDrag.createDelegate(this),
\r
1307 onEnd: this.onEnd.createDelegate(this),
\r
1311 this.tracker.initEl(view.innerHd);
\r
1312 view.on('beforedestroy', this.tracker.destroy, this.tracker);
\r
1315 handleHdMove : function(e, t){
\r
1318 hd = e.getTarget('em', 3, true);
\r
1320 var r = hd.getRegion(),
\r
1321 ss = hd.dom.style,
\r
1322 pn = hd.dom.parentNode;
\r
1324 if(x - r.left <= hw && pn != pn.parentNode.firstChild){
\r
1325 this.activeHd = Ext.get(pn.previousSibling.firstChild);
\r
1326 ss.cursor = Ext.isWebKit ? 'e-resize' : 'col-resize';
\r
1327 } else if(r.right - x <= hw && pn != pn.parentNode.lastChild.previousSibling){
\r
1328 this.activeHd = hd;
\r
1329 ss.cursor = Ext.isWebKit ? 'w-resize' : 'col-resize';
\r
1331 delete this.activeHd;
\r
1337 onBeforeStart : function(e){
\r
1338 this.dragHd = this.activeHd;
\r
1339 return !!this.dragHd;
\r
1342 onStart: function(e){
\r
1343 this.view.disableHeaders = true;
\r
1344 this.proxy = this.view.el.createChild({cls:'x-list-resizer'});
\r
1345 this.proxy.setHeight(this.view.el.getHeight());
\r
1347 var x = this.tracker.getXY()[0],
\r
1348 w = this.view.innerHd.getWidth();
\r
1350 this.hdX = this.dragHd.getX();
\r
1351 this.hdIndex = this.view.findHeaderIndex(this.dragHd);
\r
1353 this.proxy.setX(this.hdX);
\r
1354 this.proxy.setWidth(x-this.hdX);
\r
1356 this.minWidth = w*this.minPct;
\r
1357 this.maxWidth = w - (this.minWidth*(this.view.columns.length-1-this.hdIndex));
\r
1360 onDrag: function(e){
\r
1361 var cursorX = this.tracker.getXY()[0];
\r
1362 this.proxy.setWidth((cursorX-this.hdX).constrain(this.minWidth, this.maxWidth));
\r
1365 onEnd: function(e){
\r
1366 /* calculate desired width by measuring proxy and then remove it */
\r
1367 var nw = this.proxy.getWidth();
\r
1368 this.proxy.remove();
\r
1370 var index = this.hdIndex,
\r
1374 w = this.view.innerHd.getWidth(),
\r
1375 minPct = this.minPct * 100,
\r
1376 pct = Math.ceil((nw * vw.maxWidth) / w),
\r
1377 diff = (cs[index].width * 100) - pct,
\r
1378 each = Math.floor(diff / (len-1-index)),
\r
1379 mod = diff - (each * (len-1-index));
\r
1381 for(var i = index+1; i < len; i++){
\r
1382 var cw = (cs[i].width * 100) + each,
\r
1383 ncw = Math.max(minPct, cw);
\r
1387 cs[i].width = ncw / 100;
\r
1389 cs[index].width = pct / 100;
\r
1390 cs[index+1].width += (mod / 100);
\r
1391 delete this.dragHd;
\r
1394 setTimeout(function(){
\r
1395 vw.disableHeaders = false;
\r
1400 // Backwards compatibility alias
\r
1401 Ext.ListView.ColumnResizer = Ext.list.ColumnResizer;/**
\r
1402 * @class Ext.list.Sorter
\r
1403 * @extends Ext.util.Observable
\r
1404 * <p>Supporting Class for Ext.list.ListView</p>
\r
1406 * @param {Object} config
\r
1408 Ext.list.Sorter = Ext.extend(Ext.util.Observable, {
\r
1410 * @cfg {Array} sortClasses
\r
1411 * The CSS classes applied to a header when it is sorted. (defaults to <tt>["sort-asc", "sort-desc"]</tt>)
\r
1413 sortClasses : ["sort-asc", "sort-desc"],
\r
1415 constructor: function(config){
\r
1416 Ext.apply(this, config);
\r
1417 Ext.list.Sorter.superclass.constructor.call(this);
\r
1420 init : function(listView){
\r
1421 this.view = listView;
\r
1422 listView.on('render', this.initEvents, this);
\r
1425 initEvents : function(view){
\r
1426 view.mon(view.innerHd, 'click', this.onHdClick, this);
\r
1427 view.innerHd.setStyle('cursor', 'pointer');
\r
1428 view.mon(view.store, 'datachanged', this.updateSortState, this);
\r
1429 this.updateSortState.defer(10, this, [view.store]);
\r
1432 updateSortState : function(store){
\r
1433 var state = store.getSortState();
\r
1437 this.sortState = state;
\r
1438 var cs = this.view.columns, sortColumn = -1;
\r
1439 for(var i = 0, len = cs.length; i < len; i++){
\r
1440 if(cs[i].dataIndex == state.field){
\r
1445 if(sortColumn != -1){
\r
1446 var sortDir = state.direction;
\r
1447 this.updateSortIcon(sortColumn, sortDir);
\r
1451 updateSortIcon : function(col, dir){
\r
1452 var sc = this.sortClasses;
\r
1453 var hds = this.view.innerHd.select('em').removeClass(sc);
\r
1454 hds.item(col).addClass(sc[dir == "DESC" ? 1 : 0]);
\r
1457 onHdClick : function(e){
\r
1458 var hd = e.getTarget('em', 3);
\r
1459 if(hd && !this.view.disableHeaders){
\r
1460 var index = this.view.findHeaderIndex(hd);
\r
1461 this.view.store.sort(this.view.columns[index].dataIndex);
\r
1466 // Backwards compatibility alias
\r
1467 Ext.ListView.Sorter = Ext.list.Sorter;