/*!
+ * Ext JS Library 3.2.1
+ * Copyright(c) 2006-2010 Ext JS, Inc.
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+/**
* @class Ext.DataView
* @extends Ext.BoxComponent
* A mechanism for displaying data using custom layout templates and formatting. DataView uses an {@link Ext.XTemplate}
@@ -123,6 +130,12 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
* @cfg {Boolean} trackOver True to enable mouseenter and mouseleave events
*/
trackOver: false,
+
+ /**
+ * @cfg {Boolean} blockRefresh Set this to true to ignore datachanged events on the bound store. This is useful if
+ * you wish to provide custom transition animations via a plugin (defaults to false)
+ */
+ blockRefresh: false,
//private
last: false,
@@ -155,7 +168,7 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
"click",
/**
* @event mouseenter
- * Fires when the mouse enters a template node. trackOver:true or an overCls must be set to enable this event.
+ * Fires when the mouse enters a template node. trackOver:true or an overClass must be set to enable this event.
* @param {Ext.DataView} this
* @param {Number} index The index of the target node
* @param {HTMLElement} node The target node
@@ -164,7 +177,7 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
"mouseenter",
/**
* @event mouseleave
- * Fires when the mouse leaves a template node. trackOver:true or an overCls must be set to enable this event.
+ * Fires when the mouse leaves a template node. trackOver:true or an overClass must be set to enable this event.
* @param {Ext.DataView} this
* @param {Number} index The index of the target node
* @param {HTMLElement} node The target node
@@ -253,7 +266,7 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
/**
* Refreshes the view by reloading the data from the store and re-rendering the template.
*/
- refresh : function(){
+ refresh : function() {
this.clearSelections(false, true);
var el = this.getTemplateTarget();
el.update("");
@@ -318,16 +331,18 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
// 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);
+ if(index > -1){
+ 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);
}
- this.updateIndexes(index, index);
},
// private
@@ -389,14 +404,18 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
*/
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();
+ }else{
+ this.store.un("beforeload", this.onBeforeLoad, this);
+ this.store.un("datachanged", this.onDataChanged, 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 = null;
}
}
if(store){
@@ -404,7 +423,7 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
store.on({
scope: this,
beforeload: this.onBeforeLoad,
- datachanged: this.refresh,
+ datachanged: this.onDataChanged,
add: this.onAdd,
remove: this.onRemove,
update: this.onUpdate,
@@ -416,6 +435,16 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
this.refresh();
}
},
+
+ /**
+ * @private
+ * Calls this.refresh if this.blockRefresh is not true
+ */
+ onDataChanged: function() {
+ if (this.blockRefresh !== true) {
+ this.refresh.apply(this, arguments);
+ }
+ },
/**
* Returns the template node the passed child belongs to, or null if it doesn't belong to one.
@@ -604,7 +633,7 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
/**
* Returns true if the passed node is selected, else false.
- * @param {HTMLElement/Number} node The node or node index to check
+ * @param {HTMLElement/Number/Ext.data.Record} node The node, node index or record to check
* @return {Boolean} True if selected, else false
*/
isSelected : function(node){
@@ -613,7 +642,7 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
/**
* Deselects a node.
- * @param {HTMLElement/Number} node The node to deselect
+ * @param {HTMLElement/Number/Record} node The node, node index or record to deselect
*/
deselect : function(node){
if(this.isSelected(node)){
@@ -629,8 +658,8 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
/**
* 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 {Array/HTMLElement/String/Number/Ext.data.Record} nodeInfo An HTMLElement template node, index of a template node,
+ * id of a template node, record associated with a 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
*/
@@ -678,7 +707,8 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
/**
* 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
+ * @param {HTMLElement/String/Number/Ext.data.Record} nodeInfo An HTMLElement template node, index of a template node,
+ * the id of a template node or the record associated with the node.
* @return {HTMLElement} The node or null if it wasn't found
*/
getNode : function(nodeInfo){
@@ -686,6 +716,9 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
return document.getElementById(nodeInfo);
}else if(Ext.isNumber(nodeInfo)){
return this.all.elements[nodeInfo];
+ }else if(nodeInfo instanceof Ext.data.Record){
+ var idx = this.store.indexOf(nodeInfo);
+ return this.all.elements[idx];
}
return nodeInfo;
},
@@ -715,7 +748,8 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
/**
* 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
+ * @param {HTMLElement/String/Number/Record} nodeInfo An HTMLElement template node, index of a template node, the id of a template node
+ * or a record associated with a node.
* @return {Number} The index of the node or -1
*/
indexOf : function(node){
@@ -736,6 +770,8 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
},
onDestroy : function(){
+ this.all.clear();
+ this.selected.clear();
Ext.DataView.superclass.onDestroy.call(this);
this.bindStore(null);
}
@@ -747,6 +783,7 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
*/
Ext.DataView.prototype.setStore = Ext.DataView.prototype.bindStore;
-Ext.reg('dataview', Ext.DataView);