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