Upgrade to ExtJS 3.0.3 - Released 10/11/2009
[extjs.git] / docs / source / ScrollManager.html
1 <html>
2 <head>
3   <title>The source code</title>
4     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
5     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
6 </head>
7 <body  onload="prettyPrint();">
8     <pre class="prettyprint lang-js">/*!
9  * Ext JS Library 3.0.3
10  * Copyright(c) 2006-2009 Ext JS, LLC
11  * licensing@extjs.com
12  * http://www.extjs.com/license
13  */
14 <div id="cls-Ext.dd.ScrollManager"></div>/**\r
15  * @class Ext.dd.ScrollManager\r
16  * <p>Provides automatic scrolling of overflow regions in the page during drag operations.</p>\r
17  * <p>The ScrollManager configs will be used as the defaults for any scroll container registered with it,\r
18  * but you can also override most of the configs per scroll container by adding a \r
19  * <tt>ddScrollConfig</tt> object to the target element that contains these properties: {@link #hthresh},\r
20  * {@link #vthresh}, {@link #increment} and {@link #frequency}.  Example usage:\r
21  * <pre><code>\r
22 var el = Ext.get('scroll-ct');\r
23 el.ddScrollConfig = {\r
24     vthresh: 50,\r
25     hthresh: -1,\r
26     frequency: 100,\r
27     increment: 200\r
28 };\r
29 Ext.dd.ScrollManager.register(el);\r
30 </code></pre>\r
31  * <b>Note: This class uses "Point Mode" and is untested in "Intersect Mode".</b>\r
32  * @singleton\r
33  */\r
34 Ext.dd.ScrollManager = function(){\r
35     var ddm = Ext.dd.DragDropMgr;\r
36     var els = {};\r
37     var dragEl = null;\r
38     var proc = {};\r
39     \r
40     var onStop = function(e){\r
41         dragEl = null;\r
42         clearProc();\r
43     };\r
44     \r
45     var triggerRefresh = function(){\r
46         if(ddm.dragCurrent){\r
47              ddm.refreshCache(ddm.dragCurrent.groups);\r
48         }\r
49     };\r
50     \r
51     var doScroll = function(){\r
52         if(ddm.dragCurrent){\r
53             var dds = Ext.dd.ScrollManager;\r
54             var inc = proc.el.ddScrollConfig ?\r
55                       proc.el.ddScrollConfig.increment : dds.increment;\r
56             if(!dds.animate){\r
57                 if(proc.el.scroll(proc.dir, inc)){\r
58                     triggerRefresh();\r
59                 }\r
60             }else{\r
61                 proc.el.scroll(proc.dir, inc, true, dds.animDuration, triggerRefresh);\r
62             }\r
63         }\r
64     };\r
65     \r
66     var clearProc = function(){\r
67         if(proc.id){\r
68             clearInterval(proc.id);\r
69         }\r
70         proc.id = 0;\r
71         proc.el = null;\r
72         proc.dir = "";\r
73     };\r
74     \r
75     var startProc = function(el, dir){\r
76         clearProc();\r
77         proc.el = el;\r
78         proc.dir = dir;\r
79         var freq = (el.ddScrollConfig && el.ddScrollConfig.frequency) ? \r
80                 el.ddScrollConfig.frequency : Ext.dd.ScrollManager.frequency;\r
81         proc.id = setInterval(doScroll, freq);\r
82     };\r
83     \r
84     var onFire = function(e, isDrop){\r
85         if(isDrop || !ddm.dragCurrent){ return; }\r
86         var dds = Ext.dd.ScrollManager;\r
87         if(!dragEl || dragEl != ddm.dragCurrent){\r
88             dragEl = ddm.dragCurrent;\r
89             // refresh regions on drag start\r
90             dds.refreshCache();\r
91         }\r
92         \r
93         var xy = Ext.lib.Event.getXY(e);\r
94         var pt = new Ext.lib.Point(xy[0], xy[1]);\r
95         for(var id in els){\r
96             var el = els[id], r = el._region;\r
97             var c = el.ddScrollConfig ? el.ddScrollConfig : dds;\r
98             if(r && r.contains(pt) && el.isScrollable()){\r
99                 if(r.bottom - pt.y <= c.vthresh){\r
100                     if(proc.el != el){\r
101                         startProc(el, "down");\r
102                     }\r
103                     return;\r
104                 }else if(r.right - pt.x <= c.hthresh){\r
105                     if(proc.el != el){\r
106                         startProc(el, "left");\r
107                     }\r
108                     return;\r
109                 }else if(pt.y - r.top <= c.vthresh){\r
110                     if(proc.el != el){\r
111                         startProc(el, "up");\r
112                     }\r
113                     return;\r
114                 }else if(pt.x - r.left <= c.hthresh){\r
115                     if(proc.el != el){\r
116                         startProc(el, "right");\r
117                     }\r
118                     return;\r
119                 }\r
120             }\r
121         }\r
122         clearProc();\r
123     };\r
124     \r
125     ddm.fireEvents = ddm.fireEvents.createSequence(onFire, ddm);\r
126     ddm.stopDrag = ddm.stopDrag.createSequence(onStop, ddm);\r
127     \r
128     return {\r
129         <div id="method-Ext.dd.ScrollManager-register"></div>/**\r
130          * Registers new overflow element(s) to auto scroll\r
131          * @param {Mixed/Array} el The id of or the element to be scrolled or an array of either\r
132          */\r
133         register : function(el){\r
134             if(Ext.isArray(el)){\r
135                 for(var i = 0, len = el.length; i < len; i++) {\r
136                         this.register(el[i]);\r
137                 }\r
138             }else{\r
139                 el = Ext.get(el);\r
140                 els[el.id] = el;\r
141             }\r
142         },\r
143         \r
144         <div id="method-Ext.dd.ScrollManager-unregister"></div>/**\r
145          * Unregisters overflow element(s) so they are no longer scrolled\r
146          * @param {Mixed/Array} el The id of or the element to be removed or an array of either\r
147          */\r
148         unregister : function(el){\r
149             if(Ext.isArray(el)){\r
150                 for(var i = 0, len = el.length; i < len; i++) {\r
151                         this.unregister(el[i]);\r
152                 }\r
153             }else{\r
154                 el = Ext.get(el);\r
155                 delete els[el.id];\r
156             }\r
157         },\r
158         \r
159         <div id="prop-Ext.dd.ScrollManager-vthresh"></div>/**\r
160          * The number of pixels from the top or bottom edge of a container the pointer needs to be to\r
161          * trigger scrolling (defaults to 25)\r
162          * @type Number\r
163          */\r
164         vthresh : 25,\r
165         <div id="prop-Ext.dd.ScrollManager-hthresh"></div>/**\r
166          * The number of pixels from the right or left edge of a container the pointer needs to be to\r
167          * trigger scrolling (defaults to 25)\r
168          * @type Number\r
169          */\r
170         hthresh : 25,\r
171 \r
172         <div id="prop-Ext.dd.ScrollManager-increment"></div>/**\r
173          * The number of pixels to scroll in each scroll increment (defaults to 50)\r
174          * @type Number\r
175          */\r
176         increment : 100,\r
177         \r
178         <div id="prop-Ext.dd.ScrollManager-frequency"></div>/**\r
179          * The frequency of scrolls in milliseconds (defaults to 500)\r
180          * @type Number\r
181          */\r
182         frequency : 500,\r
183         \r
184         <div id="prop-Ext.dd.ScrollManager-animate"></div>/**\r
185          * True to animate the scroll (defaults to true)\r
186          * @type Boolean\r
187          */\r
188         animate: true,\r
189         \r
190         <div id="prop-Ext.dd.ScrollManager-animDuration"></div>/**\r
191          * The animation duration in seconds - \r
192          * MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4)\r
193          * @type Number\r
194          */\r
195         animDuration: .4,\r
196         \r
197         <div id="method-Ext.dd.ScrollManager-refreshCache"></div>/**\r
198          * Manually trigger a cache refresh.\r
199          */\r
200         refreshCache : function(){\r
201             for(var id in els){\r
202                 if(typeof els[id] == 'object'){ // for people extending the object prototype\r
203                     els[id]._region = els[id].getRegion();\r
204                 }\r
205             }\r
206         }\r
207     };\r
208 }();</pre>
209 </body>
210 </html>