3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
8 * @class Ext.dd.ScrollManager
\r
9 * <p>Provides automatic scrolling of overflow regions in the page during drag operations.</p>
\r
10 * <p>The ScrollManager configs will be used as the defaults for any scroll container registered with it,
\r
11 * but you can also override most of the configs per scroll container by adding a
\r
12 * <tt>ddScrollConfig</tt> object to the target element that contains these properties: {@link #hthresh},
\r
13 * {@link #vthresh}, {@link #increment} and {@link #frequency}. Example usage:
\r
15 var el = Ext.get('scroll-ct');
\r
16 el.ddScrollConfig = {
\r
22 Ext.dd.ScrollManager.register(el);
\r
24 * <b>Note: This class uses "Point Mode" and is untested in "Intersect Mode".</b>
\r
27 Ext.dd.ScrollManager = function(){
\r
28 var ddm = Ext.dd.DragDropMgr;
\r
33 var onStop = function(e){
\r
38 var triggerRefresh = function(){
\r
39 if(ddm.dragCurrent){
\r
40 ddm.refreshCache(ddm.dragCurrent.groups);
\r
44 var doScroll = function(){
\r
45 if(ddm.dragCurrent){
\r
46 var dds = Ext.dd.ScrollManager;
\r
47 var inc = proc.el.ddScrollConfig ?
\r
48 proc.el.ddScrollConfig.increment : dds.increment;
\r
50 if(proc.el.scroll(proc.dir, inc)){
\r
54 proc.el.scroll(proc.dir, inc, true, dds.animDuration, triggerRefresh);
\r
59 var clearProc = function(){
\r
61 clearInterval(proc.id);
\r
68 var startProc = function(el, dir){
\r
72 var freq = (el.ddScrollConfig && el.ddScrollConfig.frequency) ?
\r
73 el.ddScrollConfig.frequency : Ext.dd.ScrollManager.frequency;
\r
74 proc.id = setInterval(doScroll, freq);
\r
77 var onFire = function(e, isDrop){
\r
78 if(isDrop || !ddm.dragCurrent){ return; }
\r
79 var dds = Ext.dd.ScrollManager;
\r
80 if(!dragEl || dragEl != ddm.dragCurrent){
\r
81 dragEl = ddm.dragCurrent;
\r
82 // refresh regions on drag start
\r
86 var xy = Ext.lib.Event.getXY(e);
\r
87 var pt = new Ext.lib.Point(xy[0], xy[1]);
\r
89 var el = els[id], r = el._region;
\r
90 var c = el.ddScrollConfig ? el.ddScrollConfig : dds;
\r
91 if(r && r.contains(pt) && el.isScrollable()){
\r
92 if(r.bottom - pt.y <= c.vthresh){
\r
94 startProc(el, "down");
\r
97 }else if(r.right - pt.x <= c.hthresh){
\r
99 startProc(el, "left");
\r
102 }else if(pt.y - r.top <= c.vthresh){
\r
104 startProc(el, "up");
\r
107 }else if(pt.x - r.left <= c.hthresh){
\r
109 startProc(el, "right");
\r
118 ddm.fireEvents = ddm.fireEvents.createSequence(onFire, ddm);
\r
119 ddm.stopDrag = ddm.stopDrag.createSequence(onStop, ddm);
\r
123 * Registers new overflow element(s) to auto scroll
\r
124 * @param {Mixed/Array} el The id of or the element to be scrolled or an array of either
\r
126 register : function(el){
\r
127 if(Ext.isArray(el)){
\r
128 for(var i = 0, len = el.length; i < len; i++) {
\r
129 this.register(el[i]);
\r
138 * Unregisters overflow element(s) so they are no longer scrolled
\r
139 * @param {Mixed/Array} el The id of or the element to be removed or an array of either
\r
141 unregister : function(el){
\r
142 if(Ext.isArray(el)){
\r
143 for(var i = 0, len = el.length; i < len; i++) {
\r
144 this.unregister(el[i]);
\r
153 * The number of pixels from the top or bottom edge of a container the pointer needs to be to
\r
154 * trigger scrolling (defaults to 25)
\r
159 * The number of pixels from the right or left edge of a container the pointer needs to be to
\r
160 * trigger scrolling (defaults to 25)
\r
166 * The number of pixels to scroll in each scroll increment (defaults to 50)
\r
172 * The frequency of scrolls in milliseconds (defaults to 500)
\r
178 * True to animate the scroll (defaults to true)
\r
184 * The animation duration in seconds -
\r
185 * MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4)
\r
191 * Manually trigger a cache refresh.
\r
193 refreshCache : function(){
\r
194 for(var id in els){
\r
195 if(typeof els[id] == 'object'){ // for people extending the object prototype
\r
196 els[id]._region = els[id].getRegion();
\r