Upgrade to ExtJS 3.1.1 - Released 02/08/2010
[extjs.git] / docs / source / EventManager.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"><div id="cls-Ext.EventManager"></div>/**\r
10  * @class Ext.EventManager\r
11  * Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides\r
12  * several useful events directly.\r
13  * See {@link Ext.EventObject} for more details on normalized event objects.\r
14  * @singleton\r
15  */\r
16 Ext.EventManager = function(){\r
17     var docReadyEvent,\r
18         docReadyProcId,\r
19         docReadyState = false,\r
20         E = Ext.lib.Event,\r
21         D = Ext.lib.Dom,\r
22         DOC = document,\r
23         WINDOW = window,\r
24         IEDEFERED = "ie-deferred-loader",\r
25         DOMCONTENTLOADED = "DOMContentLoaded",\r
26         propRe = /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate)$/,\r
27         /*\r
28          * This cache is used to hold special js objects, the document and window, that don't have an id. We need to keep\r
29          * a reference to them so we can look them up at a later point.\r
30          */\r
31         specialElCache = [];\r
32 \r
33      function getId(el){\r
34         var id = false,\r
35             i = 0,\r
36             len = specialElCache.length,\r
37             id = false,\r
38             skip = false,\r
39             o;\r
40         if(el){\r
41             if(el.getElementById || el.navigator){\r
42                 // look up the id\r
43                 for(; i < len; ++i){\r
44                     o = specialElCache[i];\r
45                     if(o.el === el){\r
46                         id = o.id;\r
47                         break;\r
48                     }\r
49                 }\r
50                 if(!id){\r
51                     // for browsers that support it, ensure that give the el the same id\r
52                     id = Ext.id(el);\r
53                     specialElCache.push({\r
54                         id: id,\r
55                         el: el\r
56                     });\r
57                     skip = true;\r
58                 }\r
59             }else{\r
60                 id = Ext.id(el);\r
61             }\r
62             if(!Ext.elCache[id]){\r
63                 Ext.Element.addToCache(new Ext.Element(el), id);\r
64                 if(skip){\r
65                     Ext.elCache[id].skipGC = true;\r
66                 }\r
67             }\r
68         }\r
69         return id;\r
70      };\r
71 \r
72     /// There is some jquery work around stuff here that isn't needed in Ext Core.\r
73     function addListener(el, ename, fn, task, wrap, scope){\r
74         el = Ext.getDom(el);\r
75         var id = getId(el),\r
76             es = Ext.elCache[id].events,\r
77             wfn;\r
78 \r
79         wfn = E.on(el, ename, wrap);\r
80         es[ename] = es[ename] || [];\r
81 \r
82         /* 0 = Original Function,\r
83            1 = Event Manager Wrapped Function,\r
84            2 = Scope,\r
85            3 = Adapter Wrapped Function,\r
86            4 = Buffered Task\r
87         */\r
88         es[ename].push([fn, wrap, scope, wfn, task]);\r
89 \r
90         // this is a workaround for jQuery and should somehow be removed from Ext Core in the future\r
91         // without breaking ExtJS.\r
92 \r
93         // workaround for jQuery\r
94         if(el.addEventListener && ename == "mousewheel"){\r
95             var args = ["DOMMouseScroll", wrap, false];\r
96             el.addEventListener.apply(el, args);\r
97             Ext.EventManager.addListener(WINDOW, 'unload', function(){\r
98                 el.removeEventListener.apply(el, args);\r
99             });\r
100         }\r
101 \r
102         // fix stopped mousedowns on the document\r
103         if(el == DOC && ename == "mousedown"){\r
104             Ext.EventManager.stoppedMouseDownEvent.addListener(wrap);\r
105         }\r
106     };\r
107 \r
108     function fireDocReady(){\r
109         if(!docReadyState){\r
110             Ext.isReady = docReadyState = true;\r
111             if(docReadyProcId){\r
112                 clearInterval(docReadyProcId);\r
113             }\r
114             if(Ext.isGecko || Ext.isOpera) {\r
115                 DOC.removeEventListener(DOMCONTENTLOADED, fireDocReady, false);\r
116             }\r
117             if(Ext.isIE){\r
118                 var defer = DOC.getElementById(IEDEFERED);\r
119                 if(defer){\r
120                     defer.onreadystatechange = null;\r
121                     defer.parentNode.removeChild(defer);\r
122                 }\r
123             }\r
124             if(docReadyEvent){\r
125                 docReadyEvent.fire();\r
126                 docReadyEvent.listeners = []; // clearListeners no longer compatible.  Force single: true?\r
127             }\r
128         }\r
129     };\r
130 \r
131     function initDocReady(){\r
132         var COMPLETE = "complete";\r
133 \r
134         docReadyEvent = new Ext.util.Event();\r
135         if (Ext.isGecko || Ext.isOpera) {\r
136             DOC.addEventListener(DOMCONTENTLOADED, fireDocReady, false);\r
137         } else if (Ext.isIE){\r
138             DOC.write("<s"+'cript id=' + IEDEFERED + ' defer="defer" src="/'+'/:"></s'+"cript>");\r
139             DOC.getElementById(IEDEFERED).onreadystatechange = function(){\r
140                 if(this.readyState == COMPLETE){\r
141                     fireDocReady();\r
142                 }\r
143             };\r
144         } else if (Ext.isWebKit){\r
145             docReadyProcId = setInterval(function(){\r
146                 if(DOC.readyState == COMPLETE) {\r
147                     fireDocReady();\r
148                  }\r
149             }, 10);\r
150         }\r
151         // no matter what, make sure it fires on load\r
152         E.on(WINDOW, "load", fireDocReady);\r
153     };\r
154 \r
155     function createTargeted(h, o){\r
156         return function(){\r
157             var args = Ext.toArray(arguments);\r
158             if(o.target == Ext.EventObject.setEvent(args[0]).target){\r
159                 h.apply(this, args);\r
160             }\r
161         };\r
162     };\r
163 \r
164     function createBuffered(h, o, task){\r
165         return function(e){\r
166             // create new event object impl so new events don't wipe out properties\r
167             task.delay(o.buffer, h, null, [new Ext.EventObjectImpl(e)]);\r
168         };\r
169     };\r
170 \r
171     function createSingle(h, el, ename, fn, scope){\r
172         return function(e){\r
173             Ext.EventManager.removeListener(el, ename, fn, scope);\r
174             h(e);\r
175         };\r
176     };\r
177 \r
178     function createDelayed(h, o, fn){\r
179         return function(e){\r
180             var task = new Ext.util.DelayedTask(h);\r
181             if(!fn.tasks) {\r
182                 fn.tasks = [];\r
183             }\r
184             fn.tasks.push(task);\r
185             task.delay(o.delay || 10, h, null, [new Ext.EventObjectImpl(e)]);\r
186         };\r
187     };\r
188 \r
189     function listen(element, ename, opt, fn, scope){\r
190         var o = !Ext.isObject(opt) ? {} : opt,\r
191             el = Ext.getDom(element), task;\r
192 \r
193         fn = fn || o.fn;\r
194         scope = scope || o.scope;\r
195 \r
196         if(!el){\r
197             throw "Error listening for \"" + ename + '\". Element "' + element + '" doesn\'t exist.';\r
198         }\r
199         function h(e){\r
200             // prevent errors while unload occurring\r
201             if(!Ext){// !window[xname]){  ==> can't we do this?\r
202                 return;\r
203             }\r
204             e = Ext.EventObject.setEvent(e);\r
205             var t;\r
206             if (o.delegate) {\r
207                 if(!(t = e.getTarget(o.delegate, el))){\r
208                     return;\r
209                 }\r
210             } else {\r
211                 t = e.target;\r
212             }\r
213             if (o.stopEvent) {\r
214                 e.stopEvent();\r
215             }\r
216             if (o.preventDefault) {\r
217                e.preventDefault();\r
218             }\r
219             if (o.stopPropagation) {\r
220                 e.stopPropagation();\r
221             }\r
222             if (o.normalized) {\r
223                 e = e.browserEvent;\r
224             }\r
225 \r
226             fn.call(scope || el, e, t, o);\r
227         };\r
228         if(o.target){\r
229             h = createTargeted(h, o);\r
230         }\r
231         if(o.delay){\r
232             h = createDelayed(h, o, fn);\r
233         }\r
234         if(o.single){\r
235             h = createSingle(h, el, ename, fn, scope);\r
236         }\r
237         if(o.buffer){\r
238             task = new Ext.util.DelayedTask(h);\r
239             h = createBuffered(h, o, task);\r
240         }\r
241 \r
242         addListener(el, ename, fn, task, h, scope);\r
243         return h;\r
244     };\r
245 \r
246     var pub = {\r
247         <div id="method-Ext.EventManager-addListener"></div>/**\r
248          * Appends an event handler to an element.  The shorthand version {@link #on} is equivalent.  Typically you will\r
249          * use {@link Ext.Element#addListener} directly on an Element in favor of calling this version.\r
250          * @param {String/HTMLElement} el The html element or id to assign the event handler to.\r
251          * @param {String} eventName The name of the event to listen for.\r
252          * @param {Function} handler The handler function the event invokes. This function is passed\r
253          * the following parameters:<ul>\r
254          * <li>evt : EventObject<div class="sub-desc">The {@link Ext.EventObject EventObject} describing the event.</div></li>\r
255          * <li>t : Element<div class="sub-desc">The {@link Ext.Element Element} which was the target of the event.\r
256          * Note that this may be filtered by using the <tt>delegate</tt> option.</div></li>\r
257          * <li>o : Object<div class="sub-desc">The options object from the addListener call.</div></li>\r
258          * </ul>\r
259          * @param {Object} scope (optional) The scope (<b><code>this</code></b> reference) in which the handler function is executed. <b>Defaults to the Element</b>.\r
260          * @param {Object} options (optional) An object containing handler configuration properties.\r
261          * This may contain any of the following properties:<ul>\r
262          * <li>scope : Object<div class="sub-desc">The scope (<b><code>this</code></b> reference) in which the handler function is executed. <b>Defaults to the Element</b>.</div></li>\r
263          * <li>delegate : String<div class="sub-desc">A simple selector to filter the target or look for a descendant of the target</div></li>\r
264          * <li>stopEvent : Boolean<div class="sub-desc">True to stop the event. That is stop propagation, and prevent the default action.</div></li>\r
265          * <li>preventDefault : Boolean<div class="sub-desc">True to prevent the default action</div></li>\r
266          * <li>stopPropagation : Boolean<div class="sub-desc">True to prevent event propagation</div></li>\r
267          * <li>normalized : Boolean<div class="sub-desc">False to pass a browser event to the handler function instead of an Ext.EventObject</div></li>\r
268          * <li>delay : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after te event fires.</div></li>\r
269          * <li>single : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>\r
270          * <li>buffer : Number<div class="sub-desc">Causes the handler to be scheduled to run in an {@link Ext.util.DelayedTask} delayed\r
271          * by the specified number of milliseconds. If the event fires again within that time, the original\r
272          * handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\r
273          * <li>target : Element<div class="sub-desc">Only call the handler if the event was fired on the target Element, <i>not</i> if the event was bubbled up from a child node.</div></li>\r
274          * </ul><br>\r
275          * <p>See {@link Ext.Element#addListener} for examples of how to use these options.</p>\r
276          */\r
277         addListener : function(element, eventName, fn, scope, options){\r
278             if(Ext.isObject(eventName)){\r
279                 var o = eventName, e, val;\r
280                 for(e in o){\r
281                     val = o[e];\r
282                     if(!propRe.test(e)){\r
283                         if(Ext.isFunction(val)){\r
284                             // shared options\r
285                             listen(element, e, o, val, o.scope);\r
286                         }else{\r
287                             // individual options\r
288                             listen(element, e, val);\r
289                         }\r
290                     }\r
291                 }\r
292             } else {\r
293                 listen(element, eventName, options, fn, scope);\r
294             }\r
295         },\r
296 \r
297         <div id="method-Ext.EventManager-removeListener"></div>/**\r
298          * Removes an event handler from an element.  The shorthand version {@link #un} is equivalent.  Typically\r
299          * you will use {@link Ext.Element#removeListener} directly on an Element in favor of calling this version.\r
300          * @param {String/HTMLElement} el The id or html element from which to remove the listener.\r
301          * @param {String} eventName The name of the event.\r
302          * @param {Function} fn The handler function to remove. <b>This must be a reference to the function passed into the {@link #addListener} call.</b>\r
303          * @param {Object} scope If a scope (<b><code>this</code></b> reference) was specified when the listener was added,\r
304          * then this must refer to the same object.\r
305          */\r
306         removeListener : function(el, eventName, fn, scope){\r
307             el = Ext.getDom(el);\r
308             var id = getId(el),\r
309                 f = el && (Ext.elCache[id].events)[eventName] || [],\r
310                 wrap, i, l, k, len, fnc;\r
311 \r
312             for (i = 0, len = f.length; i < len; i++) {\r
313 \r
314                 /* 0 = Original Function,\r
315                    1 = Event Manager Wrapped Function,\r
316                    2 = Scope,\r
317                    3 = Adapter Wrapped Function,\r
318                    4 = Buffered Task\r
319                 */\r
320                 if (Ext.isArray(fnc = f[i]) && fnc[0] == fn && (!scope || fnc[2] == scope)) {\r
321                     if(fnc[4]) {\r
322                         fnc[4].cancel();\r
323                     }\r
324                     k = fn.tasks && fn.tasks.length;\r
325                     if(k) {\r
326                         while(k--) {\r
327                             fn.tasks[k].cancel();\r
328                         }\r
329                         delete fn.tasks;\r
330                     }\r
331                     wrap = fnc[1];\r
332                     E.un(el, eventName, E.extAdapter ? fnc[3] : wrap);\r
333 \r
334                     // jQuery workaround that should be removed from Ext Core\r
335                     if(wrap && el.addEventListener && eventName == "mousewheel"){\r
336                         el.removeEventListener("DOMMouseScroll", wrap, false);\r
337                     }\r
338 \r
339                     // fix stopped mousedowns on the document\r
340                     if(wrap && el == DOC && eventName == "mousedown"){\r
341                         Ext.EventManager.stoppedMouseDownEvent.removeListener(wrap);\r
342                     }\r
343 \r
344                     f.splice(i, 1);\r
345                     if (f.length === 0) {\r
346                         delete Ext.elCache[id].events[eventName];\r
347                     }\r
348                     for (k in Ext.elCache[id].events) {\r
349                         return false;\r
350                     }\r
351                     Ext.elCache[id].events = {};\r
352                     return false;\r
353                 }\r
354             }\r
355         },\r
356 \r
357         <div id="method-Ext.EventManager-removeAll"></div>/**\r
358          * Removes all event handers from an element.  Typically you will use {@link Ext.Element#removeAllListeners}\r
359          * directly on an Element in favor of calling this version.\r
360          * @param {String/HTMLElement} el The id or html element from which to remove all event handlers.\r
361          */\r
362         removeAll : function(el){\r
363             el = Ext.getDom(el);\r
364             var id = getId(el),\r
365                 ec = Ext.elCache[id] || {},\r
366                 es = ec.events || {},\r
367                 f, i, len, ename, fn, k, wrap;\r
368 \r
369             for(ename in es){\r
370                 if(es.hasOwnProperty(ename)){\r
371                     f = es[ename];\r
372                     /* 0 = Original Function,\r
373                        1 = Event Manager Wrapped Function,\r
374                        2 = Scope,\r
375                        3 = Adapter Wrapped Function,\r
376                        4 = Buffered Task\r
377                     */\r
378                     for (i = 0, len = f.length; i < len; i++) {\r
379                         fn = f[i];\r
380                         if(fn[4]) {\r
381                             fn[4].cancel();\r
382                         }\r
383                         if(fn[0].tasks && (k = fn[0].tasks.length)) {\r
384                             while(k--) {\r
385                                 fn[0].tasks[k].cancel();\r
386                             }\r
387                             delete fn.tasks;\r
388                         }\r
389                         wrap =  fn[1];\r
390                         E.un(el, ename, E.extAdapter ? fn[3] : wrap);\r
391 \r
392                         // jQuery workaround that should be removed from Ext Core\r
393                         if(el.addEventListener && wrap && ename == "mousewheel"){\r
394                             el.removeEventListener("DOMMouseScroll", wrap, false);\r
395                         }\r
396 \r
397                         // fix stopped mousedowns on the document\r
398                         if(wrap && el == DOC &&  ename == "mousedown"){\r
399                             Ext.EventManager.stoppedMouseDownEvent.removeListener(wrap);\r
400                         }\r
401                     }\r
402                 }\r
403             }\r
404             if (Ext.elCache[id]) {\r
405                 Ext.elCache[id].events = {};\r
406             }\r
407         },\r
408 \r
409         getListeners : function(el, eventName) {\r
410             el = Ext.getDom(el);\r
411             var id = getId(el),\r
412                 ec = Ext.elCache[id] || {},\r
413                 es = ec.events || {},\r
414                 results = [];\r
415             if (es && es[eventName]) {\r
416                 return es[eventName];\r
417             } else {\r
418                 return null;\r
419             }\r
420         },\r
421 \r
422         purgeElement : function(el, recurse, eventName) {\r
423             el = Ext.getDom(el);\r
424             var id = getId(el),\r
425                 ec = Ext.elCache[id] || {},\r
426                 es = ec.events || {},\r
427                 i, f, len;\r
428             if (eventName) {\r
429                 if (es && es.hasOwnProperty(eventName)) {\r
430                     f = es[eventName];\r
431                     for (i = 0, len = f.length; i < len; i++) {\r
432                         Ext.EventManager.removeListener(el, eventName, f[i][0]);\r
433                     }\r
434                 }\r
435             } else {\r
436                 Ext.EventManager.removeAll(el);\r
437             }\r
438             if (recurse && el && el.childNodes) {\r
439                 for (i = 0, len = el.childNodes.length; i < len; i++) {\r
440                     Ext.EventManager.purgeElement(el.childNodes[i], recurse, eventName);\r
441                 }\r
442             }\r
443         },\r
444 \r
445         _unload : function() {\r
446             var el;\r
447             for (el in Ext.elCache) {\r
448                 Ext.EventManager.removeAll(el);\r
449             }\r
450             delete Ext.elCache;\r
451             delete Ext.Element._flyweights;\r
452         },\r
453         <div id="method-Ext.EventManager-onDocumentReady"></div>/**\r
454          * Adds a listener to be notified when the document is ready (before onload and before images are loaded). Can be\r
455          * accessed shorthanded as Ext.onReady().\r
456          * @param {Function} fn The method the event invokes.\r
457          * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the handler function executes. Defaults to the browser window.\r
458          * @param {boolean} options (optional) Options object as passed to {@link Ext.Element#addListener}. It is recommended that the options\r
459          * <code>{single: true}</code> be used so that the handler is removed on first invocation.\r
460          */\r
461         onDocumentReady : function(fn, scope, options){\r
462             if(docReadyState){ // if it already fired\r
463                 docReadyEvent.addListener(fn, scope, options);\r
464                 docReadyEvent.fire();\r
465                 docReadyEvent.listeners = []; // clearListeners no longer compatible.  Force single: true?\r
466             } else {\r
467                 if(!docReadyEvent) initDocReady();\r
468                 options = options || {};\r
469                 options.delay = options.delay || 1;\r
470                 docReadyEvent.addListener(fn, scope, options);\r
471             }\r
472         }\r
473     };\r
474      <div id="method-Ext.EventManager-on"></div>/**\r
475      * Appends an event handler to an element.  Shorthand for {@link #addListener}.\r
476      * @param {String/HTMLElement} el The html element or id to assign the event handler to\r
477      * @param {String} eventName The name of the event to listen for.\r
478      * @param {Function} handler The handler function the event invokes.\r
479      * @param {Object} scope (optional) (<code>this</code> reference) in which the handler function executes. <b>Defaults to the Element</b>.\r
480      * @param {Object} options (optional) An object containing standard {@link #addListener} options\r
481      * @member Ext.EventManager\r
482      * @method on\r
483      */\r
484     pub.on = pub.addListener;\r
485     <div id="method-Ext.EventManager-un"></div>/**\r
486      * Removes an event handler from an element.  Shorthand for {@link #removeListener}.\r
487      * @param {String/HTMLElement} el The id or html element from which to remove the listener.\r
488      * @param {String} eventName The name of the event.\r
489      * @param {Function} fn The handler function to remove. <b>This must be a reference to the function passed into the {@link #on} call.</b>\r
490      * @param {Object} scope If a scope (<b><code>this</code></b> reference) was specified when the listener was added,\r
491      * then this must refer to the same object.\r
492      * @member Ext.EventManager\r
493      * @method un\r
494      */\r
495     pub.un = pub.removeListener;\r
496 \r
497     pub.stoppedMouseDownEvent = new Ext.util.Event();\r
498     return pub;\r
499 }();\r
500 <div id="method-Ext-onReady"></div>/**\r
501   * Adds a listener to be notified when the document is ready (before onload and before images are loaded). Shorthand of {@link Ext.EventManager#onDocumentReady}.\r
502   * @param {Function} fn The method the event invokes.\r
503   * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the handler function executes. Defaults to the browser window.\r
504   * @param {boolean} options (optional) Options object as passed to {@link Ext.Element#addListener}. It is recommended that the options\r
505   * <code>{single: true}</code> be used so that the handler is removed on first invocation.\r
506   * @member Ext\r
507   * @method onReady\r
508  */\r
509 Ext.onReady = Ext.EventManager.onDocumentReady;\r
510 \r
511 \r
512 //Initialize doc classes\r
513 (function(){\r
514 \r
515     var initExtCss = function(){\r
516         // find the body element\r
517         var bd = document.body || document.getElementsByTagName('body')[0];\r
518         if(!bd){ return false; }\r
519         var cls = [' ',\r
520                 Ext.isIE ? "ext-ie " + (Ext.isIE6 ? 'ext-ie6' : (Ext.isIE7 ? 'ext-ie7' : 'ext-ie8'))\r
521                 : Ext.isGecko ? "ext-gecko " + (Ext.isGecko2 ? 'ext-gecko2' : 'ext-gecko3')\r
522                 : Ext.isOpera ? "ext-opera"\r
523                 : Ext.isWebKit ? "ext-webkit" : ""];\r
524 \r
525         if(Ext.isSafari){\r
526             cls.push("ext-safari " + (Ext.isSafari2 ? 'ext-safari2' : (Ext.isSafari3 ? 'ext-safari3' : 'ext-safari4')));\r
527         }else if(Ext.isChrome){\r
528             cls.push("ext-chrome");\r
529         }\r
530 \r
531         if(Ext.isMac){\r
532             cls.push("ext-mac");\r
533         }\r
534         if(Ext.isLinux){\r
535             cls.push("ext-linux");\r
536         }\r
537 \r
538         if(Ext.isStrict || Ext.isBorderBox){ // add to the parent to allow for selectors like ".ext-strict .ext-ie"\r
539             var p = bd.parentNode;\r
540             if(p){\r
541                 p.className += Ext.isStrict ? ' ext-strict' : ' ext-border-box';\r
542             }\r
543         }\r
544         bd.className += cls.join(' ');\r
545         return true;\r
546     }\r
547 \r
548     if(!initExtCss()){\r
549         Ext.onReady(initExtCss);\r
550     }\r
551 })();\r
552 \r
553 \r
554 <div id="cls-Ext.EventObject"></div>/**\r
555  * @class Ext.EventObject\r
556  * Just as {@link Ext.Element} wraps around a native DOM node, Ext.EventObject\r
557  * wraps the browser's native event-object normalizing cross-browser differences,\r
558  * such as which mouse button is clicked, keys pressed, mechanisms to stop\r
559  * event-propagation along with a method to prevent default actions from taking place.\r
560  * <p>For example:</p>\r
561  * <pre><code>\r
562 function handleClick(e, t){ // e is not a standard event object, it is a Ext.EventObject\r
563     e.preventDefault();\r
564     var target = e.getTarget(); // same as t (the target HTMLElement)\r
565     ...\r
566 }\r
567 var myDiv = {@link Ext#get Ext.get}("myDiv");  // get reference to an {@link Ext.Element}\r
568 myDiv.on(         // 'on' is shorthand for addListener\r
569     "click",      // perform an action on click of myDiv\r
570     handleClick   // reference to the action handler\r
571 );\r
572 // other methods to do the same:\r
573 Ext.EventManager.on("myDiv", 'click', handleClick);\r
574 Ext.EventManager.addListener("myDiv", 'click', handleClick);\r
575  </code></pre>\r
576  * @singleton\r
577  */\r
578 Ext.EventObject = function(){\r
579     var E = Ext.lib.Event,\r
580         // safari keypress events for special keys return bad keycodes\r
581         safariKeys = {\r
582             3 : 13, // enter\r
583             63234 : 37, // left\r
584             63235 : 39, // right\r
585             63232 : 38, // up\r
586             63233 : 40, // down\r
587             63276 : 33, // page up\r
588             63277 : 34, // page down\r
589             63272 : 46, // delete\r
590             63273 : 36, // home\r
591             63275 : 35  // end\r
592         },\r
593         // normalize button clicks\r
594         btnMap = Ext.isIE ? {1:0,4:1,2:2} :\r
595                 (Ext.isWebKit ? {1:0,2:1,3:2} : {0:0,1:1,2:2});\r
596 \r
597     Ext.EventObjectImpl = function(e){\r
598         if(e){\r
599             this.setEvent(e.browserEvent || e);\r
600         }\r
601     };\r
602 \r
603     Ext.EventObjectImpl.prototype = {\r
604            /** @private */\r
605         setEvent : function(e){\r
606             var me = this;\r
607             if(e == me || (e && e.browserEvent)){ // already wrapped\r
608                 return e;\r
609             }\r
610             me.browserEvent = e;\r
611             if(e){\r
612                 // normalize buttons\r
613                 me.button = e.button ? btnMap[e.button] : (e.which ? e.which - 1 : -1);\r
614                 if(e.type == 'click' && me.button == -1){\r
615                     me.button = 0;\r
616                 }\r
617                 me.type = e.type;\r
618                 me.shiftKey = e.shiftKey;\r
619                 // mac metaKey behaves like ctrlKey\r
620                 me.ctrlKey = e.ctrlKey || e.metaKey || false;\r
621                 me.altKey = e.altKey;\r
622                 // in getKey these will be normalized for the mac\r
623                 me.keyCode = e.keyCode;\r
624                 me.charCode = e.charCode;\r
625                 // cache the target for the delayed and or buffered events\r
626                 me.target = E.getTarget(e);\r
627                 // same for XY\r
628                 me.xy = E.getXY(e);\r
629             }else{\r
630                 me.button = -1;\r
631                 me.shiftKey = false;\r
632                 me.ctrlKey = false;\r
633                 me.altKey = false;\r
634                 me.keyCode = 0;\r
635                 me.charCode = 0;\r
636                 me.target = null;\r
637                 me.xy = [0, 0];\r
638             }\r
639             return me;\r
640         },\r
641 \r
642         <div id="method-Ext.EventObject-stopEvent"></div>/**\r
643          * Stop the event (preventDefault and stopPropagation)\r
644          */\r
645         stopEvent : function(){\r
646             var me = this;\r
647             if(me.browserEvent){\r
648                 if(me.browserEvent.type == 'mousedown'){\r
649                     Ext.EventManager.stoppedMouseDownEvent.fire(me);\r
650                 }\r
651                 E.stopEvent(me.browserEvent);\r
652             }\r
653         },\r
654 \r
655         <div id="method-Ext.EventObject-preventDefault"></div>/**\r
656          * Prevents the browsers default handling of the event.\r
657          */\r
658         preventDefault : function(){\r
659             if(this.browserEvent){\r
660                 E.preventDefault(this.browserEvent);\r
661             }\r
662         },\r
663 \r
664         <div id="method-Ext.EventObject-stopPropagation"></div>/**\r
665          * Cancels bubbling of the event.\r
666          */\r
667         stopPropagation : function(){\r
668             var me = this;\r
669             if(me.browserEvent){\r
670                 if(me.browserEvent.type == 'mousedown'){\r
671                     Ext.EventManager.stoppedMouseDownEvent.fire(me);\r
672                 }\r
673                 E.stopPropagation(me.browserEvent);\r
674             }\r
675         },\r
676 \r
677         <div id="method-Ext.EventObject-getCharCode"></div>/**\r
678          * Gets the character code for the event.\r
679          * @return {Number}\r
680          */\r
681         getCharCode : function(){\r
682             return this.charCode || this.keyCode;\r
683         },\r
684 \r
685         <div id="method-Ext.EventObject-getKey"></div>/**\r
686          * Returns a normalized keyCode for the event.\r
687          * @return {Number} The key code\r
688          */\r
689         getKey : function(){\r
690             return this.normalizeKey(this.keyCode || this.charCode)\r
691         },\r
692 \r
693         // private\r
694         normalizeKey: function(k){\r
695             return Ext.isSafari ? (safariKeys[k] || k) : k;\r
696         },\r
697 \r
698         <div id="method-Ext.EventObject-getPageX"></div>/**\r
699          * Gets the x coordinate of the event.\r
700          * @return {Number}\r
701          */\r
702         getPageX : function(){\r
703             return this.xy[0];\r
704         },\r
705 \r
706         <div id="method-Ext.EventObject-getPageY"></div>/**\r
707          * Gets the y coordinate of the event.\r
708          * @return {Number}\r
709          */\r
710         getPageY : function(){\r
711             return this.xy[1];\r
712         },\r
713 \r
714         <div id="method-Ext.EventObject-getXY"></div>/**\r
715          * Gets the page coordinates of the event.\r
716          * @return {Array} The xy values like [x, y]\r
717          */\r
718         getXY : function(){\r
719             return this.xy;\r
720         },\r
721 \r
722         <div id="method-Ext.EventObject-getTarget"></div>/**\r
723          * Gets the target for the event.\r
724          * @param {String} selector (optional) A simple selector to filter the target or look for an ancestor of the target\r
725          * @param {Number/Mixed} maxDepth (optional) The max depth to\r
726                 search as a number or element (defaults to 10 || document.body)\r
727          * @param {Boolean} returnEl (optional) True to return a Ext.Element object instead of DOM node\r
728          * @return {HTMLelement}\r
729          */\r
730         getTarget : function(selector, maxDepth, returnEl){\r
731             return selector ? Ext.fly(this.target).findParent(selector, maxDepth, returnEl) : (returnEl ? Ext.get(this.target) : this.target);\r
732         },\r
733 \r
734         <div id="method-Ext.EventObject-getRelatedTarget"></div>/**\r
735          * Gets the related target.\r
736          * @return {HTMLElement}\r
737          */\r
738         getRelatedTarget : function(){\r
739             return this.browserEvent ? E.getRelatedTarget(this.browserEvent) : null;\r
740         },\r
741 \r
742         <div id="method-Ext.EventObject-getWheelDelta"></div>/**\r
743          * Normalizes mouse wheel delta across browsers\r
744          * @return {Number} The delta\r
745          */\r
746         getWheelDelta : function(){\r
747             var e = this.browserEvent;\r
748             var delta = 0;\r
749             if(e.wheelDelta){ /* IE/Opera. */\r
750                 delta = e.wheelDelta/120;\r
751             }else if(e.detail){ /* Mozilla case. */\r
752                 delta = -e.detail/3;\r
753             }\r
754             return delta;\r
755         },\r
756 \r
757         <div id="method-Ext.EventObject-within"></div>/**\r
758         * Returns true if the target of this event is a child of el.  Unless the allowEl parameter is set, it will return false if if the target is el.\r
759         * Example usage:<pre><code>\r
760         // Handle click on any child of an element\r
761         Ext.getBody().on('click', function(e){\r
762             if(e.within('some-el')){\r
763                 alert('Clicked on a child of some-el!');\r
764             }\r
765         });\r
766 \r
767         // Handle click directly on an element, ignoring clicks on child nodes\r
768         Ext.getBody().on('click', function(e,t){\r
769             if((t.id == 'some-el') && !e.within(t, true)){\r
770                 alert('Clicked directly on some-el!');\r
771             }\r
772         });\r
773         </code></pre>\r
774          * @param {Mixed} el The id, DOM element or Ext.Element to check\r
775          * @param {Boolean} related (optional) true to test if the related target is within el instead of the target\r
776          * @param {Boolean} allowEl {optional} true to also check if the passed element is the target or related target\r
777          * @return {Boolean}\r
778          */\r
779         within : function(el, related, allowEl){\r
780             if(el){\r
781                 var t = this[related ? "getRelatedTarget" : "getTarget"]();\r
782                 return t && ((allowEl ? (t == Ext.getDom(el)) : false) || Ext.fly(el).contains(t));\r
783             }\r
784             return false;\r
785         }\r
786      };\r
787 \r
788     return new Ext.EventObjectImpl();\r
789 }();\r
790 </pre>    \r
791 </body>\r
792 </html>