git.ithinksw.org / extjs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Upgrade to ExtJS 3.2.1 - Released 04/27/2010
[extjs.git] / docs / source / DataView.html
diff --git a/docs/source/DataView.html b/docs/source/DataView.html
index 44c9582..0ad24e3 100644 (file)
--- a/docs/source/DataView.html
+++ b/docs/source/DataView.html
@@ -1,12 +1,18 @@
-<html>\r
-<head>\r
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js"><div id="cls-Ext.DataView"></div>/**
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
+  <title>The source code</title>
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+</head>
+<body  onload="prettyPrint();">
+    <pre class="prettyprint lang-js">/*!
+ * Ext JS Library 3.2.1
+ * Copyright(c) 2006-2010 Ext JS, Inc.
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+<div id="cls-Ext.DataView"></div>/**
  * @class Ext.DataView
  * @extends Ext.BoxComponent
  * A mechanism for displaying data using custom layout templates and formatting. DataView uses an {@link Ext.XTemplate}
  * @class Ext.DataView
  * @extends Ext.BoxComponent
  * A mechanism for displaying data using custom layout templates and formatting. DataView uses an {@link Ext.XTemplate}
@@ -124,6 +130,12 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
      * @cfg {Boolean} trackOver True to enable mouseenter and mouseleave events
      */
     trackOver: false,
      * @cfg {Boolean} trackOver True to enable mouseenter and mouseleave events
      */
     trackOver: false,
+    
+    <div id="cfg-Ext.DataView-blockRefresh"></div>/**
+     * @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,
 
     //private
     last: false,
@@ -254,7 +266,7 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
     <div id="method-Ext.DataView-refresh"></div>/**
      * Refreshes the view by reloading the data from the store and re-rendering the template.
      */
     <div id="method-Ext.DataView-refresh"></div>/**
      * 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("");
         this.clearSelections(false, true);
         var el = this.getTemplateTarget();
         el.update("");
@@ -396,7 +408,7 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
                 this.store.destroy();
             }else{
                 this.store.un("beforeload", this.onBeforeLoad, this);
                 this.store.destroy();
             }else{
                 this.store.un("beforeload", this.onBeforeLoad, this);
-                this.store.un("datachanged", this.refresh, 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("add", this.onAdd, this);
                 this.store.un("remove", this.onRemove, this);
                 this.store.un("update", this.onUpdate, this);
@@ -411,7 +423,7 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
             store.on({
                 scope: this,
                 beforeload: this.onBeforeLoad,
             store.on({
                 scope: this,
                 beforeload: this.onBeforeLoad,
-                datachanged: this.refresh,
+                datachanged: this.onDataChanged,
                 add: this.onAdd,
                 remove: this.onRemove,
                 update: this.onUpdate,
                 add: this.onAdd,
                 remove: this.onRemove,
                 update: this.onUpdate,
@@ -423,6 +435,16 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
             this.refresh();
         }
     },
             this.refresh();
         }
     },
+    
+    /**
+     * @private
+     * Calls this.refresh if this.blockRefresh is not true
+     */
+    onDataChanged: function() {
+        if (this.blockRefresh !== true) {
+            this.refresh.apply(this, arguments);
+        }
+    },
 
     <div id="method-Ext.DataView-findItemFromChild"></div>/**
      * Returns the template node the passed child belongs to, or null if it doesn't belong to one.
 
     <div id="method-Ext.DataView-findItemFromChild"></div>/**
      * Returns the template node the passed child belongs to, or null if it doesn't belong to one.
@@ -611,7 +633,7 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
 
     <div id="method-Ext.DataView-isSelected"></div>/**
      * Returns true if the passed node is selected, else false.
 
     <div id="method-Ext.DataView-isSelected"></div>/**
      * 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){
      * @return {Boolean} True if selected, else false
      */
     isSelected : function(node){
@@ -620,7 +642,7 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
 
     <div id="method-Ext.DataView-deselect"></div>/**
      * Deselects a node.
 
     <div id="method-Ext.DataView-deselect"></div>/**
      * 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)){
      */
     deselect : function(node){
         if(this.isSelected(node)){
@@ -636,8 +658,8 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
 
     <div id="method-Ext.DataView-select"></div>/**
      * Selects a set of nodes.
 
     <div id="method-Ext.DataView-select"></div>/**
      * 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
      */
      * @param {Boolean} keepExisting (optional) true to keep existing selections
      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
      */
@@ -685,7 +707,8 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
 
     <div id="method-Ext.DataView-getNode"></div>/**
      * Gets a template node.
 
     <div id="method-Ext.DataView-getNode"></div>/**
      * 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){
      * @return {HTMLElement} The node or null if it wasn't found
      */
     getNode : function(nodeInfo){
@@ -693,6 +716,9 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
             return document.getElementById(nodeInfo);
         }else if(Ext.isNumber(nodeInfo)){
             return this.all.elements[nodeInfo];
             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;
     },
         }
         return nodeInfo;
     },
@@ -722,7 +748,8 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
 
     <div id="method-Ext.DataView-indexOf"></div>/**
      * Finds the index of the passed node.
 
     <div id="method-Ext.DataView-indexOf"></div>/**
      * 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){
      * @return {Number} The index of the node or -1
      */
     indexOf : function(node){
@@ -757,6 +784,6 @@ Ext.DataView = Ext.extend(Ext.BoxComponent, {
 Ext.DataView.prototype.setStore = Ext.DataView.prototype.bindStore;
 
 Ext.reg('dataview', Ext.DataView);
 Ext.DataView.prototype.setStore = Ext.DataView.prototype.bindStore;
 
 Ext.reg('dataview', Ext.DataView);
-</pre>    \r
-</body>\r
+</pre>    
+</body>
 </html>
\ No newline at end of file
 </html>
\ No newline at end of file
Mirror of ExtJS by Sencha Inc. <http://www.sencha.com/>.