Upgrade to ExtJS 3.1.1 - Released 02/08/2010
[extjs.git] / src / adapter / core / ext-base-event.js
1 /*!
2  * Ext JS Library 3.1.1
3  * Copyright(c) 2006-2010 Ext JS, LLC
4  * licensing@extjs.com
5  * http://www.extjs.com/license
6  */
7 Ext.lib.Event = function() {
8     var loadComplete = false,
9         unloadListeners = {},
10         retryCount = 0,
11         onAvailStack = [],
12         _interval,
13         locked = false,
14         win = window,
15         doc = document,
16
17         // constants
18         POLL_RETRYS = 200,
19         POLL_INTERVAL = 20,
20         EL = 0,
21         TYPE = 0,
22         FN = 1,
23         WFN = 2,
24         OBJ = 2,
25         ADJ_SCOPE = 3,
26         SCROLLLEFT = 'scrollLeft',
27         SCROLLTOP = 'scrollTop',
28         UNLOAD = 'unload',
29         MOUSEOVER = 'mouseover',
30         MOUSEOUT = 'mouseout',
31         // private
32         doAdd = function() {
33             var ret;
34             if (win.addEventListener) {
35                 ret = function(el, eventName, fn, capture) {
36                     if (eventName == 'mouseenter') {
37                         fn = fn.createInterceptor(checkRelatedTarget);
38                         el.addEventListener(MOUSEOVER, fn, (capture));
39                     } else if (eventName == 'mouseleave') {
40                         fn = fn.createInterceptor(checkRelatedTarget);
41                         el.addEventListener(MOUSEOUT, fn, (capture));
42                     } else {
43                         el.addEventListener(eventName, fn, (capture));
44                     }
45                     return fn;
46                 };
47             } else if (win.attachEvent) {
48                 ret = function(el, eventName, fn, capture) {
49                     el.attachEvent("on" + eventName, fn);
50                     return fn;
51                 };
52             } else {
53                 ret = function(){};
54             }
55             return ret;
56         }(),
57         // private
58         doRemove = function(){
59             var ret;
60             if (win.removeEventListener) {
61                 ret = function (el, eventName, fn, capture) {
62                     if (eventName == 'mouseenter') {
63                         eventName = MOUSEOVER;
64                     } else if (eventName == 'mouseleave') {
65                         eventName = MOUSEOUT;
66                     }
67                     el.removeEventListener(eventName, fn, (capture));
68                 };
69             } else if (win.detachEvent) {
70                 ret = function (el, eventName, fn) {
71                     el.detachEvent("on" + eventName, fn);
72                 };
73             } else {
74                 ret = function(){};
75             }
76             return ret;
77         }();
78
79     function checkRelatedTarget(e) {
80         return !elContains(e.currentTarget, pub.getRelatedTarget(e));
81     }
82
83     function elContains(parent, child) {
84        if(parent && parent.firstChild){
85          while(child) {
86             if(child === parent) {
87                 return true;
88             }
89             child = child.parentNode;
90             if(child && (child.nodeType != 1)) {
91                 child = null;
92             }
93           }
94         }
95         return false;
96     }
97
98     // private
99     function _tryPreloadAttach() {
100         var ret = false,
101             notAvail = [],
102             element, i, len, v,
103             tryAgain = !loadComplete || (retryCount > 0);
104
105         if (!locked) {
106             locked = true;
107
108             for (i = 0, len = onAvailStack.length; i < len; i++) {
109                 v = onAvailStack[i];
110                 if(v && (element = doc.getElementById(v.id))){
111                     if(!v.checkReady || loadComplete || element.nextSibling || (doc && doc.body)) {
112                         element = v.override ? (v.override === true ? v.obj : v.override) : element;
113                         v.fn.call(element, v.obj);
114                         onAvailStack.remove(v);
115                     } else {
116                         notAvail.push(v);
117                     }
118                 }
119             }
120
121             retryCount = (notAvail.length === 0) ? 0 : retryCount - 1;
122
123             if (tryAgain) {
124                 startInterval();
125             } else {
126                 clearInterval(_interval);
127                 _interval = null;
128             }
129
130             ret = !(locked = false);
131         }
132         return ret;
133     }
134
135     // private
136     function startInterval() {
137         if(!_interval){
138             var callback = function() {
139                 _tryPreloadAttach();
140             };
141             _interval = setInterval(callback, POLL_INTERVAL);
142         }
143     }
144
145     // private
146     function getScroll() {
147         var dd = doc.documentElement,
148             db = doc.body;
149         if(dd && (dd[SCROLLTOP] || dd[SCROLLLEFT])){
150             return [dd[SCROLLLEFT], dd[SCROLLTOP]];
151         }else if(db){
152             return [db[SCROLLLEFT], db[SCROLLTOP]];
153         }else{
154             return [0, 0];
155         }
156     }
157
158     // private
159     function getPageCoord (ev, xy) {
160         ev = ev.browserEvent || ev;
161         var coord  = ev['page' + xy];
162         if (!coord && coord !== 0) {
163             coord = ev['client' + xy] || 0;
164
165             if (Ext.isIE) {
166                 coord += getScroll()[xy == "X" ? 0 : 1];
167             }
168         }
169
170         return coord;
171     }
172
173     var pub =  {
174         extAdapter: true,
175         onAvailable : function(p_id, p_fn, p_obj, p_override) {
176             onAvailStack.push({
177                 id:         p_id,
178                 fn:         p_fn,
179                 obj:        p_obj,
180                 override:   p_override,
181                 checkReady: false });
182
183             retryCount = POLL_RETRYS;
184             startInterval();
185         },
186
187         // This function should ALWAYS be called from Ext.EventManager
188         addListener: function(el, eventName, fn) {
189             el = Ext.getDom(el);
190             if (el && fn) {
191                 if (eventName == UNLOAD) {
192                     if (unloadListeners[el.id] === undefined) {
193                         unloadListeners[el.id] = [];
194                     }
195                     unloadListeners[el.id].push([eventName, fn]);
196                     return fn;
197                 }
198                 return doAdd(el, eventName, fn, false);
199             }
200             return false;
201         },
202
203         // This function should ALWAYS be called from Ext.EventManager
204         removeListener: function(el, eventName, fn) {
205             el = Ext.getDom(el);
206             var i, len, li, lis;
207             if (el && fn) {
208                 if(eventName == UNLOAD){
209                     if((lis = unloadListeners[el.id]) !== undefined){
210                         for(i = 0, len = lis.length; i < len; i++){
211                             if((li = lis[i]) && li[TYPE] == eventName && li[FN] == fn){
212                                 unloadListeners[el.id].splice(i, 1);
213                             }
214                         }
215                     }
216                     return;
217                 }
218                 doRemove(el, eventName, fn, false);
219             }
220         },
221
222         getTarget : function(ev) {
223             ev = ev.browserEvent || ev;
224             return this.resolveTextNode(ev.target || ev.srcElement);
225         },
226
227         resolveTextNode : Ext.isGecko ? function(node){
228             if(!node){
229                 return;
230             }
231             // work around firefox bug, https://bugzilla.mozilla.org/show_bug.cgi?id=101197
232             var s = HTMLElement.prototype.toString.call(node);
233             if(s == '[xpconnect wrapped native prototype]' || s == '[object XULElement]'){
234                 return;
235             }
236             return node.nodeType == 3 ? node.parentNode : node;
237         } : function(node){
238             return node && node.nodeType == 3 ? node.parentNode : node;
239         },
240
241         getRelatedTarget : function(ev) {
242             ev = ev.browserEvent || ev;
243             return this.resolveTextNode(ev.relatedTarget ||
244                     (ev.type == MOUSEOUT ? ev.toElement :
245                      ev.type == MOUSEOVER ? ev.fromElement : null));
246         },
247
248         getPageX : function(ev) {
249             return getPageCoord(ev, "X");
250         },
251
252         getPageY : function(ev) {
253             return getPageCoord(ev, "Y");
254         },
255
256
257         getXY : function(ev) {
258             return [this.getPageX(ev), this.getPageY(ev)];
259         },
260
261         stopEvent : function(ev) {
262             this.stopPropagation(ev);
263             this.preventDefault(ev);
264         },
265
266         stopPropagation : function(ev) {
267             ev = ev.browserEvent || ev;
268             if (ev.stopPropagation) {
269                 ev.stopPropagation();
270             } else {
271                 ev.cancelBubble = true;
272             }
273         },
274
275         preventDefault : function(ev) {
276             ev = ev.browserEvent || ev;
277             if (ev.preventDefault) {
278                 ev.preventDefault();
279             } else {
280                 ev.returnValue = false;
281             }
282         },
283
284         getEvent : function(e) {
285             e = e || win.event;
286             if (!e) {
287                 var c = this.getEvent.caller;
288                 while (c) {
289                     e = c.arguments[0];
290                     if (e && Event == e.constructor) {
291                         break;
292                     }
293                     c = c.caller;
294                 }
295             }
296             return e;
297         },
298
299         getCharCode : function(ev) {
300             ev = ev.browserEvent || ev;
301             return ev.charCode || ev.keyCode || 0;
302         },
303
304         //clearCache: function() {},
305         // deprecated, call from EventManager
306         getListeners : function(el, eventName) {
307             Ext.EventManager.getListeners(el, eventName);
308         },
309
310         // deprecated, call from EventManager
311         purgeElement : function(el, recurse, eventName) {
312             Ext.EventManager.purgeElement(el, recurse, eventName);
313         },
314
315         _load : function(e) {
316             loadComplete = true;
317             var EU = Ext.lib.Event;
318             if (Ext.isIE && e !== true) {
319         // IE8 complains that _load is null or not an object
320         // so lets remove self via arguments.callee
321                 doRemove(win, "load", arguments.callee);
322             }
323         },
324
325         _unload : function(e) {
326              var EU = Ext.lib.Event,
327                 i, j, l, v, ul, id, len, index, scope;
328
329
330             for (id in unloadListeners) {
331                 ul = unloadListeners[id];
332                 for (i = 0, len = ul.length; i < len; i++) {
333                     v = ul[i];
334                     if (v) {
335                         try{
336                             scope = v[ADJ_SCOPE] ? (v[ADJ_SCOPE] === true ? v[OBJ] : v[ADJ_SCOPE]) :  win;
337                             v[FN].call(scope, EU.getEvent(e), v[OBJ]);
338                         }catch(ex){}
339                     }
340                 }
341             };
342
343             unloadListeners = null;
344             Ext.EventManager._unload();
345
346             doRemove(win, UNLOAD, EU._unload);
347         }
348     };
349
350     // Initialize stuff.
351     pub.on = pub.addListener;
352     pub.un = pub.removeListener;
353     if (doc && doc.body) {
354         pub._load(true);
355     } else {
356         doAdd(win, "load", pub._load);
357     }
358     doAdd(win, UNLOAD, pub._unload);
359     _tryPreloadAttach();
360
361     return pub;
362 }();