The example below binds a DataView to a {@link Ext.data.Store} and renders it into an {@link Ext.Panel}.
+ *
+var store = new Ext.data.JsonStore({
+ url: 'get-images.php',
+ root: 'images',
+ fields: [
+ 'name', 'url',
+ {name:'size', type: 'float'},
+ {name:'lastmod', type:'date', dateFormat:'timestamp'}
+ ]
+});
+store.load();
+
+var tpl = new Ext.XTemplate(
+ '<tpl for=".">',
+ '<div class="thumb-wrap" id="{name}">',
+ '<div class="thumb"><img src="{url}" title="{name}"></div>',
+ '<span class="x-editable">{shortName}</span></div>',
+ '</tpl>',
+ '<div class="x-clear"></div>'
+);
+
+var panel = new Ext.Panel({
+ id:'images-view',
+ frame:true,
+ width:535,
+ autoHeight:true,
+ collapsible:true,
+ layout:'fit',
+ title:'Simple DataView',
+
+ items: new Ext.DataView({
+ store: store,
+ tpl: tpl,
+ autoHeight:true,
+ multiSelect: true,
+ overClass:'x-view-over',
+ itemSelector:'div.thumb-wrap',
+ emptyText: 'No images to display'
+ })
+});
+panel.render(document.body);
+Function which can be overridden which returns the data object passed to this + * DataView's {@link #tpl template} to render the whole DataView.
+ *This is usually an Array of data objects, each element of which is processed by an + * {@link Ext.XTemplate XTemplate} which uses '<tpl for=".">' to iterate over its supplied + * data object as an Array. However, named properties may be placed into the data object to + * provide non-repeating data such as headings, totals etc.
+ * @param {Array} records An Array of {@link Ext.data.Record}s to be rendered into the DataView. + * @param {Number} startIndex the index number of the Record being prepared for rendering. + * @return {Array} An Array of data objects to be processed by a repeating XTemplate. May also + * contain named properties. + */ + collectData : function(records, startIndex){ + var r = []; + for(var i = 0, len = records.length; i < len; i++){ + r[r.length] = this.prepareData(records[i].data, startIndex+i, records[i]); + } + return r; + }, + + // private + bufferRender : function(records){ + var div = document.createElement('div'); + this.tpl.overwrite(div, this.collectData(records)); + return Ext.query(this.itemSelector, div); + }, + + // private + onUpdate : function(ds, record){ + var index = this.store.indexOf(record); + var sel = this.isSelected(index); + var original = this.all.elements[index]; + var node = this.bufferRender([record], index)[0]; + + this.all.replaceElement(index, node, true); + if(sel){ + this.selected.replaceElement(original, node); + this.all.item(index).addClass(this.selectedClass); + } + this.updateIndexes(index, index); + }, + + // private + onAdd : function(ds, records, index){ + if(this.all.getCount() === 0){ + this.refresh(); + return; + } + var nodes = this.bufferRender(records, index), n, a = this.all.elements; + if(index < this.all.getCount()){ + n = this.all.item(index).insertSibling(nodes, 'before', true); + a.splice.apply(a, [index, 0].concat(nodes)); + }else{ + n = this.all.last().insertSibling(nodes, 'after', true); + a.push.apply(a, nodes); + } + this.updateIndexes(index); + }, + + // private + onRemove : function(ds, record, index){ + this.deselect(index); + this.all.removeElement(index, true); + this.updateIndexes(index); + if (this.store.getCount() === 0){ + this.refresh(); + } + }, + + /** + * Refreshes an individual node's data from the store. + * @param {Number} index The item's data index in the store + */ + refreshNode : function(index){ + this.onUpdate(this.store, this.store.getAt(index)); + }, + + // private + updateIndexes : function(startIndex, endIndex){ + var ns = this.all.elements; + startIndex = startIndex || 0; + endIndex = endIndex || ((endIndex === 0) ? 0 : (ns.length - 1)); + for(var i = startIndex; i <= endIndex; i++){ + ns[i].viewIndex = i; + } + }, + + /** + * Returns the store associated with this DataView. + * @return {Ext.data.Store} The store + */ + getStore : function(){ + return this.store; + }, + + /** + * Changes the data store bound to this view and refreshes it. + * @param {Store} store The store to bind to this view + */ + bindStore : function(store, initial){ + if(!initial && this.store){ + this.store.un("beforeload", this.onBeforeLoad, this); + this.store.un("datachanged", this.refresh, this); + this.store.un("add", this.onAdd, this); + this.store.un("remove", this.onRemove, this); + this.store.un("update", this.onUpdate, this); + this.store.un("clear", this.refresh, this); + if(store !== this.store && this.store.autoDestroy){ + this.store.destroy(); + } + } + if(store){ + store = Ext.StoreMgr.lookup(store); + store.on({ + scope: this, + beforeload: this.onBeforeLoad, + datachanged: this.refresh, + add: this.onAdd, + remove: this.onRemove, + update: this.onUpdate, + clear: this.refresh + }); + } + this.store = store; + if(store){ + this.refresh(); + } + }, + + /** + * Returns the template node the passed child belongs to, or null if it doesn't belong to one. + * @param {HTMLElement} node + * @return {HTMLElement} The template node + */ + findItemFromChild : function(node){ + return Ext.fly(node).findParent(this.itemSelector, this.getTemplateTarget()); + }, + + // private + onClick : function(e){ + var item = e.getTarget(this.itemSelector, this.getTemplateTarget()); + if(item){ + var index = this.indexOf(item); + if(this.onItemClick(item, index, e) !== false){ + this.fireEvent("click", this, index, item, e); + } + }else{ + if(this.fireEvent("containerclick", this, e) !== false){ + this.onContainerClick(e); + } + } + }, + + onContainerClick : function(e){ + this.clearSelections(); + }, + + // private + onContextMenu : function(e){ + var item = e.getTarget(this.itemSelector, this.getTemplateTarget()); + if(item){ + this.fireEvent("contextmenu", this, this.indexOf(item), item, e); + }else{ + this.fireEvent("containercontextmenu", this, e); + } + }, + + // private + onDblClick : function(e){ + var item = e.getTarget(this.itemSelector, this.getTemplateTarget()); + if(item){ + this.fireEvent("dblclick", this, this.indexOf(item), item, e); + } + }, + + // private + onMouseOver : function(e){ + var item = e.getTarget(this.itemSelector, this.getTemplateTarget()); + if(item && item !== this.lastItem){ + this.lastItem = item; + Ext.fly(item).addClass(this.overClass); + this.fireEvent("mouseenter", this, this.indexOf(item), item, e); + } + }, + + // private + onMouseOut : function(e){ + if(this.lastItem){ + if(!e.within(this.lastItem, true, true)){ + Ext.fly(this.lastItem).removeClass(this.overClass); + this.fireEvent("mouseleave", this, this.indexOf(this.lastItem), this.lastItem, e); + delete this.lastItem; + } + } + }, + + // private + onItemClick : function(item, index, e){ + if(this.fireEvent("beforeclick", this, index, item, e) === false){ + return false; + } + if(this.multiSelect){ + this.doMultiSelection(item, index, e); + e.preventDefault(); + }else if(this.singleSelect){ + this.doSingleSelection(item, index, e); + e.preventDefault(); + } + return true; + }, + + // private + doSingleSelection : function(item, index, e){ + if(e.ctrlKey && this.isSelected(index)){ + this.deselect(index); + }else{ + this.select(index, false); + } + }, + + // private + doMultiSelection : function(item, index, e){ + if(e.shiftKey && this.last !== false){ + var last = this.last; + this.selectRange(last, index, e.ctrlKey); + this.last = last; // reset the last + }else{ + if((e.ctrlKey||this.simpleSelect) && this.isSelected(index)){ + this.deselect(index); + }else{ + this.select(index, e.ctrlKey || e.shiftKey || this.simpleSelect); + } + } + }, + + /** + * Gets the number of selected nodes. + * @return {Number} The node count + */ + getSelectionCount : function(){ + return this.selected.getCount(); + }, + + /** + * Gets the currently selected nodes. + * @return {Array} An array of HTMLElements + */ + getSelectedNodes : function(){ + return this.selected.elements; + }, + + /** + * Gets the indexes of the selected nodes. + * @return {Array} An array of numeric indexes + */ + getSelectedIndexes : function(){ + var indexes = [], s = this.selected.elements; + for(var i = 0, len = s.length; i < len; i++){ + indexes.push(s[i].viewIndex); + } + return indexes; + }, + + /** + * Gets an array of the selected records + * @return {Array} An array of {@link Ext.data.Record} objects + */ + getSelectedRecords : function(){ + var r = [], s = this.selected.elements; + for(var i = 0, len = s.length; i < len; i++){ + r[r.length] = this.store.getAt(s[i].viewIndex); + } + return r; + }, + + /** + * Gets an array of the records from an array of nodes + * @param {Array} nodes The nodes to evaluate + * @return {Array} records The {@link Ext.data.Record} objects + */ + getRecords : function(nodes){ + var r = [], s = nodes; + for(var i = 0, len = s.length; i < len; i++){ + r[r.length] = this.store.getAt(s[i].viewIndex); + } + return r; + }, + + /** + * Gets a record from a node + * @param {HTMLElement} node The node to evaluate + * @return {Record} record The {@link Ext.data.Record} object + */ + getRecord : function(node){ + return this.store.getAt(node.viewIndex); + }, + + /** + * Clears all selections. + * @param {Boolean} suppressEvent (optional) True to skip firing of the selectionchange event + */ + clearSelections : function(suppressEvent, skipUpdate){ + if((this.multiSelect || this.singleSelect) && this.selected.getCount() > 0){ + if(!skipUpdate){ + this.selected.removeClass(this.selectedClass); + } + this.selected.clear(); + this.last = false; + if(!suppressEvent){ + this.fireEvent("selectionchange", this, this.selected.elements); + } + } + }, + + /** + * Returns true if the passed node is selected, else false. + * @param {HTMLElement/Number} node The node or node index to check + * @return {Boolean} True if selected, else false + */ + isSelected : function(node){ + return this.selected.contains(this.getNode(node)); + }, + + /** + * Deselects a node. + * @param {HTMLElement/Number} node The node to deselect + */ + deselect : function(node){ + if(this.isSelected(node)){ + node = this.getNode(node); + this.selected.removeElement(node); + if(this.last == node.viewIndex){ + this.last = false; + } + Ext.fly(node).removeClass(this.selectedClass); + this.fireEvent("selectionchange", this, this.selected.elements); + } + }, + + /** + * Selects a set of nodes. + * @param {Array/HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node, + * id of a template node or an array of any of those to select + * @param {Boolean} keepExisting (optional) true to keep existing selections + * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent + */ + select : function(nodeInfo, keepExisting, suppressEvent){ + if(Ext.isArray(nodeInfo)){ + if(!keepExisting){ + this.clearSelections(true); + } + for(var i = 0, len = nodeInfo.length; i < len; i++){ + this.select(nodeInfo[i], true, true); + } + if(!suppressEvent){ + this.fireEvent("selectionchange", this, this.selected.elements); + } + } else{ + var node = this.getNode(nodeInfo); + if(!keepExisting){ + this.clearSelections(true); + } + if(node && !this.isSelected(node)){ + if(this.fireEvent("beforeselect", this, node, this.selected.elements) !== false){ + Ext.fly(node).addClass(this.selectedClass); + this.selected.add(node); + this.last = node.viewIndex; + if(!suppressEvent){ + this.fireEvent("selectionchange", this, this.selected.elements); + } + } + } + } + }, + + /** + * Selects a range of nodes. All nodes between start and end are selected. + * @param {Number} start The index of the first node in the range + * @param {Number} end The index of the last node in the range + * @param {Boolean} keepExisting (optional) True to retain existing selections + */ + selectRange : function(start, end, keepExisting){ + if(!keepExisting){ + this.clearSelections(true); + } + this.select(this.getNodes(start, end), true); + }, + + /** + * Gets a template node. + * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node + * @return {HTMLElement} The node or null if it wasn't found + */ + getNode : function(nodeInfo){ + if(Ext.isString(nodeInfo)){ + return document.getElementById(nodeInfo); + }else if(Ext.isNumber(nodeInfo)){ + return this.all.elements[nodeInfo]; + } + return nodeInfo; + }, + + /** + * Gets a range nodes. + * @param {Number} start (optional) The index of the first node in the range + * @param {Number} end (optional) The index of the last node in the range + * @return {Array} An array of nodes + */ + getNodes : function(start, end){ + var ns = this.all.elements; + start = start || 0; + end = !Ext.isDefined(end) ? Math.max(ns.length - 1, 0) : end; + var nodes = [], i; + if(start <= end){ + for(i = start; i <= end && ns[i]; i++){ + nodes.push(ns[i]); + } + } else{ + for(i = start; i >= end && ns[i]; i--){ + nodes.push(ns[i]); + } + } + return nodes; + }, + + /** + * Finds the index of the passed node. + * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node + * @return {Number} The index of the node or -1 + */ + indexOf : function(node){ + node = this.getNode(node); + if(Ext.isNumber(node.viewIndex)){ + return node.viewIndex; + } + return this.all.indexOf(node); + }, + + // private + onBeforeLoad : function(){ + if(this.loadingText){ + this.clearSelections(false, true); + this.getTemplateTarget().update('