3 * Copyright(c) 2006-2010 Sencha Inc.
5 * http://www.sencha.com/license
9 * @extends Ext.BoxComponent
10 * A mechanism for displaying data using custom layout templates and formatting. DataView uses an {@link Ext.XTemplate}
11 * as its internal templating mechanism, and is bound to an {@link Ext.data.Store}
12 * so that as the data in the store changes the view is automatically updated to reflect the changes. The view also
13 * provides built-in behavior for many common events that can occur for its contained items including click, doubleclick,
14 * mouseover, mouseout, etc. as well as a built-in selection model. <b>In order to use these features, an {@link #itemSelector}
15 * config must be provided for the DataView to determine what nodes it will be working with.</b>
17 * <p>The example below binds a DataView to a {@link Ext.data.Store} and renders it into an {@link Ext.Panel}.</p>
19 var store = new Ext.data.JsonStore({
20 url: 'get-images.php',
24 {name:'size', type: 'float'},
25 {name:'lastmod', type:'date', dateFormat:'timestamp'}
30 var tpl = new Ext.XTemplate(
31 '<tpl for=".">',
32 '<div class="thumb-wrap" id="{name}">',
33 '<div class="thumb"><img src="{url}" title="{name}"></div>',
34 '<span class="x-editable">{shortName}</span></div>',
36 '<div class="x-clear"></div>'
39 var panel = new Ext.Panel({
46 title:'Simple DataView',
48 items: new Ext.DataView({
53 overClass:'x-view-over',
54 itemSelector:'div.thumb-wrap',
55 emptyText: 'No images to display'
58 panel.render(document.body);
61 * Create a new DataView
62 * @param {Object} config The config object
65 Ext.DataView = Ext.extend(Ext.BoxComponent, {
67 * @cfg {String/Array} tpl
68 * The HTML fragment or an array of fragments that will make up the template used by this DataView. This should
69 * be specified in the same format expected by the constructor of {@link Ext.XTemplate}.
72 * @cfg {Ext.data.Store} store
73 * The {@link Ext.data.Store} to bind this DataView to.
76 * @cfg {String} itemSelector
77 * <b>This is a required setting</b>. A simple CSS selector (e.g. <tt>div.some-class</tt> or
78 * <tt>span:first-child</tt>) that will be used to determine what nodes this DataView will be
82 * @cfg {Boolean} multiSelect
83 * True to allow selection of more than one item at a time, false to allow selection of only a single item
84 * at a time or no selection at all, depending on the value of {@link #singleSelect} (defaults to false).
87 * @cfg {Boolean} singleSelect
88 * True to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false).
89 * Note that if {@link #multiSelect} = true, this value will be ignored.
92 * @cfg {Boolean} simpleSelect
93 * True to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl,
94 * false to force the user to hold Ctrl or Shift to select more than on item (defaults to false).
97 * @cfg {String} overClass
98 * A CSS class to apply to each item in the view on mouseover (defaults to undefined).
101 * @cfg {String} loadingText
102 * A string to display during data load operations (defaults to undefined). If specified, this text will be
103 * displayed in a loading div and the view's contents will be cleared while loading, otherwise the view's
104 * contents will continue to display normally until the new data is loaded and the contents are replaced.
107 * @cfg {String} selectedClass
108 * A CSS class to apply to each selected item in the view (defaults to 'x-view-selected').
110 selectedClass : "x-view-selected",
112 * @cfg {String} emptyText
113 * The text to display in the view when there is no data to display (defaults to '').
118 * @cfg {Boolean} deferEmptyText True to defer emptyText being applied until the store's first load
120 deferEmptyText: true,
122 * @cfg {Boolean} trackOver True to enable mouseenter and mouseleave events
127 * @cfg {Boolean} blockRefresh Set this to true to ignore datachanged events on the bound store. This is useful if
128 * you wish to provide custom transition animations via a plugin (defaults to false)
136 initComponent : function(){
137 Ext.DataView.superclass.initComponent.call(this);
138 if(Ext.isString(this.tpl) || Ext.isArray(this.tpl)){
139 this.tpl = new Ext.XTemplate(this.tpl);
145 * Fires before a click is processed. Returns false to cancel the default action.
146 * @param {Ext.DataView} this
147 * @param {Number} index The index of the target node
148 * @param {HTMLElement} node The target node
149 * @param {Ext.EventObject} e The raw event object
154 * Fires when a template node is clicked.
155 * @param {Ext.DataView} this
156 * @param {Number} index The index of the target node
157 * @param {HTMLElement} node The target node
158 * @param {Ext.EventObject} e The raw event object
163 * Fires when the mouse enters a template node. trackOver:true or an overClass must be set to enable this event.
164 * @param {Ext.DataView} this
165 * @param {Number} index The index of the target node
166 * @param {HTMLElement} node The target node
167 * @param {Ext.EventObject} e The raw event object
172 * Fires when the mouse leaves a template node. trackOver:true or an overClass must be set to enable this event.
173 * @param {Ext.DataView} this
174 * @param {Number} index The index of the target node
175 * @param {HTMLElement} node The target node
176 * @param {Ext.EventObject} e The raw event object
180 * @event containerclick
181 * Fires when a click occurs and it is not on a template node.
182 * @param {Ext.DataView} this
183 * @param {Ext.EventObject} e The raw event object
188 * Fires when a template node is double clicked.
189 * @param {Ext.DataView} this
190 * @param {Number} index The index of the target node
191 * @param {HTMLElement} node The target node
192 * @param {Ext.EventObject} e The raw event object
197 * Fires when a template node is right clicked.
198 * @param {Ext.DataView} this
199 * @param {Number} index The index of the target node
200 * @param {HTMLElement} node The target node
201 * @param {Ext.EventObject} e The raw event object
205 * @event containercontextmenu
206 * Fires when a right click occurs that is not on a template node.
207 * @param {Ext.DataView} this
208 * @param {Ext.EventObject} e The raw event object
210 "containercontextmenu",
212 * @event selectionchange
213 * Fires when the selected nodes change.
214 * @param {Ext.DataView} this
215 * @param {Array} selections Array of the selected nodes
220 * @event beforeselect
221 * Fires before a selection is made. If any handlers return false, the selection is cancelled.
222 * @param {Ext.DataView} this
223 * @param {HTMLElement} node The node to be selected
224 * @param {Array} selections Array of currently selected nodes
229 this.store = Ext.StoreMgr.lookup(this.store);
230 this.all = new Ext.CompositeElementLite();
231 this.selected = new Ext.CompositeElementLite();
235 afterRender : function(){
236 Ext.DataView.superclass.afterRender.call(this);
238 this.mon(this.getTemplateTarget(), {
239 "click": this.onClick,
240 "dblclick": this.onDblClick,
241 "contextmenu": this.onContextMenu,
245 if(this.overClass || this.trackOver){
246 this.mon(this.getTemplateTarget(), {
247 "mouseover": this.onMouseOver,
248 "mouseout": this.onMouseOut,
254 this.bindStore(this.store, true);
259 * Refreshes the view by reloading the data from the store and re-rendering the template.
261 refresh : function() {
262 this.clearSelections(false, true);
263 var el = this.getTemplateTarget(),
264 records = this.store.getRange();
267 if(records.length < 1){
268 if(!this.deferEmptyText || this.hasSkippedEmptyText){
269 el.update(this.emptyText);
273 this.tpl.overwrite(el, this.collectData(records, 0));
274 this.all.fill(Ext.query(this.itemSelector, el.dom));
275 this.updateIndexes(0);
277 this.hasSkippedEmptyText = true;
280 getTemplateTarget: function(){
285 * Function which can be overridden to provide custom formatting for each Record that is used by this
286 * DataView's {@link #tpl template} to render each node.
287 * @param {Array/Object} data The raw data object that was used to create the Record.
288 * @param {Number} recordIndex the index number of the Record being prepared for rendering.
289 * @param {Record} record The Record being prepared for rendering.
290 * @return {Array/Object} The formatted data in a format expected by the internal {@link #tpl template}'s overwrite() method.
291 * (either an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}))
293 prepareData : function(data){
298 * <p>Function which can be overridden which returns the data object passed to this
299 * DataView's {@link #tpl template} to render the whole DataView.</p>
300 * <p>This is usually an Array of data objects, each element of which is processed by an
301 * {@link Ext.XTemplate XTemplate} which uses <tt>'<tpl for=".">'</tt> to iterate over its supplied
302 * data object as an Array. However, <i>named</i> properties may be placed into the data object to
303 * provide non-repeating data such as headings, totals etc.</p>
304 * @param {Array} records An Array of {@link Ext.data.Record}s to be rendered into the DataView.
305 * @param {Number} startIndex the index number of the Record being prepared for rendering.
306 * @return {Array} An Array of data objects to be processed by a repeating XTemplate. May also
307 * contain <i>named</i> properties.
309 collectData : function(records, startIndex){
312 len = records.length;
314 r[r.length] = this.prepareData(records[i].data, startIndex + i, records[i]);
320 bufferRender : function(records, index){
321 var div = document.createElement('div');
322 this.tpl.overwrite(div, this.collectData(records, index));
323 return Ext.query(this.itemSelector, div);
327 onUpdate : function(ds, record){
328 var index = this.store.indexOf(record);
330 var sel = this.isSelected(index),
331 original = this.all.elements[index],
332 node = this.bufferRender([record], index)[0];
334 this.all.replaceElement(index, node, true);
336 this.selected.replaceElement(original, node);
337 this.all.item(index).addClass(this.selectedClass);
339 this.updateIndexes(index, index);
344 onAdd : function(ds, records, index){
345 if(this.all.getCount() === 0){
349 var nodes = this.bufferRender(records, index), n, a = this.all.elements;
350 if(index < this.all.getCount()){
351 n = this.all.item(index).insertSibling(nodes, 'before', true);
352 a.splice.apply(a, [index, 0].concat(nodes));
354 n = this.all.last().insertSibling(nodes, 'after', true);
355 a.push.apply(a, nodes);
357 this.updateIndexes(index);
361 onRemove : function(ds, record, index){
362 this.deselect(index);
363 this.all.removeElement(index, true);
364 this.updateIndexes(index);
365 if (this.store.getCount() === 0){
371 * Refreshes an individual node's data from the store.
372 * @param {Number} index The item's data index in the store
374 refreshNode : function(index){
375 this.onUpdate(this.store, this.store.getAt(index));
379 updateIndexes : function(startIndex, endIndex){
380 var ns = this.all.elements;
381 startIndex = startIndex || 0;
382 endIndex = endIndex || ((endIndex === 0) ? 0 : (ns.length - 1));
383 for(var i = startIndex; i <= endIndex; i++){
389 * Returns the store associated with this DataView.
390 * @return {Ext.data.Store} The store
392 getStore : function(){
397 * Changes the data store bound to this view and refreshes it.
398 * @param {Store} store The store to bind to this view
400 bindStore : function(store, initial){
401 if(!initial && this.store){
402 if(store !== this.store && this.store.autoDestroy){
403 this.store.destroy();
405 this.store.un("beforeload", this.onBeforeLoad, this);
406 this.store.un("datachanged", this.onDataChanged, this);
407 this.store.un("add", this.onAdd, this);
408 this.store.un("remove", this.onRemove, this);
409 this.store.un("update", this.onUpdate, this);
410 this.store.un("clear", this.refresh, this);
417 store = Ext.StoreMgr.lookup(store);
420 beforeload: this.onBeforeLoad,
421 datachanged: this.onDataChanged,
423 remove: this.onRemove,
424 update: this.onUpdate,
436 * Calls this.refresh if this.blockRefresh is not true
438 onDataChanged: function() {
439 if (this.blockRefresh !== true) {
440 this.refresh.apply(this, arguments);
445 * Returns the template node the passed child belongs to, or null if it doesn't belong to one.
446 * @param {HTMLElement} node
447 * @return {HTMLElement} The template node
449 findItemFromChild : function(node){
450 return Ext.fly(node).findParent(this.itemSelector, this.getTemplateTarget());
454 onClick : function(e){
455 var item = e.getTarget(this.itemSelector, this.getTemplateTarget()),
458 index = this.indexOf(item);
459 if(this.onItemClick(item, index, e) !== false){
460 this.fireEvent("click", this, index, item, e);
463 if(this.fireEvent("containerclick", this, e) !== false){
464 this.onContainerClick(e);
469 onContainerClick : function(e){
470 this.clearSelections();
474 onContextMenu : function(e){
475 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
477 this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
479 this.fireEvent("containercontextmenu", this, e);
484 onDblClick : function(e){
485 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
487 this.fireEvent("dblclick", this, this.indexOf(item), item, e);
492 onMouseOver : function(e){
493 var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
494 if(item && item !== this.lastItem){
495 this.lastItem = item;
496 Ext.fly(item).addClass(this.overClass);
497 this.fireEvent("mouseenter", this, this.indexOf(item), item, e);
502 onMouseOut : function(e){
504 if(!e.within(this.lastItem, true, true)){
505 Ext.fly(this.lastItem).removeClass(this.overClass);
506 this.fireEvent("mouseleave", this, this.indexOf(this.lastItem), this.lastItem, e);
507 delete this.lastItem;
513 onItemClick : function(item, index, e){
514 if(this.fireEvent("beforeclick", this, index, item, e) === false){
517 if(this.multiSelect){
518 this.doMultiSelection(item, index, e);
520 }else if(this.singleSelect){
521 this.doSingleSelection(item, index, e);
528 doSingleSelection : function(item, index, e){
529 if(e.ctrlKey && this.isSelected(index)){
530 this.deselect(index);
532 this.select(index, false);
537 doMultiSelection : function(item, index, e){
538 if(e.shiftKey && this.last !== false){
539 var last = this.last;
540 this.selectRange(last, index, e.ctrlKey);
541 this.last = last; // reset the last
543 if((e.ctrlKey||this.simpleSelect) && this.isSelected(index)){
544 this.deselect(index);
546 this.select(index, e.ctrlKey || e.shiftKey || this.simpleSelect);
552 * Gets the number of selected nodes.
553 * @return {Number} The node count
555 getSelectionCount : function(){
556 return this.selected.getCount();
560 * Gets the currently selected nodes.
561 * @return {Array} An array of HTMLElements
563 getSelectedNodes : function(){
564 return this.selected.elements;
568 * Gets the indexes of the selected nodes.
569 * @return {Array} An array of numeric indexes
571 getSelectedIndexes : function(){
573 selected = this.selected.elements,
575 len = selected.length;
578 indexes.push(selected[i].viewIndex);
584 * Gets an array of the selected records
585 * @return {Array} An array of {@link Ext.data.Record} objects
587 getSelectedRecords : function(){
588 return this.getRecords(this.selected.elements);
592 * Gets an array of the records from an array of nodes
593 * @param {Array} nodes The nodes to evaluate
594 * @return {Array} records The {@link Ext.data.Record} objects
596 getRecords : function(nodes){
602 records[records.length] = this.store.getAt(nodes[i].viewIndex);
608 * Gets a record from a node
609 * @param {HTMLElement} node The node to evaluate
610 * @return {Record} record The {@link Ext.data.Record} object
612 getRecord : function(node){
613 return this.store.getAt(node.viewIndex);
617 * Clears all selections.
618 * @param {Boolean} suppressEvent (optional) True to skip firing of the selectionchange event
620 clearSelections : function(suppressEvent, skipUpdate){
621 if((this.multiSelect || this.singleSelect) && this.selected.getCount() > 0){
623 this.selected.removeClass(this.selectedClass);
625 this.selected.clear();
628 this.fireEvent("selectionchange", this, this.selected.elements);
634 * Returns true if the passed node is selected, else false.
635 * @param {HTMLElement/Number/Ext.data.Record} node The node, node index or record to check
636 * @return {Boolean} True if selected, else false
638 isSelected : function(node){
639 return this.selected.contains(this.getNode(node));
644 * @param {HTMLElement/Number/Record} node The node, node index or record to deselect
646 deselect : function(node){
647 if(this.isSelected(node)){
648 node = this.getNode(node);
649 this.selected.removeElement(node);
650 if(this.last == node.viewIndex){
653 Ext.fly(node).removeClass(this.selectedClass);
654 this.fireEvent("selectionchange", this, this.selected.elements);
659 * Selects a set of nodes.
660 * @param {Array/HTMLElement/String/Number/Ext.data.Record} nodeInfo An HTMLElement template node, index of a template node,
661 * id of a template node, record associated with a node or an array of any of those to select
662 * @param {Boolean} keepExisting (optional) true to keep existing selections
663 * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
665 select : function(nodeInfo, keepExisting, suppressEvent){
666 if(Ext.isArray(nodeInfo)){
668 this.clearSelections(true);
670 for(var i = 0, len = nodeInfo.length; i < len; i++){
671 this.select(nodeInfo[i], true, true);
674 this.fireEvent("selectionchange", this, this.selected.elements);
677 var node = this.getNode(nodeInfo);
679 this.clearSelections(true);
681 if(node && !this.isSelected(node)){
682 if(this.fireEvent("beforeselect", this, node, this.selected.elements) !== false){
683 Ext.fly(node).addClass(this.selectedClass);
684 this.selected.add(node);
685 this.last = node.viewIndex;
687 this.fireEvent("selectionchange", this, this.selected.elements);
695 * Selects a range of nodes. All nodes between start and end are selected.
696 * @param {Number} start The index of the first node in the range
697 * @param {Number} end The index of the last node in the range
698 * @param {Boolean} keepExisting (optional) True to retain existing selections
700 selectRange : function(start, end, keepExisting){
702 this.clearSelections(true);
704 this.select(this.getNodes(start, end), true);
708 * Gets a template node.
709 * @param {HTMLElement/String/Number/Ext.data.Record} nodeInfo An HTMLElement template node, index of a template node,
710 * the id of a template node or the record associated with the node.
711 * @return {HTMLElement} The node or null if it wasn't found
713 getNode : function(nodeInfo){
714 if(Ext.isString(nodeInfo)){
715 return document.getElementById(nodeInfo);
716 }else if(Ext.isNumber(nodeInfo)){
717 return this.all.elements[nodeInfo];
718 }else if(nodeInfo instanceof Ext.data.Record){
719 var idx = this.store.indexOf(nodeInfo);
720 return this.all.elements[idx];
726 * Gets a range nodes.
727 * @param {Number} start (optional) The index of the first node in the range
728 * @param {Number} end (optional) The index of the last node in the range
729 * @return {Array} An array of nodes
731 getNodes : function(start, end){
732 var ns = this.all.elements,
737 end = !Ext.isDefined(end) ? Math.max(ns.length - 1, 0) : end;
739 for(i = start; i <= end && ns[i]; i++){
743 for(i = start; i >= end && ns[i]; i--){
751 * Finds the index of the passed node.
752 * @param {HTMLElement/String/Number/Record} nodeInfo An HTMLElement template node, index of a template node, the id of a template node
753 * or a record associated with a node.
754 * @return {Number} The index of the node or -1
756 indexOf : function(node){
757 node = this.getNode(node);
758 if(Ext.isNumber(node.viewIndex)){
759 return node.viewIndex;
761 return this.all.indexOf(node);
765 onBeforeLoad : function(){
766 if(this.loadingText){
767 this.clearSelections(false, true);
768 this.getTemplateTarget().update('<div class="loading-indicator">'+this.loadingText+'</div>');
773 onDestroy : function(){
775 this.selected.clear();
776 Ext.DataView.superclass.onDestroy.call(this);
777 this.bindStore(null);
782 * Changes the data store bound to this view and refreshes it. (deprecated in favor of bindStore)
783 * @param {Store} store The store to bind to this view
785 Ext.DataView.prototype.setStore = Ext.DataView.prototype.bindStore;
787 Ext.reg('dataview', Ext.DataView);