2 Copyright (c) 2011, Yahoo! Inc. All rights reserved.
3 Code licensed under the BSD License:
4 http://developer.yahoo.com/yui/license.html
9 * The CustomEvent class lets you define events for your application
10 * that can be subscribed to by one or more independent component.
12 * @param {String} type The type of event, which is passed to the callback
13 * when the event fires
14 * @param {Object} context The context the event will fire from. "this" will
15 * refer to this object in the callback. Default value:
16 * the window object. The listener can override this.
17 * @param {boolean} silent pass true to prevent the event from writing to
19 * @param {int} signature the signature that the custom event subscriber
20 * will receive. YAHOO.util.CustomEvent.LIST or
21 * YAHOO.util.CustomEvent.FLAT. The default is
22 * YAHOO.util.CustomEvent.LIST.
23 * @param fireOnce {boolean} If configured to fire once, the custom event
24 * will only notify subscribers a single time regardless of how many times
25 * the event is fired. In addition, new subscribers will be notified
26 * immediately if the event has already been fired.
27 * @namespace YAHOO.util
31 YAHOO.util.CustomEvent = function(type, context, silent, signature, fireOnce) {
34 * The type of event, returned to subscribers when the event fires
41 * The context the event will fire from by default. Defaults to the window obj.
45 this.scope = context || window;
48 * By default all custom events are logged in the debug build. Set silent to true
49 * to disable debug output for this event.
56 * If configured to fire once, the custom event will only notify subscribers
57 * a single time regardless of how many times the event is fired. In addition,
58 * new subscribers will be notified immediately if the event has already been
64 this.fireOnce = fireOnce;
67 * Indicates whether or not this event has ever been fired.
75 * For fireOnce events the arguments the event was fired with are stored
76 * so that new subscribers get the proper payload.
80 this.firedWith = null;
83 * Custom events support two styles of arguments provided to the event
86 * <li>YAHOO.util.CustomEvent.LIST:
88 * <li>param1: event name</li>
89 * <li>param2: array of arguments sent to fire</li>
90 * <li>param3: <optional> a custom object supplied by the subscriber</li>
93 * <li>YAHOO.util.CustomEvent.FLAT
95 * <li>param1: the first argument passed to fire. If you need to
96 * pass multiple parameters, use and array or object literal</li>
97 * <li>param2: <optional> a custom object supplied by the subscriber</li>
101 * @property signature
104 this.signature = signature || YAHOO.util.CustomEvent.LIST;
107 * The subscribers to this event
108 * @property subscribers
111 this.subscribers = [];
116 var onsubscribeType = "_YUICEOnSubscribe";
118 // Only add subscribe events for events that are not generated by
120 if (type !== onsubscribeType) {
123 * Custom events provide a custom event that fires whenever there is
124 * a new subscriber to the event. This provides an opportunity to
125 * handle the case where there is a non-repeating event that has
126 * already fired has a new subscriber.
128 * @event subscribeEvent
129 * @type YAHOO.util.CustomEvent
130 * @param fn {Function} The function to execute
131 * @param obj <Object> An object to be passed along when the event fires.
132 * Defaults to the custom event.
133 * @param override <boolean|Object> If true, the obj passed in becomes the
134 * execution context of the listener. If an object, that object becomes
135 * the execution context. Defaults to the custom event.
137 this.subscribeEvent =
138 new YAHOO.util.CustomEvent(onsubscribeType, this, true);
144 * In order to make it possible to execute the rest of the subscriber
145 * stack when one thows an exception, the subscribers exceptions are
146 * caught. The most recent exception is stored in this property
147 * @property lastError
150 this.lastError = null;
154 * Subscriber listener sigature constant. The LIST type returns three
155 * parameters: the event type, the array of args passed to fire, and
156 * the optional custom object
157 * @property YAHOO.util.CustomEvent.LIST
161 YAHOO.util.CustomEvent.LIST = 0;
164 * Subscriber listener sigature constant. The FLAT type returns two
165 * parameters: the first argument passed to fire and the optional
167 * @property YAHOO.util.CustomEvent.FLAT
171 YAHOO.util.CustomEvent.FLAT = 1;
173 YAHOO.util.CustomEvent.prototype = {
176 * Subscribes the caller to this event
178 * @param {Function} fn The function to execute
179 * @param {Object} obj An object to be passed along when the event
181 * @param {boolean|Object} overrideContext If true, the obj passed in
182 * becomes the execution.
183 * context of the listener. If an object, that object becomes the execution
186 subscribe: function(fn, obj, overrideContext) {
189 throw new Error("Invalid callback for subscriber to '" + this.type + "'");
192 if (this.subscribeEvent) {
193 this.subscribeEvent.fire(fn, obj, overrideContext);
196 var s = new YAHOO.util.Subscriber(fn, obj, overrideContext);
198 if (this.fireOnce && this.fired) {
199 this.notify(s, this.firedWith);
201 this.subscribers.push(s);
206 * Unsubscribes subscribers.
207 * @method unsubscribe
208 * @param {Function} fn The subscribed function to remove, if not supplied
209 * all will be removed
210 * @param {Object} obj The custom object passed to subscribe. This is
211 * optional, but if supplied will be used to
212 * disambiguate multiple listeners that are the same
213 * (e.g., you subscribe many object using a function
214 * that lives on the prototype)
215 * @return {boolean} True if the subscriber was found and detached.
217 unsubscribe: function(fn, obj) {
220 return this.unsubscribeAll();
224 for (var i=0, len=this.subscribers.length; i<len; ++i) {
225 var s = this.subscribers[i];
226 if (s && s.contains(fn, obj)) {
236 * Notifies the subscribers. The callback functions will be executed
237 * from the context specified when the event was created, and with the
238 * following parameters:
240 * <li>The type of event</li>
241 * <li>All of the arguments fire() was executed with as an array</li>
242 * <li>The custom object (if any) that was passed into the subscribe()
246 * @param {Object*} arguments an arbitrary set of parameters to pass to
248 * @return {boolean} false if one of the subscribers returned false,
253 this.lastError = null;
256 len=this.subscribers.length;
259 var args=[].slice.call(arguments, 0), ret=true, i, rebuild=false;
265 this.firedWith = args;
271 if (!len && this.silent) {
278 // make a copy of the subscribers so that there are
279 // no index problems if one subscriber removes another.
280 var subs = this.subscribers.slice();
282 for (i=0; i<len; ++i) {
288 ret = this.notify(s, args);
299 return (ret !== false);
302 notify: function(s, args) {
304 var ret, param=null, scope = s.getScope(this.scope),
305 throwErrors = YAHOO.util.Event.throwErrors;
310 if (this.signature == YAHOO.util.CustomEvent.FLAT) {
312 if (args.length > 0) {
317 ret = s.fn.call(scope, param, s.obj);
327 ret = s.fn.call(scope, this.type, args, s.obj);
340 * Removes all listeners
341 * @method unsubscribeAll
342 * @return {int} The number of listeners unsubscribed
344 unsubscribeAll: function() {
345 var l = this.subscribers.length, i;
346 for (i=l-1; i>-1; i--) {
359 _delete: function(index) {
360 var s = this.subscribers[index];
366 // this.subscribers[index]=null;
367 this.subscribers.splice(index, 1);
373 toString: function() {
374 return "CustomEvent: " + "'" + this.type + "', " +
375 "context: " + this.scope;
380 /////////////////////////////////////////////////////////////////////
383 * Stores the subscriber information to be used when the event fires.
384 * @param {Function} fn The function to execute
385 * @param {Object} obj An object to be passed along when the event fires
386 * @param {boolean} overrideContext If true, the obj passed in becomes the execution
387 * context of the listener
391 YAHOO.util.Subscriber = function(fn, obj, overrideContext) {
394 * The callback that will be execute when the event fires
401 * An optional custom object that will passed to the callback when
406 this.obj = YAHOO.lang.isUndefined(obj) ? null : obj;
409 * The default execution context for the event listener is defined when the
410 * event is created (usually the object which contains the event).
411 * By setting overrideContext to true, the execution context becomes the custom
412 * object passed in by the subscriber. If overrideContext is an object, that
413 * object becomes the context.
414 * @property overrideContext
415 * @type boolean|object
417 this.overrideContext = overrideContext;
422 * Returns the execution context for this listener. If overrideContext was set to true
423 * the custom obj will be the context. If overrideContext is an object, that is the
424 * context, otherwise the default context will be used.
426 * @param {Object} defaultScope the context to use if this listener does not
429 YAHOO.util.Subscriber.prototype.getScope = function(defaultScope) {
430 if (this.overrideContext) {
431 if (this.overrideContext === true) {
434 return this.overrideContext;
441 * Returns true if the fn and obj match this objects properties.
442 * Used by the unsubscribe method to match the right subscriber.
445 * @param {Function} fn the function to execute
446 * @param {Object} obj an object to be passed along when the event fires
447 * @return {boolean} true if the supplied arguments match this
448 * subscriber's signature.
450 YAHOO.util.Subscriber.prototype.contains = function(fn, obj) {
452 return (this.fn == fn && this.obj == obj);
454 return (this.fn == fn);
461 YAHOO.util.Subscriber.prototype.toString = function() {
462 return "Subscriber { obj: " + this.obj +
463 ", overrideContext: " + (this.overrideContext || "no") + " }";
467 * The Event Utility provides utilities for managing DOM Events and tools
468 * for building event systems
471 * @title Event Utility
472 * @namespace YAHOO.util
476 // The first instance of Event will win if it is loaded more than once.
477 // @TODO this needs to be changed so that only the state data that needs to
478 // be preserved is kept, while methods are overwritten/added as needed.
479 // This means that the module pattern can't be used.
480 if (!YAHOO.util.Event) {
483 * The event utility provides functions to add and remove event listeners,
484 * event cleansing. It also tries to automatically remove listeners it
485 * registers during the unload event.
490 YAHOO.util.Event = function() {
493 * True after the onload event has fired
494 * @property loadComplete
499 var loadComplete = false,
502 * Cache of wrapped listeners
503 * @property listeners
512 * User-defined unload function that will be fired before all events
514 * @property unloadListeners
519 unloadListeners = [],
522 * The number of times to poll after window.onload. This number is
523 * increased if additional late-bound handlers are requested after
525 * @property retryCount
532 * onAvailable listeners
533 * @property onAvailStack
540 * Counter for auto id generation
548 * Normalized keycodes for webkit/safari
549 * @property webkitKeymap
560 63276: 33, // page up
561 63277: 34, // page down
562 25: 9 // SHIFT-TAB (Safari provides a different key code in
563 // this case, even though the shiftKey modifier is set)
566 isIE = YAHOO.env.ua.ie,
568 // String constants used by the addFocusListener and removeFocusListener methods
571 FOCUSOUT = "focusout";
576 * The number of times we should look for elements that are not
577 * in the DOM at the time the event is requested after the document
578 * has been loaded. The default is 500@amp;40 ms, so it will poll
579 * for 20 seconds or until all outstanding handlers are bound
580 * (whichever comes first).
581 * @property POLL_RETRYS
589 * The poll interval in milliseconds
590 * @property POLL_INTERVAL
598 * Element to bind, int constant
607 * Type of event, int constant
616 * Function to execute, int constant
625 * Function wrapped for context correction and cleanup, int constant
634 * Object passed in by the user that will be returned as a
635 * parameter to the callback, int constant. Specific to
645 * Adjusted context, either the element we are registering the event
646 * on or the custom object passed in by the listener, int constant
647 * @property ADJ_SCOPE
655 * The original obj passed into addListener
664 * The original context parameter passed into addListener
673 * The original capture parameter passed into addListener
682 * addListener/removeListener can throw errors in unexpected scenarios.
683 * These errors are suppressed, the method returns false, and this property
685 * @property lastError
696 * @deprecated use YAHOO.env.ua.webkit
698 isSafari: YAHOO.env.ua.webkit,
706 * @deprecated use YAHOO.env.ua.webkit
708 webkit: YAHOO.env.ua.webkit,
715 * @deprecated use YAHOO.env.ua.ie
721 * @property _interval
728 * document readystate poll handle
737 * Map of special event types
738 * @property _specialTypes
743 focusin: (isIE ? "focusin" : "focus"),
744 focusout: (isIE ? "focusout" : "blur")
749 * True when the document is initially usable
757 * Errors thrown by subscribers of custom events are caught
758 * and the error message is written to the debug console. If
759 * this property is set to true, it will also re-throw the
761 * @property throwErrors
769 * @method startInterval
773 startInterval: function() {
774 if (!this._interval) {
776 // var callback = function() { self._tryPreloadAttach(); };
777 // this._interval = setInterval(callback, this.POLL_INTERVAL);
778 this._interval = YAHOO.lang.later(this.POLL_INTERVAL, this, this._tryPreloadAttach, null, true);
783 * Executes the supplied callback when the item with the supplied
784 * id is found. This is meant to be used to execute behavior as
785 * soon as possible as the page loads. If you use this after the
786 * initial page load it will poll for a fixed time for the element.
787 * The number of times it will poll and the frequency are
788 * configurable. By default it will poll for 10 seconds.
790 * <p>The callback is executed with a single parameter:
791 * the custom object parameter, if provided.</p>
793 * @method onAvailable
795 * @param {string||string[]} id the id of the element, or an array
796 * of ids to look for.
797 * @param {function} fn what to execute when the element is found.
798 * @param {object} obj an optional object to be passed back as
800 * @param {boolean|object} overrideContext If set to true, fn will execute
801 * in the context of obj, if set to an object it
802 * will execute in the context of that object
803 * @param checkContent {boolean} check child node readiness (onContentReady)
806 onAvailable: function(id, fn, obj, overrideContext, checkContent) {
808 var a = (YAHOO.lang.isString(id)) ? [id] : id;
810 for (var i=0; i<a.length; i=i+1) {
811 onAvailStack.push({id: a[i],
814 overrideContext: overrideContext,
815 checkReady: checkContent });
818 retryCount = this.POLL_RETRYS;
820 this.startInterval();
824 * Works the same way as onAvailable, but additionally checks the
825 * state of sibling elements to determine if the content of the
826 * available element is safe to modify.
828 * <p>The callback is executed with a single parameter:
829 * the custom object parameter, if provided.</p>
831 * @method onContentReady
833 * @param {string} id the id of the element to look for.
834 * @param {function} fn what to execute when the element is ready.
835 * @param {object} obj an optional object to be passed back as
837 * @param {boolean|object} overrideContext If set to true, fn will execute
838 * in the context of obj. If an object, fn will
839 * exectute in the context of that object
843 onContentReady: function(id, fn, obj, overrideContext) {
844 this.onAvailable(id, fn, obj, overrideContext, true);
848 * Executes the supplied callback when the DOM is first usable. This
849 * will execute immediately if called after the DOMReady event has
850 * fired. @todo the DOMContentReady event does not fire when the
851 * script is dynamically injected into the page. This means the
852 * DOMReady custom event will never fire in FireFox or Opera when the
853 * library is injected. It _will_ fire in Safari, and the IE
854 * implementation would allow for us to fire it if the defered script
855 * is not available. We want this to behave the same in all browsers.
856 * Is there a way to identify when the script has been injected
857 * instead of included inline? Is there a way to know whether the
858 * window onload event has fired without having had a listener attached
859 * to it when it did so?
861 * <p>The callback is a CustomEvent, so the signature is:</p>
862 * <p>type <string>, args <array>, customobject <object></p>
863 * <p>For DOMReady events, there are no fire argments, so the
865 * <p>"DOMReady", [], obj</p>
870 * @param {function} fn what to execute when the element is found.
871 * @param {object} obj an optional object to be passed back as
873 * @param {boolean|object} overrideContext If set to true, fn will execute
874 * in the context of obj, if set to an object it
875 * will execute in the context of that object
879 // onDOMReady: function(fn, obj, overrideContext) {
880 onDOMReady: function() {
881 this.DOMReadyEvent.subscribe.apply(this.DOMReadyEvent, arguments);
886 * Appends an event handler
888 * @method _addListener
890 * @param {String|HTMLElement|Array|NodeList} el An id, an element
891 * reference, or a collection of ids and/or elements to assign the
893 * @param {String} sType The type of event to append
894 * @param {Function} fn The method the event invokes
895 * @param {Object} obj An arbitrary object that will be
896 * passed as a parameter to the handler
897 * @param {Boolean|object} overrideContext If true, the obj passed in becomes
898 * the execution context of the listener. If an
899 * object, this object becomes the execution
901 * @param {boolen} capture capture or bubble phase
902 * @return {Boolean} True if the action was successful or defered,
903 * false if one or more of the elements
904 * could not have the listener attached,
905 * or if the operation throws an exception.
909 _addListener: function(el, sType, fn, obj, overrideContext, bCapture) {
911 if (!fn || !fn.call) {
915 // The el argument can be an array of elements or element ids.
916 if ( this._isValidCollection(el)) {
918 for (var i=0,len=el.length; i<len; ++i) {
923 overrideContext) && ok;
927 } else if (YAHOO.lang.isString(el)) {
928 var oEl = this.getEl(el);
929 // If the el argument is a string, we assume it is
930 // actually the id of the element. If the page is loaded
931 // we convert el to the actual element, otherwise we
932 // defer attaching the event until onload event fires
934 // check to see if we need to delay hooking up the event
935 // until after the page loads.
939 // defer adding the event until the element is available
940 this.onAvailable(el, function() {
941 YAHOO.util.Event._addListener(el, sType, fn, obj, overrideContext, bCapture);
948 // Element should be an html element or an array if we get
954 // we need to make sure we fire registered unload events
955 // prior to automatically unhooking them. So we hang on to
956 // these instead of attaching them to the window and fire the
957 // handles explicitly during our one unload event.
958 if ("unload" == sType && obj !== this) {
959 unloadListeners[unloadListeners.length] =
960 [el, sType, fn, obj, overrideContext];
965 // if the user chooses to override the context, we use the custom
966 // object passed in, otherwise the executing context will be the
967 // HTML element that the event is registered on
969 if (overrideContext) {
970 if (overrideContext === true) {
973 context = overrideContext;
977 // wrap the function so we can return the obj object when
979 var wrappedFn = function(e) {
980 return fn.call(context, YAHOO.util.Event.getEvent(e, el),
984 var li = [el, sType, fn, wrappedFn, context, obj, overrideContext, bCapture];
985 var index = listeners.length;
986 // cache the listener so we can try to automatically unload
987 listeners[index] = li;
990 this._simpleAdd(el, sType, wrappedFn, bCapture);
992 // handle an error trying to attach an event. If it fails
993 // we need to clean up the cache
995 this.removeListener(el, sType, fn);
1004 * Checks to see if the type requested is a special type
1005 * (as defined by the _specialTypes hash), and (if so) returns
1006 * the special type name.
1010 * @param {String} sType The type to look up
1013 _getType: function (type) {
1015 return this._specialTypes[type] || type;
1021 * Appends an event handler
1023 * @method addListener
1025 * @param {String|HTMLElement|Array|NodeList} el An id, an element
1026 * reference, or a collection of ids and/or elements to assign the
1028 * @param {String} sType The type of event to append
1029 * @param {Function} fn The method the event invokes
1030 * @param {Object} obj An arbitrary object that will be
1031 * passed as a parameter to the handler
1032 * @param {Boolean|object} overrideContext If true, the obj passed in becomes
1033 * the execution context of the listener. If an
1034 * object, this object becomes the execution
1036 * @return {Boolean} True if the action was successful or defered,
1037 * false if one or more of the elements
1038 * could not have the listener attached,
1039 * or if the operation throws an exception.
1042 addListener: function (el, sType, fn, obj, overrideContext) {
1044 var capture = ((sType == FOCUSIN || sType == FOCUSOUT) && !YAHOO.env.ua.ie) ? true : false;
1046 return this._addListener(el, this._getType(sType), fn, obj, overrideContext, capture);
1052 * Attaches a focusin event listener to the specified element for
1053 * the purpose of listening for the focus event on the element's
1055 * @method addFocusListener
1057 * @param {String|HTMLElement|Array|NodeList} el An id, an element
1058 * reference, or a collection of ids and/or elements to assign the
1060 * @param {Function} fn The method the event invokes
1061 * @param {Object} obj An arbitrary object that will be
1062 * passed as a parameter to the handler
1063 * @param {Boolean|object} overrideContext If true, the obj passed in becomes
1064 * the execution context of the listener. If an
1065 * object, this object becomes the execution
1067 * @return {Boolean} True if the action was successful or defered,
1068 * false if one or more of the elements
1069 * could not have the listener attached,
1070 * or if the operation throws an exception.
1072 * @deprecated use YAHOO.util.Event.on and specify "focusin" as the event type.
1074 addFocusListener: function (el, fn, obj, overrideContext) {
1075 return this.on(el, FOCUSIN, fn, obj, overrideContext);
1080 * Removes a focusin event listener to the specified element for
1081 * the purpose of listening for the focus event on the element's
1084 * @method removeFocusListener
1086 * @param {String|HTMLElement|Array|NodeList} el An id, an element
1087 * reference, or a collection of ids and/or elements to remove
1088 * the listener from.
1089 * @param {Function} fn the method the event invokes. If fn is
1090 * undefined, then all event handlers for the type of event are
1092 * @return {boolean} true if the unbind was successful, false
1095 * @deprecated use YAHOO.util.Event.removeListener and specify "focusin" as the event type.
1097 removeFocusListener: function (el, fn) {
1098 return this.removeListener(el, FOCUSIN, fn);
1102 * Attaches a focusout event listener to the specified element for
1103 * the purpose of listening for the blur event on the element's
1106 * @method addBlurListener
1108 * @param {String|HTMLElement|Array|NodeList} el An id, an element
1109 * reference, or a collection of ids and/or elements to assign the
1111 * @param {Function} fn The method the event invokes
1112 * @param {Object} obj An arbitrary object that will be
1113 * passed as a parameter to the handler
1114 * @param {Boolean|object} overrideContext If true, the obj passed in becomes
1115 * the execution context of the listener. If an
1116 * object, this object becomes the execution
1118 * @return {Boolean} True if the action was successful or defered,
1119 * false if one or more of the elements
1120 * could not have the listener attached,
1121 * or if the operation throws an exception.
1123 * @deprecated use YAHOO.util.Event.on and specify "focusout" as the event type.
1125 addBlurListener: function (el, fn, obj, overrideContext) {
1126 return this.on(el, FOCUSOUT, fn, obj, overrideContext);
1130 * Removes a focusout event listener to the specified element for
1131 * the purpose of listening for the blur event on the element's
1134 * @method removeBlurListener
1136 * @param {String|HTMLElement|Array|NodeList} el An id, an element
1137 * reference, or a collection of ids and/or elements to remove
1138 * the listener from.
1139 * @param {Function} fn the method the event invokes. If fn is
1140 * undefined, then all event handlers for the type of event are
1142 * @return {boolean} true if the unbind was successful, false
1145 * @deprecated use YAHOO.util.Event.removeListener and specify "focusout" as the event type.
1147 removeBlurListener: function (el, fn) {
1148 return this.removeListener(el, FOCUSOUT, fn);
1152 * Removes an event listener
1154 * @method removeListener
1156 * @param {String|HTMLElement|Array|NodeList} el An id, an element
1157 * reference, or a collection of ids and/or elements to remove
1158 * the listener from.
1159 * @param {String} sType the type of event to remove.
1160 * @param {Function} fn the method the event invokes. If fn is
1161 * undefined, then all event handlers for the type of event are
1163 * @return {boolean} true if the unbind was successful, false
1167 removeListener: function(el, sType, fn) {
1170 sType = this._getType(sType);
1172 // The el argument can be a string
1173 if (typeof el == "string") {
1174 el = this.getEl(el);
1175 // The el argument can be an array of elements or element ids.
1176 } else if ( this._isValidCollection(el)) {
1178 for (i=el.length-1; i>-1; i--) {
1179 ok = ( this.removeListener(el[i], sType, fn) && ok );
1184 if (!fn || !fn.call) {
1186 return this.purgeElement(el, false, sType);
1189 if ("unload" == sType) {
1191 for (i=unloadListeners.length-1; i>-1; i--) {
1192 li = unloadListeners[i];
1197 unloadListeners.splice(i, 1);
1198 // unloadListeners[i]=null;
1206 var cacheItem = null;
1208 // The index is a hidden parameter; needed to remove it from
1209 // the method signature because it was tempting users to
1210 // try and take advantage of it, which is not possible.
1211 var index = arguments[3];
1213 if ("undefined" === typeof index) {
1214 index = this._getCacheIndex(listeners, el, sType, fn);
1218 cacheItem = listeners[index];
1221 if (!el || !cacheItem) {
1226 var bCapture = cacheItem[this.CAPTURE] === true ? true : false;
1229 this._simpleRemove(el, sType, cacheItem[this.WFN], bCapture);
1231 this.lastError = ex;
1235 // removed the wrapped handler
1236 delete listeners[index][this.WFN];
1237 delete listeners[index][this.FN];
1238 listeners.splice(index, 1);
1239 // listeners[index]=null;
1246 * Returns the event's target element. Safari sometimes provides
1247 * a text node, and this is automatically resolved to the text
1248 * node's parent so that it behaves like other browsers.
1250 * @param {Event} ev the event
1251 * @param {boolean} resolveTextNode when set to true the target's
1252 * parent will be returned if the target is a
1253 * text node. @deprecated, the text node is
1254 * now resolved automatically
1255 * @return {HTMLElement} the event's target
1258 getTarget: function(ev, resolveTextNode) {
1259 var t = ev.target || ev.srcElement;
1260 return this.resolveTextNode(t);
1264 * In some cases, some browsers will return a text node inside
1265 * the actual element that was targeted. This normalizes the
1266 * return value for getTarget and getRelatedTarget.
1268 * If accessing a property of the node throws an error, this is
1269 * probably the anonymous div wrapper Gecko adds inside text
1270 * nodes. This likely will only occur when attempting to access
1271 * the relatedTarget. In this case, we now return null because
1272 * the anonymous div is completely useless and we do not know
1273 * what the related target was because we can't even get to
1274 * the element's parent node.
1276 * @method resolveTextNode
1277 * @param {HTMLElement} node node to resolve
1278 * @return {HTMLElement} the normized node
1281 resolveTextNode: function(n) {
1283 if (n && 3 == n.nodeType) {
1284 return n.parentNode;
1294 * Returns the event's pageX
1296 * @param {Event} ev the event
1297 * @return {int} the event's pageX
1300 getPageX: function(ev) {
1302 if (!x && 0 !== x) {
1303 x = ev.clientX || 0;
1306 x += this._getScrollLeft();
1314 * Returns the event's pageY
1316 * @param {Event} ev the event
1317 * @return {int} the event's pageY
1320 getPageY: function(ev) {
1322 if (!y && 0 !== y) {
1323 y = ev.clientY || 0;
1326 y += this._getScrollTop();
1335 * Returns the pageX and pageY properties as an indexed array.
1337 * @param {Event} ev the event
1338 * @return {[x, y]} the pageX and pageY properties of the event
1341 getXY: function(ev) {
1342 return [this.getPageX(ev), this.getPageY(ev)];
1346 * Returns the event's related target
1347 * @method getRelatedTarget
1348 * @param {Event} ev the event
1349 * @return {HTMLElement} the event's relatedTarget
1352 getRelatedTarget: function(ev) {
1353 var t = ev.relatedTarget;
1355 if (ev.type == "mouseout") {
1357 } else if (ev.type == "mouseover") {
1362 return this.resolveTextNode(t);
1366 * Returns the time of the event. If the time is not included, the
1367 * event is modified using the current time.
1369 * @param {Event} ev the event
1370 * @return {Date} the time of the event
1373 getTime: function(ev) {
1375 var t = new Date().getTime();
1379 this.lastError = ex;
1388 * Convenience method for stopPropagation + preventDefault
1390 * @param {Event} ev the event
1393 stopEvent: function(ev) {
1394 this.stopPropagation(ev);
1395 this.preventDefault(ev);
1399 * Stops event propagation
1400 * @method stopPropagation
1401 * @param {Event} ev the event
1404 stopPropagation: function(ev) {
1405 if (ev.stopPropagation) {
1406 ev.stopPropagation();
1408 ev.cancelBubble = true;
1413 * Prevents the default behavior of the event
1414 * @method preventDefault
1415 * @param {Event} ev the event
1418 preventDefault: function(ev) {
1419 if (ev.preventDefault) {
1420 ev.preventDefault();
1422 ev.returnValue = false;
1427 * Finds the event in the window object, the caller's arguments, or
1428 * in the arguments of another method in the callstack. This is
1429 * executed automatically for events registered through the event
1430 * manager, so the implementer should not normally need to execute
1431 * this function at all.
1433 * @param {Event} e the event parameter from the handler
1434 * @param {HTMLElement} boundEl the element the listener is attached to
1435 * @return {Event} the event
1438 getEvent: function(e, boundEl) {
1439 var ev = e || window.event;
1442 var c = this.getEvent.caller;
1444 ev = c.arguments[0];
1445 if (ev && Event == ev.constructor) {
1456 * Returns the charcode for an event
1457 * @method getCharCode
1458 * @param {Event} ev the event
1459 * @return {int} the event's charCode
1462 getCharCode: function(ev) {
1463 var code = ev.keyCode || ev.charCode || 0;
1465 // webkit key normalization
1466 if (YAHOO.env.ua.webkit && (code in webkitKeymap)) {
1467 code = webkitKeymap[code];
1473 * Locating the saved event handler data by function ref
1475 * @method _getCacheIndex
1479 _getCacheIndex: function(a, el, sType, fn) {
1480 for (var i=0, l=a.length; i<l; i=i+1) {
1483 li[this.FN] == fn &&
1484 li[this.EL] == el &&
1485 li[this.TYPE] == sType ) {
1494 * Generates an unique ID for the element if it does not already
1496 * @method generateId
1497 * @param el the element to create the id for
1498 * @return {string} the resulting id of the element
1501 generateId: function(el) {
1505 id = "yuievtautoid-" + counter;
1515 * We want to be able to use getElementsByTagName as a collection
1516 * to attach a group of events to. Unfortunately, different
1517 * browsers return different types of collections. This function
1518 * tests to determine if the object is array-like. It will also
1519 * fail if the object is an array, but is empty.
1520 * @method _isValidCollection
1521 * @param o the object to test
1522 * @return {boolean} true if the object is array-like and populated
1526 _isValidCollection: function(o) {
1528 return ( o && // o is something
1529 typeof o !== "string" && // o is not a string
1530 o.length && // o is indexed
1531 !o.tagName && // o is not an HTML element
1532 !o.alert && // o is not a window
1533 typeof o[0] !== "undefined" );
1545 * @deprecated Elements are not cached due to issues that arise when
1546 * elements are removed and re-added
1551 * We cache elements bound by id because when the unload event
1552 * fires, we can no longer use document.getElementById
1556 * @deprecated Elements are not cached any longer
1558 getEl: function(id) {
1559 return (typeof id === "string") ? document.getElementById(id) : id;
1563 * Clears the element cache
1564 * @deprecated Elements are not cached any longer
1565 * @method clearCache
1569 clearCache: function() { },
1572 * Custom event the fires when the dom is initially usable
1573 * @event DOMReadyEvent
1575 DOMReadyEvent: new YAHOO.util.CustomEvent("DOMReady", YAHOO, 0, 0, 1),
1578 * hook up any deferred listeners
1583 _load: function(e) {
1585 if (!loadComplete) {
1586 loadComplete = true;
1587 var EU = YAHOO.util.Event;
1589 // Just in case DOMReady did not go off for some reason
1592 // Available elements may not have been detected before the
1593 // window load event fires. Try to find them now so that the
1594 // the user is more likely to get the onAvailable notifications
1595 // before the window load notification
1596 EU._tryPreloadAttach();
1602 * Fires the DOMReady event listeners the first time the document is
1608 _ready: function(e) {
1609 var EU = YAHOO.util.Event;
1613 // Fire the content ready custom event
1614 EU.DOMReadyEvent.fire();
1616 // Remove the DOMContentLoaded (FF/Opera)
1617 EU._simpleRemove(document, "DOMContentLoaded", EU._ready);
1622 * Polling function that runs before the onload event fires,
1623 * attempting to attach to DOM Nodes as soon as they are
1625 * @method _tryPreloadAttach
1629 _tryPreloadAttach: function() {
1631 if (onAvailStack.length === 0) {
1633 if (this._interval) {
1634 // clearInterval(this._interval);
1635 this._interval.cancel();
1636 this._interval = null;
1646 // Hold off if DOMReady has not fired and check current
1647 // readyState to protect against the IE operation aborted
1649 if (!this.DOMReady) {
1650 this.startInterval();
1658 // keep trying until after the page is loaded. We need to
1659 // check the page load state prior to trying to bind the
1660 // elements so that we can be certain all elements have been
1661 // tested appropriately
1662 var tryAgain = !loadComplete;
1664 tryAgain = (retryCount > 0 && onAvailStack.length > 0);
1670 var executeItem = function (el, item) {
1672 if (item.overrideContext) {
1673 if (item.overrideContext === true) {
1676 context = item.overrideContext;
1679 item.fn.call(context, item.obj);
1682 var i, len, item, el, ready=[];
1684 // onAvailable onContentReady
1685 for (i=0, len=onAvailStack.length; i<len; i=i+1) {
1686 item = onAvailStack[i];
1688 el = this.getEl(item.id);
1690 if (item.checkReady) {
1691 if (loadComplete || el.nextSibling || !tryAgain) {
1693 onAvailStack[i] = null;
1696 executeItem(el, item);
1697 onAvailStack[i] = null;
1700 notAvail.push(item);
1705 // make sure onContentReady fires after onAvailable
1706 for (i=0, len=ready.length; i<len; i=i+1) {
1708 executeItem(this.getEl(item.id), item);
1715 for (i=onAvailStack.length-1; i>-1; i--) {
1716 item = onAvailStack[i];
1717 if (!item || !item.id) {
1718 onAvailStack.splice(i, 1);
1722 this.startInterval();
1724 if (this._interval) {
1725 // clearInterval(this._interval);
1726 this._interval.cancel();
1727 this._interval = null;
1731 this.locked = false;
1736 * Removes all listeners attached to the given element via addListener.
1737 * Optionally, the node's children can also be purged.
1738 * Optionally, you can specify a specific type of event to remove.
1739 * @method purgeElement
1740 * @param {HTMLElement} el the element to purge
1741 * @param {boolean} recurse recursively purge this element's children
1742 * as well. Use with caution.
1743 * @param {string} sType optional type of listener to purge. If
1744 * left out, all listeners will be removed
1747 purgeElement: function(el, recurse, sType) {
1748 var oEl = (YAHOO.lang.isString(el)) ? this.getEl(el) : el;
1749 var elListeners = this.getListeners(oEl, sType), i, len;
1751 for (i=elListeners.length-1; i>-1; i--) {
1752 var l = elListeners[i];
1753 this.removeListener(oEl, l.type, l.fn);
1757 if (recurse && oEl && oEl.childNodes) {
1758 for (i=0,len=oEl.childNodes.length; i<len ; ++i) {
1759 this.purgeElement(oEl.childNodes[i], recurse, sType);
1765 * Returns all listeners attached to the given element via addListener.
1766 * Optionally, you can specify a specific type of event to return.
1767 * @method getListeners
1768 * @param el {HTMLElement|string} the element or element id to inspect
1769 * @param sType {string} optional type of listener to return. If
1770 * left out, all listeners will be returned
1771 * @return {Object} the listener. Contains the following fields:
1772 * type: (string) the type of event
1773 * fn: (function) the callback supplied to addListener
1774 * obj: (object) the custom object supplied to addListener
1775 * adjust: (boolean|object) whether or not to adjust the default context
1776 * scope: (boolean) the derived context based on the adjust parameter
1777 * index: (int) its position in the Event util listener cache
1780 getListeners: function(el, sType) {
1781 var results=[], searchLists;
1783 searchLists = [listeners, unloadListeners];
1784 } else if (sType === "unload") {
1785 searchLists = [unloadListeners];
1787 sType = this._getType(sType);
1788 searchLists = [listeners];
1791 var oEl = (YAHOO.lang.isString(el)) ? this.getEl(el) : el;
1793 for (var j=0;j<searchLists.length; j=j+1) {
1794 var searchList = searchLists[j];
1796 for (var i=0,len=searchList.length; i<len ; ++i) {
1797 var l = searchList[i];
1798 if ( l && l[this.EL] === oEl &&
1799 (!sType || sType === l[this.TYPE]) ) {
1804 adjust: l[this.OVERRIDE],
1805 scope: l[this.ADJ_SCOPE],
1813 return (results.length) ? results : null;
1817 * Removes all listeners registered by pe.event. Called
1818 * automatically during the unload event.
1823 _unload: function(e) {
1825 var EU = YAHOO.util.Event, i, j, l, len, index,
1826 ul = unloadListeners.slice(), context;
1828 // execute and clear stored unload listeners
1829 for (i=0, len=unloadListeners.length; i<len; ++i) {
1834 if (l[EU.ADJ_SCOPE]) {
1835 if (l[EU.ADJ_SCOPE] === true) {
1836 context = l[EU.UNLOAD_OBJ];
1838 context = l[EU.ADJ_SCOPE];
1841 l[EU.FN].call(context, EU.getEvent(e, l[EU.EL]), l[EU.UNLOAD_OBJ] );
1849 unloadListeners = null;
1851 // Remove listeners to handle IE memory leaks
1852 // 2.5.0 listeners are removed for all browsers again. FireFox preserves
1853 // at least some listeners between page refreshes, potentially causing
1854 // errors during page load (mouseover listeners firing before they
1855 // should if the user moves the mouse at the correct moment).
1857 for (j=listeners.length-1; j>-1; j--) {
1861 EU.removeListener(l[EU.EL], l[EU.TYPE], l[EU.FN], j);
1869 EU._simpleRemove(window, "unload", EU._unload);
1870 EU._simpleRemove(window, "load", EU._load);
1876 * Returns scrollLeft
1877 * @method _getScrollLeft
1881 _getScrollLeft: function() {
1882 return this._getScroll()[1];
1887 * @method _getScrollTop
1891 _getScrollTop: function() {
1892 return this._getScroll()[0];
1896 * Returns the scrollTop and scrollLeft. Used to calculate the
1897 * pageX and pageY in Internet Explorer
1898 * @method _getScroll
1902 _getScroll: function() {
1903 var dd = document.documentElement, db = document.body;
1904 if (dd && (dd.scrollTop || dd.scrollLeft)) {
1905 return [dd.scrollTop, dd.scrollLeft];
1907 return [db.scrollTop, db.scrollLeft];
1914 * Used by old versions of CustomEvent, restored for backwards
1919 * @deprecated still here for backwards compatibility
1921 regCE: function() {},
1924 * Adds a DOM event directly without the caching, cleanup, context adj, etc
1926 * @method _simpleAdd
1927 * @param {HTMLElement} el the element to bind the handler to
1928 * @param {string} sType the type of event handler
1929 * @param {function} fn the callback to invoke
1930 * @param {boolen} capture capture or bubble phase
1934 _simpleAdd: function () {
1935 if (window.addEventListener) {
1936 return function(el, sType, fn, capture) {
1937 el.addEventListener(sType, fn, (capture));
1939 } else if (window.attachEvent) {
1940 return function(el, sType, fn, capture) {
1941 el.attachEvent("on" + sType, fn);
1944 return function(){};
1949 * Basic remove listener
1951 * @method _simpleRemove
1952 * @param {HTMLElement} el the element to bind the handler to
1953 * @param {string} sType the type of event handler
1954 * @param {function} fn the callback to invoke
1955 * @param {boolen} capture capture or bubble phase
1959 _simpleRemove: function() {
1960 if (window.removeEventListener) {
1961 return function (el, sType, fn, capture) {
1962 el.removeEventListener(sType, fn, (capture));
1964 } else if (window.detachEvent) {
1965 return function (el, sType, fn) {
1966 el.detachEvent("on" + sType, fn);
1969 return function(){};
1977 var EU = YAHOO.util.Event;
1980 * Appends an event handler. This is an alias for <code>addListener</code>
1984 * @param {String|HTMLElement|Array|NodeList} el An id, an element
1985 * reference, or a collection of ids and/or elements to assign the
1987 * @param {String} sType The type of event to append
1988 * @param {Function} fn The method the event invokes
1989 * @param {Object} obj An arbitrary object that will be
1990 * passed as a parameter to the handler
1991 * @param {Boolean|object} overrideContext If true, the obj passed in becomes
1992 * the execution context of the listener. If an
1993 * object, this object becomes the execution
1995 * @return {Boolean} True if the action was successful or defered,
1996 * false if one or more of the elements
1997 * could not have the listener attached,
1998 * or if the operation throws an exception.
2001 EU.on = EU.addListener;
2004 * YAHOO.util.Event.onFocus is an alias for addFocusListener
2006 * @see addFocusListener
2008 * @deprecated use YAHOO.util.Event.on and specify "focusin" as the event type.
2010 EU.onFocus = EU.addFocusListener;
2013 * YAHOO.util.Event.onBlur is an alias for addBlurListener
2015 * @see addBlurListener
2017 * @deprecated use YAHOO.util.Event.on and specify "focusout" as the event type.
2019 EU.onBlur = EU.addBlurListener;
2021 /*! DOMReady: based on work by: Dean Edwards/John Resig/Matthias Miller/Diego Perini */
2023 // Internet Explorer: use the readyState of a defered script.
2024 // This isolates what appears to be a safe moment to manipulate
2025 // the DOM prior to when the document's readyState suggests
2026 // it is safe to do so.
2028 if (self !== self.top) {
2029 document.onreadystatechange = function() {
2030 if (document.readyState == 'complete') {
2031 document.onreadystatechange = null;
2037 // Process onAvailable/onContentReady items when the
2039 YAHOO.util.Event.onDOMReady(
2040 YAHOO.util.Event._tryPreloadAttach,
2041 YAHOO.util.Event, true);
2043 var n = document.createElement('p');
2045 EU._dri = setInterval(function() {
2047 // throws an error if doc is not ready
2049 clearInterval(EU._dri);
2055 }, EU.POLL_INTERVAL);
2058 // The document's readyState in Safari currently will
2059 // change to loaded/complete before images are loaded.
2060 } else if (EU.webkit && EU.webkit < 525) {
2062 EU._dri = setInterval(function() {
2063 var rs=document.readyState;
2064 if ("loaded" == rs || "complete" == rs) {
2065 clearInterval(EU._dri);
2069 }, EU.POLL_INTERVAL);
2071 // FireFox and Opera: These browsers provide a event for this
2072 // moment. The latest WebKit releases now support this event.
2075 EU._simpleAdd(document, "DOMContentLoaded", EU._ready);
2078 /////////////////////////////////////////////////////////////
2081 EU._simpleAdd(window, "load", EU._load);
2082 EU._simpleAdd(window, "unload", EU._unload);
2083 EU._tryPreloadAttach();
2088 * EventProvider is designed to be used with YAHOO.augment to wrap
2089 * CustomEvents in an interface that allows events to be subscribed to
2090 * and fired by name. This makes it possible for implementing code to
2091 * subscribe to an event that either has not been created yet, or will
2092 * not be created at all.
2094 * @Class EventProvider
2096 YAHOO.util.EventProvider = function() { };
2098 YAHOO.util.EventProvider.prototype = {
2101 * Private storage of custom events
2102 * @property __yui_events
2109 * Private storage of custom event subscribers
2110 * @property __yui_subscribers
2114 __yui_subscribers: null,
2117 * Subscribe to a CustomEvent by event type
2120 * @param p_type {string} the type, or name of the event
2121 * @param p_fn {function} the function to exectute when the event fires
2122 * @param p_obj {Object} An object to be passed along when the event
2124 * @param overrideContext {boolean} If true, the obj passed in becomes the
2125 * execution scope of the listener
2127 subscribe: function(p_type, p_fn, p_obj, overrideContext) {
2129 this.__yui_events = this.__yui_events || {};
2130 var ce = this.__yui_events[p_type];
2133 ce.subscribe(p_fn, p_obj, overrideContext);
2135 this.__yui_subscribers = this.__yui_subscribers || {};
2136 var subs = this.__yui_subscribers;
2137 if (!subs[p_type]) {
2141 { fn: p_fn, obj: p_obj, overrideContext: overrideContext } );
2146 * Unsubscribes one or more listeners the from the specified event
2147 * @method unsubscribe
2148 * @param p_type {string} The type, or name of the event. If the type
2149 * is not specified, it will attempt to remove
2150 * the listener from all hosted events.
2151 * @param p_fn {Function} The subscribed function to unsubscribe, if not
2152 * supplied, all subscribers will be removed.
2153 * @param p_obj {Object} The custom object passed to subscribe. This is
2154 * optional, but if supplied will be used to
2155 * disambiguate multiple listeners that are the same
2156 * (e.g., you subscribe many object using a function
2157 * that lives on the prototype)
2158 * @return {boolean} true if the subscriber was found and detached.
2160 unsubscribe: function(p_type, p_fn, p_obj) {
2161 this.__yui_events = this.__yui_events || {};
2162 var evts = this.__yui_events;
2164 var ce = evts[p_type];
2166 return ce.unsubscribe(p_fn, p_obj);
2170 for (var i in evts) {
2171 if (YAHOO.lang.hasOwnProperty(evts, i)) {
2172 ret = ret && evts[i].unsubscribe(p_fn, p_obj);
2182 * Removes all listeners from the specified event. If the event type
2183 * is not specified, all listeners from all hosted custom events will
2185 * @method unsubscribeAll
2186 * @param p_type {string} The type, or name of the event
2188 unsubscribeAll: function(p_type) {
2189 return this.unsubscribe(p_type);
2193 * Creates a new custom event of the specified type. If a custom event
2194 * by that name already exists, it will not be re-created. In either
2195 * case the custom event is returned.
2197 * @method createEvent
2199 * @param p_type {string} the type, or name of the event
2200 * @param p_config {object} optional config params. Valid properties are:
2204 * scope: defines the default execution scope. If not defined
2205 * the default scope will be this instance.
2208 * silent: if true, the custom event will not generate log messages.
2209 * This is false by default.
2212 * fireOnce: if true, the custom event will only notify subscribers
2213 * once regardless of the number of times the event is fired. In
2214 * addition, new subscribers will be executed immediately if the
2215 * event has already fired.
2216 * This is false by default.
2219 * onSubscribeCallback: specifies a callback to execute when the
2220 * event has a new subscriber. This will fire immediately for
2221 * each queued subscriber if any exist prior to the creation of
2226 * @return {CustomEvent} the custom event
2229 createEvent: function(p_type, p_config) {
2231 this.__yui_events = this.__yui_events || {};
2232 var opts = p_config || {},
2233 events = this.__yui_events, ce;
2235 if (events[p_type]) {
2238 ce = new YAHOO.util.CustomEvent(p_type, opts.scope || this, opts.silent,
2239 YAHOO.util.CustomEvent.FLAT, opts.fireOnce);
2241 events[p_type] = ce;
2243 if (opts.onSubscribeCallback) {
2244 ce.subscribeEvent.subscribe(opts.onSubscribeCallback);
2247 this.__yui_subscribers = this.__yui_subscribers || {};
2248 var qs = this.__yui_subscribers[p_type];
2251 for (var i=0; i<qs.length; ++i) {
2252 ce.subscribe(qs[i].fn, qs[i].obj, qs[i].overrideContext);
2257 return events[p_type];
2262 * Fire a custom event by name. The callback functions will be executed
2263 * from the scope specified when the event was created, and with the
2264 * following parameters:
2266 * <li>The first argument fire() was executed with</li>
2267 * <li>The custom object (if any) that was passed into the subscribe()
2271 * @param p_type {string} the type, or name of the event
2272 * @param arguments {Object*} an arbitrary set of parameters to pass to
2274 * @return {boolean} the return value from CustomEvent.fire
2277 fireEvent: function(p_type) {
2279 this.__yui_events = this.__yui_events || {};
2280 var ce = this.__yui_events[p_type];
2287 for (var i=1; i<arguments.length; ++i) {
2288 args.push(arguments[i]);
2290 return ce.fire.apply(ce, args);
2294 * Returns true if the custom event of the provided type has been created
2297 * @param type {string} the type, or name of the event
2299 hasEvent: function(type) {
2300 if (this.__yui_events) {
2301 if (this.__yui_events[type]) {
2312 var Event = YAHOO.util.Event, Lang = YAHOO.lang;
2315 * KeyListener is a utility that provides an easy interface for listening for
2316 * keydown/keyup events fired against DOM elements.
2317 * @namespace YAHOO.util
2318 * @class KeyListener
2320 * @param {HTMLElement} attachTo The element or element ID to which the key
2321 * event should be attached
2322 * @param {String} attachTo The element or element ID to which the key
2323 * event should be attached
2324 * @param {Object} keyData The object literal representing the key(s)
2325 * to detect. Possible attributes are
2326 * shift(boolean), alt(boolean), ctrl(boolean)
2327 * and keys(either an int or an array of ints
2328 * representing keycodes).
2329 * @param {Function} handler The CustomEvent handler to fire when the
2330 * key event is detected
2331 * @param {Object} handler An object literal representing the handler.
2332 * @param {String} event Optional. The event (keydown or keyup) to
2333 * listen for. Defaults automatically to keydown.
2335 * @knownissue the "keypress" event is completely broken in Safari 2.x and below.
2336 * the workaround is use "keydown" for key listening. However, if
2337 * it is desired to prevent the default behavior of the keystroke,
2338 * that can only be done on the keypress event. This makes key
2339 * handling quite ugly.
2340 * @knownissue keydown is also broken in Safari 2.x and below for the ESC key.
2341 * There currently is no workaround other than choosing another
2342 * key to listen for.
2344 YAHOO.util.KeyListener = function(attachTo, keyData, handler, event) {
2346 } else if (!keyData) {
2347 } else if (!handler) {
2351 event = YAHOO.util.KeyListener.KEYDOWN;
2355 * The CustomEvent fired internally when a key is pressed
2358 * @param {Object} keyData The object literal representing the key(s) to
2359 * detect. Possible attributes are shift(boolean),
2360 * alt(boolean), ctrl(boolean) and keys(either an
2361 * int or an array of ints representing keycodes).
2363 var keyEvent = new YAHOO.util.CustomEvent("keyPressed");
2366 * The CustomEvent fired when the KeyListener is enabled via the enable()
2368 * @event enabledEvent
2369 * @param {Object} keyData The object literal representing the key(s) to
2370 * detect. Possible attributes are shift(boolean),
2371 * alt(boolean), ctrl(boolean) and keys(either an
2372 * int or an array of ints representing keycodes).
2374 this.enabledEvent = new YAHOO.util.CustomEvent("enabled");
2377 * The CustomEvent fired when the KeyListener is disabled via the
2378 * disable() function
2379 * @event disabledEvent
2380 * @param {Object} keyData The object literal representing the key(s) to
2381 * detect. Possible attributes are shift(boolean),
2382 * alt(boolean), ctrl(boolean) and keys(either an
2383 * int or an array of ints representing keycodes).
2385 this.disabledEvent = new YAHOO.util.CustomEvent("disabled");
2387 if (Lang.isString(attachTo)) {
2388 attachTo = document.getElementById(attachTo); // No Dom util
2391 if (Lang.isFunction(handler)) {
2392 keyEvent.subscribe(handler);
2394 keyEvent.subscribe(handler.fn, handler.scope, handler.correctScope);
2398 * Handles the key event when a key is pressed.
2399 * @method handleKeyPress
2400 * @param {DOMEvent} e The keypress DOM event
2401 * @param {Object} obj The DOM event scope object
2404 function handleKeyPress(e, obj) {
2405 if (! keyData.shift) {
2406 keyData.shift = false;
2408 if (! keyData.alt) {
2409 keyData.alt = false;
2411 if (! keyData.ctrl) {
2412 keyData.ctrl = false;
2415 // check held down modifying keys first
2416 if (e.shiftKey == keyData.shift &&
2417 e.altKey == keyData.alt &&
2418 e.ctrlKey == keyData.ctrl) { // if we pass this, all modifiers match
2420 var dataItem, keys = keyData.keys, key;
2422 if (YAHOO.lang.isArray(keys)) {
2423 for (var i=0;i<keys.length;i++) {
2425 key = Event.getCharCode(e);
2427 if (dataItem == key) {
2428 keyEvent.fire(key, e);
2433 key = Event.getCharCode(e);
2435 keyEvent.fire(key, e);
2442 * Enables the KeyListener by attaching the DOM event listeners to the
2443 * target DOM element
2446 this.enable = function() {
2447 if (! this.enabled) {
2448 Event.on(attachTo, event, handleKeyPress);
2449 this.enabledEvent.fire(keyData);
2452 * Boolean indicating the enabled/disabled state of the Tooltip
2456 this.enabled = true;
2460 * Disables the KeyListener by removing the DOM event listeners from the
2461 * target DOM element
2464 this.disable = function() {
2466 Event.removeListener(attachTo, event, handleKeyPress);
2467 this.disabledEvent.fire(keyData);
2469 this.enabled = false;
2473 * Returns a String representation of the object.
2475 * @return {String} The string representation of the KeyListener
2477 this.toString = function() {
2478 return "KeyListener [" + keyData.keys + "] " + attachTo.tagName +
2479 (attachTo.id ? "[" + attachTo.id + "]" : "");
2484 var KeyListener = YAHOO.util.KeyListener;
2487 * Constant representing the DOM "keydown" event.
2488 * @property YAHOO.util.KeyListener.KEYDOWN
2493 KeyListener.KEYDOWN = "keydown";
2496 * Constant representing the DOM "keyup" event.
2497 * @property YAHOO.util.KeyListener.KEYUP
2502 KeyListener.KEYUP = "keyup";
2505 * keycode constants for a subset of the special keys
2537 YAHOO.register("event", YAHOO.util.Event, {version: "2.9.0", build: "2800"});