Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / ScrollManager.html
index 82b7aef..1301d1e 100644 (file)
-<html>\r
-<head>\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.dd.ScrollManager"></div>/**\r
- * @class Ext.dd.ScrollManager\r
- * <p>Provides automatic scrolling of overflow regions in the page during drag operations.</p>\r
- * <p>The ScrollManager configs will be used as the defaults for any scroll container registered with it,\r
- * but you can also override most of the configs per scroll container by adding a \r
- * <tt>ddScrollConfig</tt> object to the target element that contains these properties: {@link #hthresh},\r
- * {@link #vthresh}, {@link #increment} and {@link #frequency}.  Example usage:\r
- * <pre><code>\r
-var el = Ext.get('scroll-ct');\r
-el.ddScrollConfig = {\r
-    vthresh: 50,\r
-    hthresh: -1,\r
-    frequency: 100,\r
-    increment: 200\r
-};\r
-Ext.dd.ScrollManager.register(el);\r
-</code></pre>\r
- * <b>Note: This class uses "Point Mode" and is untested in "Intersect Mode".</b>\r
- * @singleton\r
- */\r
-Ext.dd.ScrollManager = function(){\r
-    var ddm = Ext.dd.DragDropMgr;\r
-    var els = {};\r
-    var dragEl = null;\r
-    var proc = {};\r
-    \r
-    var onStop = function(e){\r
-        dragEl = null;\r
-        clearProc();\r
-    };\r
-    \r
-    var triggerRefresh = function(){\r
-        if(ddm.dragCurrent){\r
-             ddm.refreshCache(ddm.dragCurrent.groups);\r
-        }\r
-    };\r
-    \r
-    var doScroll = function(){\r
-        if(ddm.dragCurrent){\r
-            var dds = Ext.dd.ScrollManager;\r
-            var inc = proc.el.ddScrollConfig ?\r
-                      proc.el.ddScrollConfig.increment : dds.increment;\r
-            if(!dds.animate){\r
-                if(proc.el.scroll(proc.dir, inc)){\r
-                    triggerRefresh();\r
-                }\r
-            }else{\r
-                proc.el.scroll(proc.dir, inc, true, dds.animDuration, triggerRefresh);\r
-            }\r
-        }\r
-    };\r
-    \r
-    var clearProc = function(){\r
-        if(proc.id){\r
-            clearInterval(proc.id);\r
-        }\r
-        proc.id = 0;\r
-        proc.el = null;\r
-        proc.dir = "";\r
-    };\r
-    \r
-    var startProc = function(el, dir){\r
-        clearProc();\r
-        proc.el = el;\r
-        proc.dir = dir;\r
-        var freq = (el.ddScrollConfig && el.ddScrollConfig.frequency) ? \r
-                el.ddScrollConfig.frequency : Ext.dd.ScrollManager.frequency;\r
-        proc.id = setInterval(doScroll, freq);\r
-    };\r
-    \r
-    var onFire = function(e, isDrop){\r
-        if(isDrop || !ddm.dragCurrent){ return; }\r
-        var dds = Ext.dd.ScrollManager;\r
-        if(!dragEl || dragEl != ddm.dragCurrent){\r
-            dragEl = ddm.dragCurrent;\r
-            // refresh regions on drag start\r
-            dds.refreshCache();\r
-        }\r
-        \r
-        var xy = Ext.lib.Event.getXY(e);\r
-        var pt = new Ext.lib.Point(xy[0], xy[1]);\r
-        for(var id in els){\r
-            var el = els[id], r = el._region;\r
-            var c = el.ddScrollConfig ? el.ddScrollConfig : dds;\r
-            if(r && r.contains(pt) && el.isScrollable()){\r
-                if(r.bottom - pt.y <= c.vthresh){\r
-                    if(proc.el != el){\r
-                        startProc(el, "down");\r
-                    }\r
-                    return;\r
-                }else if(r.right - pt.x <= c.hthresh){\r
-                    if(proc.el != el){\r
-                        startProc(el, "left");\r
-                    }\r
-                    return;\r
-                }else if(pt.y - r.top <= c.vthresh){\r
-                    if(proc.el != el){\r
-                        startProc(el, "up");\r
-                    }\r
-                    return;\r
-                }else if(pt.x - r.left <= c.hthresh){\r
-                    if(proc.el != el){\r
-                        startProc(el, "right");\r
-                    }\r
-                    return;\r
-                }\r
-            }\r
-        }\r
-        clearProc();\r
-    };\r
-    \r
-    ddm.fireEvents = ddm.fireEvents.createSequence(onFire, ddm);\r
-    ddm.stopDrag = ddm.stopDrag.createSequence(onStop, ddm);\r
-    \r
-    return {\r
-        <div id="method-Ext.dd.ScrollManager-register"></div>/**\r
-         * Registers new overflow element(s) to auto scroll\r
-         * @param {Mixed/Array} el The id of or the element to be scrolled or an array of either\r
-         */\r
-        register : function(el){\r
-            if(Ext.isArray(el)){\r
-                for(var i = 0, len = el.length; i < len; i++) {\r
-                       this.register(el[i]);\r
-                }\r
-            }else{\r
-                el = Ext.get(el);\r
-                els[el.id] = el;\r
-            }\r
-        },\r
-        \r
-        <div id="method-Ext.dd.ScrollManager-unregister"></div>/**\r
-         * Unregisters overflow element(s) so they are no longer scrolled\r
-         * @param {Mixed/Array} el The id of or the element to be removed or an array of either\r
-         */\r
-        unregister : function(el){\r
-            if(Ext.isArray(el)){\r
-                for(var i = 0, len = el.length; i < len; i++) {\r
-                       this.unregister(el[i]);\r
-                }\r
-            }else{\r
-                el = Ext.get(el);\r
-                delete els[el.id];\r
-            }\r
-        },\r
-        \r
-        <div id="prop-Ext.dd.ScrollManager-vthresh"></div>/**\r
-         * The number of pixels from the top or bottom edge of a container the pointer needs to be to\r
-         * trigger scrolling (defaults to 25)\r
-         * @type Number\r
-         */\r
-        vthresh : 25,\r
-        <div id="prop-Ext.dd.ScrollManager-hthresh"></div>/**\r
-         * The number of pixels from the right or left edge of a container the pointer needs to be to\r
-         * trigger scrolling (defaults to 25)\r
-         * @type Number\r
-         */\r
-        hthresh : 25,\r
-\r
-        <div id="prop-Ext.dd.ScrollManager-increment"></div>/**\r
-         * The number of pixels to scroll in each scroll increment (defaults to 50)\r
-         * @type Number\r
-         */\r
-        increment : 100,\r
-        \r
-        <div id="prop-Ext.dd.ScrollManager-frequency"></div>/**\r
-         * The frequency of scrolls in milliseconds (defaults to 500)\r
-         * @type Number\r
-         */\r
-        frequency : 500,\r
-        \r
-        <div id="prop-Ext.dd.ScrollManager-animate"></div>/**\r
-         * True to animate the scroll (defaults to true)\r
-         * @type Boolean\r
-         */\r
-        animate: true,\r
-        \r
-        <div id="prop-Ext.dd.ScrollManager-animDuration"></div>/**\r
-         * The animation duration in seconds - \r
-         * MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4)\r
-         * @type Number\r
-         */\r
-        animDuration: .4,\r
-        \r
-        <div id="method-Ext.dd.ScrollManager-refreshCache"></div>/**\r
-         * Manually trigger a cache refresh.\r
-         */\r
-        refreshCache : function(){\r
-            for(var id in els){\r
-                if(typeof els[id] == 'object'){ // for people extending the object prototype\r
-                    els[id]._region = els[id].getRegion();\r
-                }\r
-            }\r
-        }\r
-    };\r
-}();</pre>    \r
-</body>\r
-</html>
\ No newline at end of file
+<!DOCTYPE html>
+<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>
+  <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>
+<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:
+ * &lt;pre&gt;&lt;code&gt;
+var el = Ext.get('scroll-ct');
+el.ddScrollConfig = {
+    vthresh: 50,
+    hthresh: -1,
+    frequency: 100,
+    increment: 200
+};
+Ext.dd.ScrollManager.register(el);
+&lt;/code&gt;&lt;/pre&gt;
+ * Note: This class is designed to be used in &quot;Point Mode
+ * @singleton
+ */
+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);
+        }
+    },
+
+    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 {
+                procEl.scroll(proc.dir, inc, true, this.animDuration, this.triggerRefresh);
+            }
+        }
+    },
+
+    clearProc: function() {
+        var proc = this.proc;
+        if (proc.id) {
+            clearInterval(proc.id);
+        }
+        proc.id = 0;
+        proc.el = null;
+        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
+            this.refreshCache();
+        }
+
+        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 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){
+                        this.startProc(el, &quot;down&quot;);
+                    }
+                    return;
+                }else if (r.right - pt.x &lt;= c.hthresh) {
+                    if (proc.el != el) {
+                        this.startProc(el, &quot;left&quot;);
+                    }
+                    return;
+                } else if(pt.y - r.top &lt;= c.vthresh) {
+                    if (proc.el != el) {
+                        this.startProc(el, &quot;up&quot;);
+                    }
+                    return;
+                } else if(pt.x - r.left &lt;= c.hthresh) {
+                    if (proc.el != el) {
+                        this.startProc(el, &quot;right&quot;);
+                    }
+                    return;
+                }
+            }
+        }
+        this.clearProc();
+    },
+
+<span id='Ext-dd-ScrollManager-method-register'>    /**
+</span>     * Registers new overflow element(s) to auto scroll
+     * @param {String/HTMLElement/Ext.Element/String[]/HTMLElement[]/Ext.Element[]} 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]);
+            }
+        } 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 {String/HTMLElement/Ext.Element/String[]/HTMLElement[]/Ext.Element[]} 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]);
+            }
+        }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
+     * @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
+     * @type Number
+     */
+    hthresh : 25,
+
+<span id='Ext-dd-ScrollManager-property-increment'>    /**
+</span>     * The number of pixels to scroll in each scroll increment
+     * @type Number
+     */
+    increment : 100,
+
+<span id='Ext-dd-ScrollManager-property-frequency'>    /**
+</span>     * The frequency of scrolls in milliseconds
+     * @type Number
+     */
+    frequency : 500,
+
+<span id='Ext-dd-ScrollManager-property-animate'>    /**
+</span>     * True to animate the scroll
+     * @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!
+     * @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.
+     * 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>
+</body>
+</html>