git.ithinksw.org / extjs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / source / ScrollManager.html
diff --git a/docs/source/ScrollManager.html b/docs/source/ScrollManager.html
index 4413253..4b32300 100644 (file)
--- a/docs/source/ScrollManager.html
+++ b/docs/source/ScrollManager.html
@@ -1,25 +1,28 @@
+<!DOCTYPE html>
 <html>
 <head>
 <html>
 <head>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
   <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>
+  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
 </head>
 </head>
-<body  onload="prettyPrint();">
-    <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.2.2
- * Copyright(c) 2006-2010 Ext JS, Inc.
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
-<div id="cls-Ext.dd.ScrollManager"></div>/**
- * @class Ext.dd.ScrollManager
- * <p>Provides automatic scrolling of overflow regions in the page during drag operations.</p>
- * <p>The ScrollManager configs will be used as the defaults for any scroll container registered with it,
- * but you can also override most of the configs per scroll container by adding a 
- * <tt>ddScrollConfig</tt> object to the target element that contains these properties: {@link #hthresh},
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-dd-ScrollManager'>/**
+</span> * @class Ext.dd.ScrollManager
+ * &lt;p&gt;Provides automatic scrolling of overflow regions in the page during drag operations.&lt;/p&gt;
+ * &lt;p&gt;The ScrollManager configs will be used as the defaults for any scroll container registered with it,
+ * but you can also override most of the configs per scroll container by adding a
+ * &lt;tt&gt;ddScrollConfig&lt;/tt&gt; object to the target element that contains these properties: {@link #hthresh},
  * {@link #vthresh}, {@link #increment} and {@link #frequency}.  Example usage:
  * {@link #vthresh}, {@link #increment} and {@link #frequency}.  Example usage:
- * <pre><code>
+ * &lt;pre&gt;&lt;code&gt;
 var el = Ext.get('scroll-ct');
 el.ddScrollConfig = {
     vthresh: 50,
 var el = Ext.get('scroll-ct');
 el.ddScrollConfig = {
     vthresh: 50,
@@ -28,184 +31,213 @@ el.ddScrollConfig = {
     increment: 200
 };
 Ext.dd.ScrollManager.register(el);
     increment: 200
 };
 Ext.dd.ScrollManager.register(el);
-</code></pre>
- * <b>Note: This class uses "Point Mode" and is untested in "Intersect Mode".</b>
+&lt;/code&gt;&lt;/pre&gt;
+ * &lt;b&gt;Note: This class uses &quot;Point Mode&quot; and is untested in &quot;Intersect Mode&quot;.&lt;/b&gt;
  * @singleton
  */
  * @singleton
  */
-Ext.dd.ScrollManager = function(){
-    var ddm = Ext.dd.DragDropMgr;
-    var els = {};
-    var dragEl = null;
-    var proc = {};
-    
-    var onStop = function(e){
-        dragEl = null;
-        clearProc();
-    };
-    
-    var triggerRefresh = function(){
-        if(ddm.dragCurrent){
-             ddm.refreshCache(ddm.dragCurrent.groups);
+Ext.define('Ext.dd.ScrollManager', {
+    singleton: true,
+    requires: [
+        'Ext.dd.DragDropManager'
+    ],
+
+    constructor: function() {
+        var ddm = Ext.dd.DragDropManager;
+        ddm.fireEvents = Ext.Function.createSequence(ddm.fireEvents, this.onFire, this);
+        ddm.stopDrag = Ext.Function.createSequence(ddm.stopDrag, this.onStop, this);
+        this.doScroll = Ext.Function.bind(this.doScroll, this);
+        this.ddmInstance = ddm;
+        this.els = {};
+        this.dragEl = null;
+        this.proc = {};
+    },
+
+    onStop: function(e){
+        var sm = Ext.dd.ScrollManager;
+        sm.dragEl = null;
+        sm.clearProc();
+    },
+
+    triggerRefresh: function() {
+        if (this.ddmInstance.dragCurrent) {
+            this.ddmInstance.refreshCache(this.ddmInstance.dragCurrent.groups);
         }
         }
-    };
-    
-    var doScroll = function(){
-        if(ddm.dragCurrent){
-            var dds = Ext.dd.ScrollManager;
-            var inc = proc.el.ddScrollConfig ?
-                      proc.el.ddScrollConfig.increment : dds.increment;
-            if(!dds.animate){
-                if(proc.el.scroll(proc.dir, inc)){
-                    triggerRefresh();
+    },
+
+    doScroll: function() {
+        if (this.ddmInstance.dragCurrent) {
+            var proc   = this.proc,
+                procEl = proc.el,
+                ddScrollConfig = proc.el.ddScrollConfig,
+                inc = ddScrollConfig ? ddScrollConfig.increment : this.increment;
+
+            if (!this.animate) {
+                if (procEl.scroll(proc.dir, inc)) {
+                    this.triggerRefresh();
                 }
                 }
-            }else{
-                proc.el.scroll(proc.dir, inc, true, dds.animDuration, triggerRefresh);
+            } else {
+                procEl.scroll(proc.dir, inc, true, this.animDuration, this.triggerRefresh);
             }
         }
             }
         }
-    };
-    
-    var clearProc = function(){
-        if(proc.id){
+    },
+
+    clearProc: function() {
+        var proc = this.proc;
+        if (proc.id) {
             clearInterval(proc.id);
         }
         proc.id = 0;
         proc.el = null;
             clearInterval(proc.id);
         }
         proc.id = 0;
         proc.el = null;
-        proc.dir = "";
-    };
-    
-    var startProc = function(el, dir){
-        clearProc();
-        proc.el = el;
-        proc.dir = dir;
-        var freq = (el.ddScrollConfig && el.ddScrollConfig.frequency) ? 
-                el.ddScrollConfig.frequency : Ext.dd.ScrollManager.frequency;
-        proc.id = setInterval(doScroll, freq);
-    };
-    
-    var onFire = function(e, isDrop){
-        if(isDrop || !ddm.dragCurrent){ return; }
-        var dds = Ext.dd.ScrollManager;
-        if(!dragEl || dragEl != ddm.dragCurrent){
-            dragEl = ddm.dragCurrent;
+        proc.dir = &quot;&quot;;
+    },
+
+    startProc: function(el, dir) {
+        this.clearProc();
+        this.proc.el = el;
+        this.proc.dir = dir;
+        var group = el.ddScrollConfig ? el.ddScrollConfig.ddGroup : undefined,
+            freq  = (el.ddScrollConfig &amp;&amp; el.ddScrollConfig.frequency)
+                  ? el.ddScrollConfig.frequency
+                  : this.frequency;
+
+        if (group === undefined || this.ddmInstance.dragCurrent.ddGroup == group) {
+            this.proc.id = setInterval(this.doScroll, freq);
+        }
+    },
+
+    onFire: function(e, isDrop) {
+        if (isDrop || !this.ddmInstance.dragCurrent) {
+            return;
+        }
+        if (!this.dragEl || this.dragEl != this.ddmInstance.dragCurrent) {
+            this.dragEl = this.ddmInstance.dragCurrent;
             // refresh regions on drag start
             // refresh regions on drag start
-            dds.refreshCache();
+            this.refreshCache();
         }
         }
-        
-        var xy = Ext.lib.Event.getXY(e);
-        var pt = new Ext.lib.Point(xy[0], xy[1]);
-        for(var id in els){
+
+        var xy = e.getXY(),
+            pt = e.getPoint(),
+            proc = this.proc,
+            els = this.els;
+
+        for (var id in els) {
             var el = els[id], r = el._region;
             var el = els[id], r = el._region;
-            var c = el.ddScrollConfig ? el.ddScrollConfig : dds;
-            if(r && r.contains(pt) && el.isScrollable()){
-                if(r.bottom - pt.y <= c.vthresh){
+            var c = el.ddScrollConfig ? el.ddScrollConfig : this;
+            if (r &amp;&amp; r.contains(pt) &amp;&amp; el.isScrollable()) {
+                if (r.bottom - pt.y &lt;= c.vthresh) {
                     if(proc.el != el){
                     if(proc.el != el){
-                        startProc(el, "down");
+                        this.startProc(el, &quot;down&quot;);
                     }
                     return;
                     }
                     return;
-                }else if(r.right - pt.x <= c.hthresh){
-                    if(proc.el != el){
-                        startProc(el, "left");
+                }else if (r.right - pt.x &lt;= c.hthresh) {
+                    if (proc.el != el) {
+                        this.startProc(el, &quot;left&quot;);
                     }
                     return;
                     }
                     return;
-                }else if(pt.y - r.top <= c.vthresh){
-                    if(proc.el != el){
-                        startProc(el, "up");
+                } else if(pt.y - r.top &lt;= c.vthresh) {
+                    if (proc.el != el) {
+                        this.startProc(el, &quot;up&quot;);
                     }
                     return;
                     }
                     return;
-                }else if(pt.x - r.left <= c.hthresh){
-                    if(proc.el != el){
-                        startProc(el, "right");
+                } else if(pt.x - r.left &lt;= c.hthresh) {
+                    if (proc.el != el) {
+                        this.startProc(el, &quot;right&quot;);
                     }
                     return;
                 }
             }
         }
                     }
                     return;
                 }
             }
         }
-        clearProc();
-    };
-    
-    ddm.fireEvents = ddm.fireEvents.createSequence(onFire, ddm);
-    ddm.stopDrag = ddm.stopDrag.createSequence(onStop, ddm);
-    
-    return {
-        <div id="method-Ext.dd.ScrollManager-register"></div>/**
-         * Registers new overflow element(s) to auto scroll
-         * @param {Mixed/Array} el The id of or the element to be scrolled or an array of either
-         */
-        register : function(el){
-            if(Ext.isArray(el)){
-                for(var i = 0, len = el.length; i < len; i++) {
-                       this.register(el[i]);
-                }
-            }else{
-                el = Ext.get(el);
-                els[el.id] = el;
+        this.clearProc();
+    },
+
+<span id='Ext-dd-ScrollManager-method-register'>    /**
+</span>     * Registers new overflow element(s) to auto scroll
+     * @param {Mixed/Array} el The id of or the element to be scrolled or an array of either
+     */
+    register : function(el){
+        if (Ext.isArray(el)) {
+            for(var i = 0, len = el.length; i &lt; len; i++) {
+                    this.register(el[i]);
             }
             }
-        },
-        
-        <div id="method-Ext.dd.ScrollManager-unregister"></div>/**
-         * Unregisters overflow element(s) so they are no longer scrolled
-         * @param {Mixed/Array} el The id of or the element to be removed or an array of either
-         */
-        unregister : function(el){
-            if(Ext.isArray(el)){
-                for(var i = 0, len = el.length; i < len; i++) {
-                       this.unregister(el[i]);
-                }
-            }else{
-                el = Ext.get(el);
-                delete els[el.id];
+        } else {
+            el = Ext.get(el);
+            this.els[el.id] = el;
+        }
+    },
+
+<span id='Ext-dd-ScrollManager-method-unregister'>    /**
+</span>     * Unregisters overflow element(s) so they are no longer scrolled
+     * @param {Mixed/Array} el The id of or the element to be removed or an array of either
+     */
+    unregister : function(el){
+        if(Ext.isArray(el)){
+            for (var i = 0, len = el.length; i &lt; len; i++) {
+                this.unregister(el[i]);
             }
             }
-        },
-        
-        <div id="prop-Ext.dd.ScrollManager-vthresh"></div>/**
-         * The number of pixels from the top or bottom edge of a container the pointer needs to be to
-         * trigger scrolling (defaults to 25)
-         * @type Number
-         */
-        vthresh : 25,
-        <div id="prop-Ext.dd.ScrollManager-hthresh"></div>/**
-         * The number of pixels from the right or left edge of a container the pointer needs to be to
-         * trigger scrolling (defaults to 25)
-         * @type Number
-         */
-        hthresh : 25,
-
-        <div id="prop-Ext.dd.ScrollManager-increment"></div>/**
-         * The number of pixels to scroll in each scroll increment (defaults to 50)
-         * @type Number
-         */
-        increment : 100,
-        
-        <div id="prop-Ext.dd.ScrollManager-frequency"></div>/**
-         * The frequency of scrolls in milliseconds (defaults to 500)
-         * @type Number
-         */
-        frequency : 500,
-        
-        <div id="prop-Ext.dd.ScrollManager-animate"></div>/**
-         * True to animate the scroll (defaults to true)
-         * @type Boolean
-         */
-        animate: true,
-        
-        <div id="prop-Ext.dd.ScrollManager-animDuration"></div>/**
-         * The animation duration in seconds - 
-         * MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4)
-         * @type Number
-         */
-        animDuration: .4,
-        
-        <div id="method-Ext.dd.ScrollManager-refreshCache"></div>/**
-         * Manually trigger a cache refresh.
-         */
-        refreshCache : function(){
-            for(var id in els){
-                if(typeof els[id] == 'object'){ // for people extending the object prototype
-                    els[id]._region = els[id].getRegion();
-                }
+        }else{
+            el = Ext.get(el);
+            delete this.els[el.id];
+        }
+    },
+
+<span id='Ext-dd-ScrollManager-property-vthresh'>    /**
+</span>     * The number of pixels from the top or bottom edge of a container the pointer needs to be to
+     * trigger scrolling (defaults to 25)
+     * @type Number
+     */
+    vthresh : 25,
+<span id='Ext-dd-ScrollManager-property-hthresh'>    /**
+</span>     * The number of pixels from the right or left edge of a container the pointer needs to be to
+     * trigger scrolling (defaults to 25)
+     * @type Number
+     */
+    hthresh : 25,
+
+<span id='Ext-dd-ScrollManager-property-increment'>    /**
+</span>     * The number of pixels to scroll in each scroll increment (defaults to 100)
+     * @type Number
+     */
+    increment : 100,
+
+<span id='Ext-dd-ScrollManager-property-frequency'>    /**
+</span>     * The frequency of scrolls in milliseconds (defaults to 500)
+     * @type Number
+     */
+    frequency : 500,
+
+<span id='Ext-dd-ScrollManager-property-animate'>    /**
+</span>     * True to animate the scroll (defaults to true)
+     * @type Boolean
+     */
+    animate: true,
+
+<span id='Ext-dd-ScrollManager-property-animDuration'>    /**
+</span>     * The animation duration in seconds -
+     * MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4)
+     * @type Number
+     */
+    animDuration: 0.4,
+
+<span id='Ext-dd-ScrollManager-property-ddGroup'>    /**
+</span>     * The named drag drop {@link Ext.dd.DragSource#ddGroup group} to which this container belongs (defaults to undefined).
+     * If a ddGroup is specified, then container scrolling will only occur when a dragged object is in the same ddGroup.
+     * @type String
+     */
+    ddGroup: undefined,
+
+<span id='Ext-dd-ScrollManager-method-refreshCache'>    /**
+</span>     * Manually trigger a cache refresh.
+     */
+    refreshCache : function(){
+        var els = this.els,
+            id;
+        for (id in els) {
+            if(typeof els[id] == 'object'){ // for people extending the object prototype
+                els[id]._region = els[id].getRegion();
             }
         }
             }
         }
-    };
-}();</pre>    
+    }
+});
+</pre>
 </body>
 </body>
-</html>
\ No newline at end of file
+</html>
Mirror of ExtJS by Sencha Inc. <http://www.sencha.com/>.