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);
133 throw "Error listening for \"" + ename + '\". Element "' + element + '" doesn\'t exist.';
136 if (ename == 'transitionend') {
137 ename = transitionEnd();
140 e = Roo.EventObject.setEvent(e);
143 t = e.getTarget(o.delegate, el);
150 if(o.stopEvent === true){
153 if(o.preventDefault === true){
156 if(o.stopPropagation === true){
160 if(o.normalized === false){
164 fn.call(scope || el, e, t, o);
167 h = createDelayed(h, o);
170 h = createSingle(h, el, ename, fn);
173 h = createBuffered(h, o);
176 fn._handlers = fn._handlers || [];
179 fn._handlers.push([Roo.id(el), ename, h]);
184 if(ename == "mousewheel" && el.addEventListener){ // workaround for jQuery
185 el.addEventListener("DOMMouseScroll", h, false);
186 E.on(window, 'unload', function(){
187 el.removeEventListener("DOMMouseScroll", h, false);
190 if(ename == "mousedown" && el == document){ // fix stopped mousedowns on the document
191 Roo.EventManager.stoppedMouseDownEvent.addListener(h);
196 var stopListening = function(el, ename, fn){
197 var id = Roo.id(el), hds = fn._handlers, hd = fn;
199 for(var i = 0, len = hds.length; i < len; i++){
201 if(h[0] == id && h[1] == ename){
210 if(ename == "mousewheel" && el.addEventListener){
211 el.removeEventListener("DOMMouseScroll", hd, false);
213 if(ename == "mousedown" && el == document){ // fix stopped mousedowns on the document
214 Roo.EventManager.stoppedMouseDownEvent.removeListener(hd);
218 var propRe = /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate)$/;
225 * @scope Roo.EventManager
230 * This is no longer needed and is deprecated. Places a simple wrapper around an event handler to override the browser event
231 * object with a Roo.EventObject
232 * @param {Function} fn The method the event invokes
233 * @param {Object} scope An object that becomes the scope of the handler
234 * @param {boolean} override If true, the obj passed in becomes
235 * the execution scope of the listener
236 * @return {Function} The wrapped function
239 wrap : function(fn, scope, override){
241 Roo.EventObject.setEvent(e);
242 fn.call(override ? scope || window : window, Roo.EventObject, scope);
247 * Appends an event handler to an element (shorthand for addListener)
248 * @param {String/HTMLElement} element The html element or id to assign the
249 * @param {String} eventName The type of event to listen for
250 * @param {Function} handler The method the event invokes
251 * @param {Object} scope (optional) The scope in which to execute the handler
252 * function. The handler function's "this" context.
253 * @param {Object} options (optional) An object containing handler configuration
254 * properties. This may contain any of the following properties:<ul>
255 * <li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li>
256 * <li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li>
257 * <li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li>
258 * <li>preventDefault {Boolean} True to prevent the default action</li>
259 * <li>stopPropagation {Boolean} True to prevent event propagation</li>
260 * <li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li>
261 * <li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>
262 * <li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>
263 * <li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed
264 * by the specified number of milliseconds. If the event fires again within that time, the original
265 * handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>
268 * <b>Combining Options</b><br>
269 * Using the options argument, it is possible to combine different types of listeners:<br>
271 * A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style="margin: 5px 20px 20px;">
273 el.on('click', this.onClick, this, {
280 * <b>Attaching multiple handlers in 1 call</b><br>
281 * The method also allows for a single argument to be passed which is a config object containing properties
282 * which specify multiple handlers.
301 * Or a shorthand syntax:<br>
304 'click' : this.onClick,
305 'mouseover' : this.onMouseOver,
306 'mouseout' : this.onMouseOut
310 addListener : function(element, eventName, fn, scope, options){
311 if(typeof eventName == "object"){
317 if(typeof o[e] == "function"){
319 listen(element, e, o, o[e], o.scope);
321 // individual options
322 listen(element, e, o[e]);
327 return listen(element, eventName, options, fn, scope);
331 * Removes an event handler
333 * @param {String/HTMLElement} element The id or html element to remove the
335 * @param {String} eventName The type of event
336 * @param {Function} fn
337 * @return {Boolean} True if a listener was actually removed
339 removeListener : function(element, eventName, fn){
340 return stopListening(element, eventName, fn);
344 * Fires when the document is ready (before onload and before images are loaded). Can be
345 * accessed shorthanded Roo.onReady().
346 * @param {Function} fn The method the event invokes
347 * @param {Object} scope An object that becomes the scope of the handler
348 * @param {boolean} options
350 onDocumentReady : function(fn, scope, options){
351 if(docReadyState){ // if it already fired
352 docReadyEvent.addListener(fn, scope, options);
353 docReadyEvent.fire();
354 docReadyEvent.clearListeners();
360 docReadyEvent.addListener(fn, scope, options);
364 * Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and height to handlers.
365 * @param {Function} fn The method the event invokes
366 * @param {Object} scope An object that becomes the scope of the handler
367 * @param {boolean} options
369 onWindowResize : function(fn, scope, options){
371 resizeEvent = new Roo.util.Event();
372 resizeTask = new Roo.util.DelayedTask(function(){
373 resizeEvent.fire(D.getViewWidth(), D.getViewHeight());
375 E.on(window, "resize", function(){
377 resizeTask.delay(50);
379 resizeEvent.fire(D.getViewWidth(), D.getViewHeight());
383 resizeEvent.addListener(fn, scope, options);
387 * Fires when the user changes the active text size. Handler gets called with 2 params, the old size and the new size.
388 * @param {Function} fn The method the event invokes
389 * @param {Object} scope An object that becomes the scope of the handler
390 * @param {boolean} options
392 onTextResize : function(fn, scope, options){
394 textEvent = new Roo.util.Event();
395 var textEl = new Roo.Element(document.createElement('div'));
396 textEl.dom.className = 'x-text-resize';
397 textEl.dom.innerHTML = 'X';
398 textEl.appendTo(document.body);
399 textSize = textEl.dom.offsetHeight;
400 setInterval(function(){
401 if(textEl.dom.offsetHeight != textSize){
402 textEvent.fire(textSize, textSize = textEl.dom.offsetHeight);
404 }, this.textResizeInterval);
406 textEvent.addListener(fn, scope, options);
410 * Removes the passed window resize listener.
411 * @param {Function} fn The method the event invokes
412 * @param {Object} scope The scope of handler
414 removeResizeListener : function(fn, scope){
416 resizeEvent.removeListener(fn, scope);
421 fireResize : function(){
423 resizeEvent.fire(D.getViewWidth(), D.getViewHeight());
427 * Url used for onDocumentReady with using SSL (defaults to Roo.SSL_SECURE_URL)
431 * The frequency, in milliseconds, to check for text resize events (defaults to 50)
433 textResizeInterval : 50
438 * @scopeAlias pub=Roo.EventManager
442 * Appends an event handler to an element (shorthand for addListener)
443 * @param {String/HTMLElement} element The html element or id to assign the
444 * @param {String} eventName The type of event to listen for
445 * @param {Function} handler The method the event invokes
446 * @param {Object} scope (optional) The scope in which to execute the handler
447 * function. The handler function's "this" context.
448 * @param {Object} options (optional) An object containing handler configuration
449 * properties. This may contain any of the following properties:<ul>
450 * <li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li>
451 * <li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li>
452 * <li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li>
453 * <li>preventDefault {Boolean} True to prevent the default action</li>
454 * <li>stopPropagation {Boolean} True to prevent event propagation</li>
455 * <li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li>
456 * <li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>
457 * <li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>
458 * <li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed
459 * by the specified number of milliseconds. If the event fires again within that time, the original
460 * handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>
463 * <b>Combining Options</b><br>
464 * Using the options argument, it is possible to combine different types of listeners:<br>
466 * A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style="margin: 5px 20px 20px;">
468 el.on('click', this.onClick, this, {
475 * <b>Attaching multiple handlers in 1 call</b><br>
476 * The method also allows for a single argument to be passed which is a config object containing properties
477 * which specify multiple handlers.
496 * Or a shorthand syntax:<br>
499 'click' : this.onClick,
500 'mouseover' : this.onMouseOver,
501 'mouseout' : this.onMouseOut
505 pub.on = pub.addListener;
506 pub.un = pub.removeListener;
508 pub.stoppedMouseDownEvent = new Roo.util.Event();
512 * Fires when the document is ready (before onload and before images are loaded). Shorthand of {@link Roo.EventManager#onDocumentReady}.
513 * @param {Function} fn The method the event invokes
514 * @param {Object} scope An object that becomes the scope of the handler
515 * @param {boolean} override If true, the obj passed in becomes
516 * the execution scope of the listener
520 Roo.onReady = Roo.EventManager.onDocumentReady;
522 Roo.onReady(function(){
523 var bd = Roo.get(document.body);
528 : Roo.isIE11 ? "roo-ie11"
529 : Roo.isEdge ? "roo-edge"
530 : Roo.isGecko ? "roo-gecko"
531 : Roo.isOpera ? "roo-opera"
532 : Roo.isSafari ? "roo-safari" : ""];
538 cls.push("roo-linux");
544 cls.push("roo-touch");
547 cls.push('roo-border-box');
549 if(Roo.isStrict){ // add to the parent to allow for selectors like ".ext-strict .ext-ie"
550 var p = bd.dom.parentNode;
552 p.className += ' roo-strict';
555 bd.addClass(cls.join(' '));
559 * @class Roo.EventObject
560 * EventObject exposes the Yahoo! UI Event functionality directly on the object
561 * passed to your event handler. It exists mostly for convenience. It also fixes the annoying null checks automatically to cleanup your code
564 function handleClick(e){ // e is not a standard event object, it is a Roo.EventObject
566 var target = e.getTarget();
569 var myDiv = Roo.get("myDiv");
570 myDiv.on("click", handleClick);
572 Roo.EventManager.on("myDiv", 'click', handleClick);
573 Roo.EventManager.addListener("myDiv", 'click', handleClick);
577 Roo.EventObject = function(){
579 var E = Roo.lib.Event;
581 // safari keypress events for special keys return bad keycodes
587 63276 : 33, // page up
588 63277 : 34, // page down
589 63272 : 46, // delete
594 // normalize button clicks
595 var btnMap = Roo.isIE ? {1:0,4:1,2:2} :
596 (Roo.isSafari ? {1:0,2:1,3:2} : {0:0,1:1,2:2});
598 Roo.EventObjectImpl = function(e){
600 this.setEvent(e.browserEvent || e);
603 Roo.EventObjectImpl.prototype = {
605 * Used to fix doc tools.
606 * @scope Roo.EventObject.prototype
612 /** The normal browser event */
614 /** The button pressed in a mouse event */
616 /** True if the shift key was down during the event */
618 /** True if the control key was down during the event */
620 /** True if the alt key was down during the event */
679 setEvent : function(e){
680 if(e == this || (e && e.browserEvent)){ // already wrapped
683 this.browserEvent = e;
686 this.button = e.button ? btnMap[e.button] : (e.which ? e.which-1 : -1);
687 if(e.type == 'click' && this.button == -1){
691 this.shiftKey = e.shiftKey;
692 // mac metaKey behaves like ctrlKey
693 this.ctrlKey = e.ctrlKey || e.metaKey;
694 this.altKey = e.altKey;
695 // in getKey these will be normalized for the mac
696 this.keyCode = e.keyCode;
697 // keyup warnings on firefox.
698 this.charCode = (e.type == 'keyup' || e.type == 'keydown') ? 0 : e.charCode;
699 // cache the target for the delayed and or buffered events
700 this.target = E.getTarget(e);
702 this.xy = E.getXY(e);
705 this.shiftKey = false;
706 this.ctrlKey = false;
717 * Stop the event (preventDefault and stopPropagation)
719 stopEvent : function(){
720 if(this.browserEvent){
721 if(this.browserEvent.type == 'mousedown'){
722 Roo.EventManager.stoppedMouseDownEvent.fire(this);
724 E.stopEvent(this.browserEvent);
729 * Prevents the browsers default handling of the event.
731 preventDefault : function(){
732 if(this.browserEvent){
733 E.preventDefault(this.browserEvent);
738 isNavKeyPress : function(){
739 var k = this.keyCode;
740 k = Roo.isSafari ? (safariKeys[k] || k) : k;
741 return (k >= 33 && k <= 40) || k == this.RETURN || k == this.TAB || k == this.ESC;
744 isSpecialKey : function(){
745 var k = this.keyCode;
746 return (this.type == 'keypress' && this.ctrlKey) || k == 9 || k == 13 || k == 40 || k == 27 ||
747 (k == 16) || (k == 17) ||
748 (k >= 18 && k <= 20) ||
749 (k >= 33 && k <= 35) ||
750 (k >= 36 && k <= 39) ||
751 (k >= 44 && k <= 45);
754 * Cancels bubbling of the event.
756 stopPropagation : function(){
757 if(this.browserEvent){
758 if(this.type == 'mousedown'){
759 Roo.EventManager.stoppedMouseDownEvent.fire(this);
761 E.stopPropagation(this.browserEvent);
766 * Gets the key code for the event.
769 getCharCode : function(){
770 return this.charCode || this.keyCode;
774 * Returns a normalized keyCode for the event.
775 * @return {Number} The key code
778 var k = this.keyCode || this.charCode;
779 return Roo.isSafari ? (safariKeys[k] || k) : k;
783 * Gets the x coordinate of the event.
786 getPageX : function(){
791 * Gets the y coordinate of the event.
794 getPageY : function(){
799 * Gets the time of the event.
802 getTime : function(){
803 if(this.browserEvent){
804 return E.getTime(this.browserEvent);
810 * Gets the page coordinates of the event.
811 * @return {Array} The xy values like [x, y]
818 * Gets the target for the event.
819 * @param {String} selector (optional) A simple selector to filter the target or look for an ancestor of the target
820 * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to
821 search as a number or element (defaults to 10 || document.body)
822 * @param {Boolean} returnEl (optional) True to return a Roo.Element object instead of DOM node
823 * @return {HTMLelement}
825 getTarget : function(selector, maxDepth, returnEl){
826 return selector ? Roo.fly(this.target).findParent(selector, maxDepth, returnEl) : this.target;
829 * Gets the related target.
830 * @return {HTMLElement}
832 getRelatedTarget : function(){
833 if(this.browserEvent){
834 return E.getRelatedTarget(this.browserEvent);
840 * Normalizes mouse wheel delta across browsers
841 * @return {Number} The delta
843 getWheelDelta : function(){
844 var e = this.browserEvent;
846 if(e.wheelDelta){ /* IE/Opera. */
847 delta = e.wheelDelta/120;
848 }else if(e.detail){ /* Mozilla case. */
855 * Returns true if the control, meta, shift or alt key was pressed during this event.
858 hasModifier : function(){
859 return !!((this.ctrlKey || this.altKey) || this.shiftKey);
863 * Returns true if the target of this event equals el or is a child of el
864 * @param {String/HTMLElement/Element} el
865 * @param {Boolean} related (optional) true to test if the related target is within el instead of the target
868 within : function(el, related){
869 var t = this[related ? "getRelatedTarget" : "getTarget"]();
870 return t && Roo.fly(el).contains(t);
873 getPoint : function(){
874 return new Roo.lib.Point(this.xy[0], this.xy[1]);
878 return new Roo.EventObjectImpl();