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