4 * Copyright(c) 2006-2007, Ext JS, LLC.
6 * Originally Released Under LGPL - original licence link has changed is not relivant.
9 * <script type="text/javascript">
13 * @class Roo.EventManager
14 * Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides
15 * several useful events directly.
16 * See {@link Roo.EventObject} for more details on normalized event objects.
19 Roo.EventManager = function(){
20 var docReadyEvent, docReadyProcId, docReadyState = false;
21 var resizeEvent, resizeTask, textEvent, textSize;
22 var E = Roo.lib.Event;
28 var fireDocReady = function(){
33 clearInterval(docReadyProcId);
35 if(Roo.isGecko || Roo.isOpera) {
36 document.removeEventListener("DOMContentLoaded", fireDocReady, false);
39 var defer = document.getElementById("ie-deferred-loader");
41 defer.onreadystatechange = null;
42 defer.parentNode.removeChild(defer);
47 docReadyEvent.clearListeners();
52 var initDocReady = function(){
53 docReadyEvent = new Roo.util.Event();
54 if(Roo.isGecko || Roo.isOpera) {
55 document.addEventListener("DOMContentLoaded", fireDocReady, false);
57 document.write("<s"+'cript id="ie-deferred-loader" defer="defer" src="/'+'/:"></s'+"cript>");
58 var defer = document.getElementById("ie-deferred-loader");
59 defer.onreadystatechange = function(){
60 if(this.readyState == "complete"){
64 }else if(Roo.isSafari){
65 docReadyProcId = setInterval(function(){
66 var rs = document.readyState;
67 if(rs == "complete") {
72 // no matter what, make sure it fires on load
73 E.on(window, "load", fireDocReady);
76 var createBuffered = function(h, o){
77 var task = new Roo.util.DelayedTask(h);
79 // create new event object impl so new events don't wipe out properties
80 e = new Roo.EventObjectImpl(e);
81 task.delay(o.buffer, h, null, [e]);
85 var createSingle = function(h, el, ename, fn){
87 Roo.EventManager.removeListener(el, ename, fn);
92 var createDelayed = function(h, o){
94 // create new event object impl so new events don't wipe out properties
95 e = new Roo.EventObjectImpl(e);
96 setTimeout(function(){
101 var transitionEndVal = false;
103 var transitionEnd = function()
105 if (transitionEndVal) {
106 return transitionEndVal;
108 var el = document.createElement('div')
110 var transEndEventNames = {
111 WebkitTransition : 'webkitTransitionEnd',
112 MozTransition : 'transitionend',
113 OTransition : 'oTransitionEnd otransitionend',
114 transition : 'transitionend'
117 for (var name in transEndEventNames) {
118 if (el.style[name] !== undefined) {
119 transitionEndVal = transEndEventNames[name];
120 return transitionEndVal ;
126 var listen = function(element, ename, opt, fn, scope){
127 var o = (!opt || typeof opt == "boolean") ? {} : opt;
128 fn = fn || o.fn; scope = scope || o.scope;
129 var el = Roo.getDom(element);
131 throw "Error listening for \"" + ename + '\". Element "' + element + '" doesn\'t exist.';
134 e = Roo.EventObject.setEvent(e);
137 t = e.getTarget(o.delegate, el);
144 if(o.stopEvent === true){
147 if(o.preventDefault === true){
150 if(o.stopPropagation === true){
154 if(o.normalized === false){
158 fn.call(scope || el, e, t, o);
161 h = createDelayed(h, o);
164 h = createSingle(h, el, ename, fn);
167 h = createBuffered(h, o);
169 fn._handlers = fn._handlers || [];
170 fn._handlers.push([Roo.id(el), ename, h]);
172 if (ename == 'transitionend') {
173 ename = transitionEnd();
177 if(ename == "mousewheel" && el.addEventListener){ // workaround for jQuery
178 el.addEventListener("DOMMouseScroll", h, false);
179 E.on(window, 'unload', function(){
180 el.removeEventListener("DOMMouseScroll", h, false);
183 if(ename == "mousedown" && el == document){ // fix stopped mousedowns on the document
184 Roo.EventManager.stoppedMouseDownEvent.addListener(h);
189 var stopListening = function(el, ename, fn){
190 var id = Roo.id(el), hds = fn._handlers, hd = fn;
192 for(var i = 0, len = hds.length; i < len; i++){
194 if(h[0] == id && h[1] == ename){
203 if(ename == "mousewheel" && el.addEventListener){
204 el.removeEventListener("DOMMouseScroll", hd, false);
206 if(ename == "mousedown" && el == document){ // fix stopped mousedowns on the document
207 Roo.EventManager.stoppedMouseDownEvent.removeListener(hd);
211 var propRe = /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate)$/;
218 * @scope Roo.EventManager
223 * This is no longer needed and is deprecated. Places a simple wrapper around an event handler to override the browser event
224 * object with a Roo.EventObject
225 * @param {Function} fn The method the event invokes
226 * @param {Object} scope An object that becomes the scope of the handler
227 * @param {boolean} override If true, the obj passed in becomes
228 * the execution scope of the listener
229 * @return {Function} The wrapped function
232 wrap : function(fn, scope, override){
234 Roo.EventObject.setEvent(e);
235 fn.call(override ? scope || window : window, Roo.EventObject, scope);
240 * Appends an event handler to an element (shorthand for addListener)
241 * @param {String/HTMLElement} element The html element or id to assign the
242 * @param {String} eventName The type of event to listen for
243 * @param {Function} handler The method the event invokes
244 * @param {Object} scope (optional) The scope in which to execute the handler
245 * function. The handler function's "this" context.
246 * @param {Object} options (optional) An object containing handler configuration
247 * properties. This may contain any of the following properties:<ul>
248 * <li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li>
249 * <li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li>
250 * <li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li>
251 * <li>preventDefault {Boolean} True to prevent the default action</li>
252 * <li>stopPropagation {Boolean} True to prevent event propagation</li>
253 * <li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li>
254 * <li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>
255 * <li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>
256 * <li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed
257 * by the specified number of milliseconds. If the event fires again within that time, the original
258 * handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>
261 * <b>Combining Options</b><br>
262 * Using the options argument, it is possible to combine different types of listeners:<br>
264 * A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style="margin: 5px 20px 20px;">
266 el.on('click', this.onClick, this, {
273 * <b>Attaching multiple handlers in 1 call</b><br>
274 * The method also allows for a single argument to be passed which is a config object containing properties
275 * which specify multiple handlers.
294 * Or a shorthand syntax:<br>
297 'click' : this.onClick,
298 'mouseover' : this.onMouseOver,
299 'mouseout' : this.onMouseOut
303 addListener : function(element, eventName, fn, scope, options){
304 if(typeof eventName == "object"){
310 if(typeof o[e] == "function"){
312 listen(element, e, o, o[e], o.scope);
314 // individual options
315 listen(element, e, o[e]);
320 return listen(element, eventName, options, fn, scope);
324 * Removes an event handler
326 * @param {String/HTMLElement} element The id or html element to remove the
328 * @param {String} eventName The type of event
329 * @param {Function} fn
330 * @return {Boolean} True if a listener was actually removed
332 removeListener : function(element, eventName, fn){
333 return stopListening(element, eventName, fn);
337 * Fires when the document is ready (before onload and before images are loaded). Can be
338 * accessed shorthanded Roo.onReady().
339 * @param {Function} fn The method the event invokes
340 * @param {Object} scope An object that becomes the scope of the handler
341 * @param {boolean} options
343 onDocumentReady : function(fn, scope, options){
344 if(docReadyState){ // if it already fired
345 docReadyEvent.addListener(fn, scope, options);
346 docReadyEvent.fire();
347 docReadyEvent.clearListeners();
353 docReadyEvent.addListener(fn, scope, options);
357 * Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and height to handlers.
358 * @param {Function} fn The method the event invokes
359 * @param {Object} scope An object that becomes the scope of the handler
360 * @param {boolean} options
362 onWindowResize : function(fn, scope, options){
364 resizeEvent = new Roo.util.Event();
365 resizeTask = new Roo.util.DelayedTask(function(){
366 resizeEvent.fire(D.getViewWidth(), D.getViewHeight());
368 E.on(window, "resize", function(){
370 resizeTask.delay(50);
372 resizeEvent.fire(D.getViewWidth(), D.getViewHeight());
376 resizeEvent.addListener(fn, scope, options);
380 * Fires when the user changes the active text size. Handler gets called with 2 params, the old size and the new size.
381 * @param {Function} fn The method the event invokes
382 * @param {Object} scope An object that becomes the scope of the handler
383 * @param {boolean} options
385 onTextResize : function(fn, scope, options){
387 textEvent = new Roo.util.Event();
388 var textEl = new Roo.Element(document.createElement('div'));
389 textEl.dom.className = 'x-text-resize';
390 textEl.dom.innerHTML = 'X';
391 textEl.appendTo(document.body);
392 textSize = textEl.dom.offsetHeight;
393 setInterval(function(){
394 if(textEl.dom.offsetHeight != textSize){
395 textEvent.fire(textSize, textSize = textEl.dom.offsetHeight);
397 }, this.textResizeInterval);
399 textEvent.addListener(fn, scope, options);
403 * Removes the passed window resize listener.
404 * @param {Function} fn The method the event invokes
405 * @param {Object} scope The scope of handler
407 removeResizeListener : function(fn, scope){
409 resizeEvent.removeListener(fn, scope);
414 fireResize : function(){
416 resizeEvent.fire(D.getViewWidth(), D.getViewHeight());
420 * Url used for onDocumentReady with using SSL (defaults to Roo.SSL_SECURE_URL)
424 * The frequency, in milliseconds, to check for text resize events (defaults to 50)
426 textResizeInterval : 50
431 * @scopeAlias pub=Roo.EventManager
435 * Appends an event handler to an element (shorthand for addListener)
436 * @param {String/HTMLElement} element The html element or id to assign the
437 * @param {String} eventName The type of event to listen for
438 * @param {Function} handler The method the event invokes
439 * @param {Object} scope (optional) The scope in which to execute the handler
440 * function. The handler function's "this" context.
441 * @param {Object} options (optional) An object containing handler configuration
442 * properties. This may contain any of the following properties:<ul>
443 * <li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li>
444 * <li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li>
445 * <li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li>
446 * <li>preventDefault {Boolean} True to prevent the default action</li>
447 * <li>stopPropagation {Boolean} True to prevent event propagation</li>
448 * <li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li>
449 * <li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>
450 * <li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>
451 * <li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed
452 * by the specified number of milliseconds. If the event fires again within that time, the original
453 * handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>
456 * <b>Combining Options</b><br>
457 * Using the options argument, it is possible to combine different types of listeners:<br>
459 * A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style="margin: 5px 20px 20px;">
461 el.on('click', this.onClick, this, {
468 * <b>Attaching multiple handlers in 1 call</b><br>
469 * The method also allows for a single argument to be passed which is a config object containing properties
470 * which specify multiple handlers.
489 * Or a shorthand syntax:<br>
492 'click' : this.onClick,
493 'mouseover' : this.onMouseOver,
494 'mouseout' : this.onMouseOut
498 pub.on = pub.addListener;
499 pub.un = pub.removeListener;
501 pub.stoppedMouseDownEvent = new Roo.util.Event();
505 * Fires when the document is ready (before onload and before images are loaded). Shorthand of {@link Roo.EventManager#onDocumentReady}.
506 * @param {Function} fn The method the event invokes
507 * @param {Object} scope An object that becomes the scope of the handler
508 * @param {boolean} override If true, the obj passed in becomes
509 * the execution scope of the listener
513 Roo.onReady = Roo.EventManager.onDocumentReady;
515 Roo.onReady(function(){
516 var bd = Roo.get(document.body);
521 : Roo.isGecko ? "roo-gecko"
522 : Roo.isOpera ? "roo-opera"
523 : Roo.isSafari ? "roo-safari" : ""];
529 cls.push("roo-linux");
532 cls.push('roo-border-box');
534 if(Roo.isStrict){ // add to the parent to allow for selectors like ".ext-strict .ext-ie"
535 var p = bd.dom.parentNode;
537 p.className += ' roo-strict';
540 bd.addClass(cls.join(' '));
544 * @class Roo.EventObject
545 * EventObject exposes the Yahoo! UI Event functionality directly on the object
546 * passed to your event handler. It exists mostly for convenience. It also fixes the annoying null checks automatically to cleanup your code
549 function handleClick(e){ // e is not a standard event object, it is a Roo.EventObject
551 var target = e.getTarget();
554 var myDiv = Roo.get("myDiv");
555 myDiv.on("click", handleClick);
557 Roo.EventManager.on("myDiv", 'click', handleClick);
558 Roo.EventManager.addListener("myDiv", 'click', handleClick);
562 Roo.EventObject = function(){
564 var E = Roo.lib.Event;
566 // safari keypress events for special keys return bad keycodes
572 63276 : 33, // page up
573 63277 : 34, // page down
574 63272 : 46, // delete
579 // normalize button clicks
580 var btnMap = Roo.isIE ? {1:0,4:1,2:2} :
581 (Roo.isSafari ? {1:0,2:1,3:2} : {0:0,1:1,2:2});
583 Roo.EventObjectImpl = function(e){
585 this.setEvent(e.browserEvent || e);
588 Roo.EventObjectImpl.prototype = {
590 * Used to fix doc tools.
591 * @scope Roo.EventObject.prototype
597 /** The normal browser event */
599 /** The button pressed in a mouse event */
601 /** True if the shift key was down during the event */
603 /** True if the control key was down during the event */
605 /** True if the alt key was down during the event */
664 setEvent : function(e){
665 if(e == this || (e && e.browserEvent)){ // already wrapped
668 this.browserEvent = e;
671 this.button = e.button ? btnMap[e.button] : (e.which ? e.which-1 : -1);
672 if(e.type == 'click' && this.button == -1){
676 this.shiftKey = e.shiftKey;
677 // mac metaKey behaves like ctrlKey
678 this.ctrlKey = e.ctrlKey || e.metaKey;
679 this.altKey = e.altKey;
680 // in getKey these will be normalized for the mac
681 this.keyCode = e.keyCode;
682 // keyup warnings on firefox.
683 this.charCode = (e.type == 'keyup' || e.type == 'keydown') ? 0 : e.charCode;
684 // cache the target for the delayed and or buffered events
685 this.target = E.getTarget(e);
687 this.xy = E.getXY(e);
690 this.shiftKey = false;
691 this.ctrlKey = false;
702 * Stop the event (preventDefault and stopPropagation)
704 stopEvent : function(){
705 if(this.browserEvent){
706 if(this.browserEvent.type == 'mousedown'){
707 Roo.EventManager.stoppedMouseDownEvent.fire(this);
709 E.stopEvent(this.browserEvent);
714 * Prevents the browsers default handling of the event.
716 preventDefault : function(){
717 if(this.browserEvent){
718 E.preventDefault(this.browserEvent);
723 isNavKeyPress : function(){
724 var k = this.keyCode;
725 k = Roo.isSafari ? (safariKeys[k] || k) : k;
726 return (k >= 33 && k <= 40) || k == this.RETURN || k == this.TAB || k == this.ESC;
729 isSpecialKey : function(){
730 var k = this.keyCode;
731 return (this.type == 'keypress' && this.ctrlKey) || k == 9 || k == 13 || k == 40 || k == 27 ||
732 (k == 16) || (k == 17) ||
733 (k >= 18 && k <= 20) ||
734 (k >= 33 && k <= 35) ||
735 (k >= 36 && k <= 39) ||
736 (k >= 44 && k <= 45);
739 * Cancels bubbling of the event.
741 stopPropagation : function(){
742 if(this.browserEvent){
743 if(this.type == 'mousedown'){
744 Roo.EventManager.stoppedMouseDownEvent.fire(this);
746 E.stopPropagation(this.browserEvent);
751 * Gets the key code for the event.
754 getCharCode : function(){
755 return this.charCode || this.keyCode;
759 * Returns a normalized keyCode for the event.
760 * @return {Number} The key code
763 var k = this.keyCode || this.charCode;
764 return Roo.isSafari ? (safariKeys[k] || k) : k;
768 * Gets the x coordinate of the event.
771 getPageX : function(){
776 * Gets the y coordinate of the event.
779 getPageY : function(){
784 * Gets the time of the event.
787 getTime : function(){
788 if(this.browserEvent){
789 return E.getTime(this.browserEvent);
795 * Gets the page coordinates of the event.
796 * @return {Array} The xy values like [x, y]
803 * Gets the target for the event.
804 * @param {String} selector (optional) A simple selector to filter the target or look for an ancestor of the target
805 * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to
806 search as a number or element (defaults to 10 || document.body)
807 * @param {Boolean} returnEl (optional) True to return a Roo.Element object instead of DOM node
808 * @return {HTMLelement}
810 getTarget : function(selector, maxDepth, returnEl){
811 return selector ? Roo.fly(this.target).findParent(selector, maxDepth, returnEl) : this.target;
814 * Gets the related target.
815 * @return {HTMLElement}
817 getRelatedTarget : function(){
818 if(this.browserEvent){
819 return E.getRelatedTarget(this.browserEvent);
825 * Normalizes mouse wheel delta across browsers
826 * @return {Number} The delta
828 getWheelDelta : function(){
829 var e = this.browserEvent;
831 if(e.wheelDelta){ /* IE/Opera. */
832 delta = e.wheelDelta/120;
833 }else if(e.detail){ /* Mozilla case. */
840 * Returns true if the control, meta, shift or alt key was pressed during this event.
843 hasModifier : function(){
844 return !!((this.ctrlKey || this.altKey) || this.shiftKey);
848 * Returns true if the target of this event equals el or is a child of el
849 * @param {String/HTMLElement/Element} el
850 * @param {Boolean} related (optional) true to test if the related target is within el instead of the target
853 within : function(el, related){
854 var t = this[related ? "getRelatedTarget" : "getTarget"]();
855 return t && Roo.fly(el).contains(t);
858 getPoint : function(){
859 return new Roo.lib.Point(this.xy[0], this.xy[1]);
863 return new Roo.EventObjectImpl();