Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / ScrollManager.html
diff --git a/docs/source/ScrollManager.html b/docs/source/ScrollManager.html
new file mode 100644 (file)
index 0000000..82b7aef
--- /dev/null
@@ -0,0 +1,204 @@
+<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