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);
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(){
744 Ext.DataView.superclass.onDestroy.call(this);
745 this.bindStore(null);
750 * Changes the data store bound to this view and refreshes it. (deprecated in favor of bindStore)
751 * @param {Store} store The store to bind to this view
753 Ext.DataView.prototype.setStore = Ext.DataView.prototype.bindStore;
755 Ext.reg('dataview', Ext.DataView);