@@ -2,8 +2,9 @@ The Motionbox EventHandler allows you to: * Subscribe to elements *before* they are on the DOM * Subscribe to entire classes of elements (eg. subscribe to clicks on all elements with the class ".foo") +* Use the same interface to trigger events between Objects and/or DOM elements * Limit your actual observers to a minimum (Only 1 per *type* of event) and still subscribe many elements -* Maintain a consistent interface among both custom and browser events +* Maintain a consistent interface among both custom, browser, and on Object events #Introduction @@ -19,12 +20,13 @@ The basic idea is that we listen for key interesting events at the document.body #Implementation -MBX.EventHandler listens to either element IDs, classes or single css selectors (p.my_class:first-child). +MBX.EventHandler listens to Objects, element IDs, classes or single css selectors (p.my_class:first-child). -Right now MBX.EventHandler listens to the following events: "mouseout", "click", "mouseover", "keypress", "change", "blur" +Right now MBX.EventHandler listens to the following events: "mouseout", "click", "mouseover", "keypress", "change", "blur", "dom:loaded" Any event that bubbles to document is a good candidate for the EventHandler, these are just what we have started with. +You can also fire any arbitrary event you want. -IMPORTANT NOTE: "change", "blur" do NOT bubble in IE6,7 and hence are not usable with the EventHandler in those browsers. +IMPORTANT NOTE: "change", "blur" do NOT bubble in IE6,7 and hence are not usable with the EventHandler in those browsers without some additional functions. Given: @@ -66,7 +68,7 @@ evt = {'target': $("one"), 'type': "my_custom_event_name", 'customAttribute': "t NOTE: The target that is being sent to fireCustom and that is being added to the event is an actual DOM element (not an ID or class). -##Unsubscribing +#Unsubscribing In rare cases, you may want to remove a behavior from a class or id. When subscribing to an event, MBX.EventHandler will return an object to you that you can later use to unsubscribe: @@ -77,10 +79,11 @@ In rare cases, you may want to remove a behavior from a class or id. When subsc MBX.EventHandler has the following three public functions: -subscribe(specifiers, eventTypes, functionsToCall) - specifiers = a string (or optional array of strings) specifying either a class or an id to subscribe to +subscribe(specifiers, eventTypes, functionsToCall, opts) + specifiers = an Object or String (or optional array of Strings or Objects) specifying Object, class, id, or css selector to subscribe to eventTypes = a string (or optional array of strings) specifying the name of the events to subscribe to functionsToCall = a function (or optional array of functions) to call upon receiving the event. These functions should accept an Event as their first argument. + opts = Object (optional) you can specify {defer: true} to allow these functions to be called with a setTimeout -- returns: eventHandlerObject @@ -88,6 +91,6 @@ unsubscribe(handlerObj) handlerObj = the object returned by the subscribe function fireCustom(target, eventName, opts) - target = DOM element + target = DOM element or Object eventName = the name of the event to fire (eg, "click" or "my_custom_event") opts = optional object with which to extend the event that is fired README.markdown @@ -214,7 +214,7 @@ ul.inheritsList </div> <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> 2.0.1 on Tue Jul 29 2008 20:45:35 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> 2.0.1 on Tue Jul 29 2008 22:18:36 GMT-0400 (EDT) </div> </body> </html> \ No newline at end of file docs/jsdoc/files.html @@ -221,7 +221,7 @@ ul.inheritsList </div> <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> 2.0.1 on Tue Jul 29 2008 20:45:35 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> 2.0.1 on Tue Jul 29 2008 22:18:36 GMT-0400 (EDT) </div> </body> </html> \ No newline at end of file docs/jsdoc/index.html @@ -273,7 +273,7 @@ ul.inheritsList <td class="nameDescription"> <div class="fixedFont">MBX.EventHandler.<a href="../symbols/MBX.EventHandler.html#.onDomReady">onDomReady</a>(funcs) </div> - <div class="description">these functions will be fired as soon as the dom is ready (using prototypes dom:ready event)</div> + <div class="description">Accepts functions that will be fired as soon as the dom is ready (using prototypes dom:loaded event)</div> </td> </tr> @@ -406,7 +406,7 @@ ul.inheritsList </div> <div class="description"> - these functions will be fired as soon as the dom is ready (using prototypes dom:ready event) + Accepts functions that will be fired as soon as the dom is ready (using prototypes dom:loaded event) </div> @@ -429,6 +429,13 @@ ul.inheritsList + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>a handler object that can be used to unsubscribe</dd> + + </dl> + @@ -454,7 +461,12 @@ ul.inheritsList <pre class="code"> MBX.EventHandler.subscribe(".myClass", "click", function (){ alert('hi'); }); or:</pre> - <pre class="code"> MBX.EventHandler.subscribe("p#blah.cool", "click", function(evt) {console.dir(evt);}); + <pre class="code"> MBX.EventHandler.subscribe("p#blah.cool", "click", function(evt) {console.dir(evt);});</pre> + + <pre class="code"> var someObj = {}; + // the below will use a setTimeout to fire the function when "myEvent" is fired on someObj + MBX.EventHandler.subscribe(someObj, "myEvent", function () {alert('hi'); }, {defer: true}); + events may be custom events</pre> @@ -464,10 +476,10 @@ ul.inheritsList <dt class="heading">Parameters:</dt> <dt> - {String} specifiers + {String or Object or Array} specifiers </dt> - <dd>the class, id or CSS selector that you want to subscribe to</dd> + <dd>the Object, class, id or CSS selector that you want to subscribe to (or array of any of those)</dd> <dt> {String or Array} evtTypes @@ -505,8 +517,7 @@ ul.inheritsList <dl class="detailList"> <dt class="heading">See:</dt> - <dd>MBX.EventHandler.fireCustom. - returns an object you can use to unsubscribe</dd> + <dd>MBX.EventHandler.fireCustom.</dd> </dl> @@ -538,7 +549,7 @@ ul.inheritsList <dt class="heading">Parameters:</dt> <dt> - {Object or Array} handlerObjects + {Object} handlerObjects </dt> <dd>the handler objects that were originally passed to the @@ -563,7 +574,7 @@ ul.inheritsList  <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.0.1 on Tue Jul 29 2008 20:45:35 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.0.1 on Tue Jul 29 2008 22:18:36 GMT-0400 (EDT) </div> </body> </html> docs/jsdoc/symbols/MBX.EventHandler.html @@ -291,7 +291,7 @@ ul.inheritsList  <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.0.1 on Tue Jul 29 2008 20:45:35 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.0.1 on Tue Jul 29 2008 22:18:36 GMT-0400 (EDT) </div> </body> </html> docs/jsdoc/symbols/MBX.html @@ -240,7 +240,7 @@ ul.inheritsList  <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.0.1 on Tue Jul 29 2008 20:45:35 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.0.1 on Tue Jul 29 2008 22:18:36 GMT-0400 (EDT) </div> </body> </html> docs/jsdoc/symbols/_global_.html @@ -6,7 +6,7 @@ .REGX {color: #339;} .line {border-right: 1px dotted #666; color: #666; font-style: normal;} </style></head><body><pre> 1 /** event_handler - 2 @version 1.2 + 2 @version 1.1 3 * @requires Prototype 1.6.0 4 5 * Copyright (c) 2008 Motionbox, Inc. @@ -319,227 +319,225 @@ 312 return subscriptionArray; 313 }; 314 -315 // utility functions -316 var isArray = function (obj) { -317 if (obj) { -318 return obj.constructor == Array; -319 } -320 }; -321 -322 var isId = function (specifierString) { -323 return /^\#[\w-]+$/.test(specifierString); -324 }; -325 -326 var isClass = function (specifierString) { -327 return /^\.[\w-]+$/.test(specifierString); -328 }; -329 -330 var isObject = function (specifier) { -331 return typeof specifier == "object"; +315 var isId = function (specifierString) { +316 return /^\#[\w-]+$/.test(specifierString); +317 }; +318 +319 var isClass = function (specifierString) { +320 return /^\.[\w-]+$/.test(specifierString); +321 }; +322 +323 var isObject = function (specifier) { +324 return typeof specifier == "object"; +325 }; +326 +327 var getSubscriptionMarker = function (obj) { +328 if (!obj.__MotionboxEventHandlerMaker) { +329 obj.__MotionboxEventHandlerMaker = subscriptionMarker++; +330 } +331 return obj.__MotionboxEventHandlerMaker; 332 }; 333 -334 var getSubscriptionMarker = function (obj) { -335 if (!obj.__MotionboxEventHandlerMaker) { -336 obj.__MotionboxEventHandlerMaker = subscriptionMarker++; -337 } -338 return obj.__MotionboxEventHandlerMaker; -339 }; -340 -341 var browserLikeEventExtender = { -342 preventDefault: function () {}, -343 stopPropagation: function () {}, -344 pageX: 0, -345 pageY: 0, -346 clientX: 0, -347 clientY: 0 -348 }; -349 -350 var CustomEvent = function (theTarget, evt, opts) { -351 this.type = evt; -352 this.target = theTarget; -353 this.srcElement = theTarget; -354 this.eventName = evt; -355 this.memo = {}; -356 Object.extend(this, opts); -357 for (prop in browserLikeEventExtender) { -358 if (browserLikeEventExtender.hasOwnProperty(prop)) { -359 if (!this[prop]) { -360 this[prop] = browserLikeEventExtender[prop]; -361 } -362 } -363 } -364 if (Prototype.Browser.IE) { -365 Event.extend(this); -366 } -367 }; -368 -369 if (!Prototype.Browser.IE) { -370 (function () { -371 var methods = Object.keys(Event.Methods).inject({ }, function(m, name) { -372 m[name] = Event.Methods[name].methodize(); -373 return m; -374 }); -375 -376 CustomEvent.prototype = CustomEvent.prototype || document.createEvent("HTMLEvents").__proto__; -377 Object.extend(CustomEvent.prototype, methods); -378 })(); -379 } -380 -381 if (Prototype.Browser.IE) { -382 var destroyObservers = function () { -383 stdEvents.each(function (evtType) { -384 document.stopObserving(evtType, handleEvent); -385 }); -386 }; -387 -388 window.attachEvent('onunload', destroyObservers); -389 } -390 -391 return /** @lends MBX.EventHandler */ { -392 //public functions -393 -394 /** institue the subscriber: '#' indicates an id, "." indicates a class, anything else is considered -395 a CSS Selector -396 subscribe with: -397 @example -398 MBX.EventHandler.subscribe(".myClass", "click", function (){ alert('hi'); }); -399 or: -400 @example -401 MBX.EventHandler.subscribe("p#blah.cool", "click", function(evt) {console.dir(evt);}); -402 events may be custom events -403 -404 @param {String} specifiers the class, id or CSS selector that you want to subscribe to -405 @param {String or Array} evtTypes the types of events you want to subscribe to -406 @param {Function or Array} funcs the functions you want to be called with this subscription -407 @param {Object} opts Right now only takes a "defer" option which will fire functions with setTimeout +334 var browserLikeEventExtender = { +335 preventDefault: function () {}, +336 stopPropagation: function () {}, +337 pageX: 0, +338 pageY: 0, +339 clientX: 0, +340 clientY: 0 +341 }; +342 +343 var CustomEvent = function (theTarget, evt, opts) { +344 this.type = evt; +345 this.target = theTarget; +346 this.srcElement = theTarget; +347 this.eventName = evt; +348 this.memo = {}; +349 Object.extend(this, opts); +350 for (prop in browserLikeEventExtender) { +351 if (browserLikeEventExtender.hasOwnProperty(prop)) { +352 if (!this[prop]) { +353 this[prop] = browserLikeEventExtender[prop]; +354 } +355 } +356 } +357 if (Prototype.Browser.IE) { +358 Event.extend(this); +359 } +360 }; +361 +362 if (!Prototype.Browser.IE) { +363 (function () { +364 var methods = Object.keys(Event.Methods).inject({ }, function(m, name) { +365 m[name] = Event.Methods[name].methodize(); +366 return m; +367 }); +368 +369 CustomEvent.prototype = CustomEvent.prototype || document.createEvent("HTMLEvents").__proto__; +370 Object.extend(CustomEvent.prototype, methods); +371 })(); +372 } +373 +374 if (Prototype.Browser.IE) { +375 var destroyObservers = function () { +376 stdEvents.each(function (evtType) { +377 document.stopObserving(evtType, handleEvent); +378 }); +379 }; +380 +381 window.attachEvent('onunload', destroyObservers); +382 } +383 +384 return /** @lends MBX.EventHandler */ { +385 //public functions +386 +387 /** institue the subscriber: '#' indicates an id, "." indicates a class, anything else is considered +388 a CSS Selector +389 subscribe with: +390 @example +391 MBX.EventHandler.subscribe(".myClass", "click", function (){ alert('hi'); }); +392 or: +393 @example +394 MBX.EventHandler.subscribe("p#blah.cool", "click", function(evt) {console.dir(evt);}); +395 @example +396 var someObj = {}; +397 // the below will use a setTimeout to fire the function when "myEvent" is fired on someObj +398 MBX.EventHandler.subscribe(someObj, "myEvent", function () {alert('hi'); }, {defer: true}); +399 +400 events may be custom events +401 +402 @param {String or Object or Array} specifiers the Object, class, id or CSS selector that you want to subscribe to (or array of any of those) +403 @param {String or Array} evtTypes the types of events you want to subscribe to +404 @param {Function or Array} funcs the functions you want to be called with this subscription +405 @param {Object} opts Right now only takes a "defer" option which will fire functions with setTimeout +406 +407 @returns A handler object that can be used to unsubscribe 408 -409 @returns A handler object that can be used to unsubscribe -410 -411 @see MBX.EventHandler.fireCustom. -412 returns an object you can use to unsubscribe -413 */ -414 subscribe: function (specifiers, evtTypes, funcs, opts) { -415 if (!isArray(specifiers)) { -416 specifiers = [specifiers]; +409 @see MBX.EventHandler.fireCustom. +410 */ +411 subscribe: function (specifiers, evtTypes, funcs, opts) { +412 if (!Object.isArray(specifiers)) { +413 specifiers = [specifiers]; +414 } +415 if (!Object.isArray(evtTypes)) { +416 evtTypes = [evtTypes]; 417 } -418 if (!isArray(evtTypes)) { -419 evtTypes = [evtTypes]; +418 if (!Object.isArray(funcs)) { +419 funcs = [funcs]; 420 } -421 if (!isArray(funcs)) { -422 funcs = [funcs]; -423 } -424 opts = opts || {}; -425 var referenceArray = []; -426 -427 specifiers.each(function (specifier) { -428 var specifierType; -429 if (isObject(specifier)) { -430 specifierType = "objects"; -431 specifier = getSubscriptionMarker(specifier); -432 } else { -433 if (typeof specifier != "string") { -434 throw new Error("specifier was neither an object nor a string"); -435 } -436 if (isId(specifier)) { -437 specifier = specifier.sub(/#/, ""); -438 specifierType = "ids"; -439 } -440 if (isClass(specifier)) { -441 specifierType = "classes"; -442 specifier = specifier.sub(/\./, ""); -443 } -444 } -445 -446 //check if it matched id or class -447 if (specifierType) { -448 referenceArray = referenceArray.concat(createIdClassorObjectSubscription(specifierType, specifier, evtTypes, funcs, opts)); -449 } else { -450 // we assume that anything not matching a class, id or object is a css selector rule -451 referenceArray = referenceArray.concat(createRulesSubscription(specifier, evtTypes, funcs, opts)); -452 } //end to rules handling -453 }); // each specifier -454 // return the array that can be used to unsubscribe -455 return referenceArray; -456 }, -457 -458 /** Unsubscribe a previous subscribed handler -459 @param {Object or Array} handlerObjects the handler objects that were originally passed to the -460 subscriptions -461 @example -462 var handlerObj = MBX.EventHandler.subscribe("#blah", "click", function () {alert('hi')!}); -463 MBX.EventHandler.unsubscribe(handlerObj) // the subscription above is now removed -464 */ -465 unsubscribe: function (handlerObjects) { -466 handlerObjects.each(function (handlerObject) { -467 if (!(handlerObject.specifierType && handlerObject.eventType && handlerObject.specifier) || typeof handlerObject.func != 'function') { -468 throw new Error('bad unsubscribe object passed to EventHandler.unsubscribe'); -469 } -470 if (handlerObject.specifierType != "rules") { -471 var locator = subscriptions[handlerObject.specifierType][handlerObject.specifier][handlerObject.eventType]; -472 for (var i = 0, funcLen = locator.length; i < funcLen; ++i) { -473 if (locator[i] == handlerObject.func) { -474 subscriptions[handlerObject.specifierType][handlerObject.specifier][handlerObject.eventType].splice(i, 1); -475 } -476 } -477 } else { -478 var locator = subscriptions[handlerObject.specifierType][handlerObject.eventType][handlerObject.specifier]; -479 for (var i = 0, funcLen = locator.length; i < funcLen; ++i) { -480 if (locator[i] == handlerObject.func) { -481 subscriptions[handlerObject.specifierType][handlerObject.eventType][handlerObject.specifier].splice(i, 1); -482 } -483 } -484 } -485 -486 }); +421 opts = opts || {}; +422 var referenceArray = []; +423 +424 specifiers.each(function (specifier) { +425 var specifierType; +426 if (isObject(specifier)) { +427 specifierType = "objects"; +428 specifier = getSubscriptionMarker(specifier); +429 } else { +430 if (typeof specifier != "string") { +431 throw new Error("specifier was neither an object nor a string"); +432 } +433 if (isId(specifier)) { +434 specifier = specifier.sub(/#/, ""); +435 specifierType = "ids"; +436 } +437 if (isClass(specifier)) { +438 specifierType = "classes"; +439 specifier = specifier.sub(/\./, ""); +440 } +441 } +442 +443 //check if it matched id or class +444 if (specifierType) { +445 referenceArray = referenceArray.concat(createIdClassorObjectSubscription(specifierType, specifier, evtTypes, funcs, opts)); +446 } else { +447 // we assume that anything not matching a class, id or object is a css selector rule +448 referenceArray = referenceArray.concat(createRulesSubscription(specifier, evtTypes, funcs, opts)); +449 } //end to rules handling +450 }); // each specifier +451 // return the array that can be used to unsubscribe +452 return referenceArray; +453 }, +454 +455 /** Unsubscribe a previous subscribed handler +456 @param {Object} handlerObjects the handler objects that were originally passed to the +457 subscriptions +458 @example +459 var handlerObj = MBX.EventHandler.subscribe("#blah", "click", function () {alert('hi')!}); +460 MBX.EventHandler.unsubscribe(handlerObj) // the subscription above is now removed +461 */ +462 unsubscribe: function (handlerObjects) { +463 handlerObjects.each(function (handlerObject) { +464 if (!(handlerObject.specifierType && handlerObject.eventType && handlerObject.specifier) || typeof handlerObject.func != 'function') { +465 throw new Error('bad unsubscribe object passed to EventHandler.unsubscribe'); +466 } +467 if (handlerObject.specifierType != "rules") { +468 var locator = subscriptions[handlerObject.specifierType][handlerObject.specifier][handlerObject.eventType]; +469 for (var i = 0, funcLen = locator.length; i < funcLen; ++i) { +470 if (locator[i] == handlerObject.func) { +471 subscriptions[handlerObject.specifierType][handlerObject.specifier][handlerObject.eventType].splice(i, 1); +472 } +473 } +474 } else { +475 var locator = subscriptions[handlerObject.specifierType][handlerObject.eventType][handlerObject.specifier]; +476 for (var i = 0, funcLen = locator.length; i < funcLen; ++i) { +477 if (locator[i] == handlerObject.func) { +478 subscriptions[handlerObject.specifierType][handlerObject.eventType][handlerObject.specifier].splice(i, 1); +479 } +480 } +481 } +482 +483 }); +484 +485 return true; +486 }, 487 -488 return true; -489 }, -490 -491 /** fire a custom event of your choosing. Will notify any subscribers to that evt -492 You can also attach a payload to the event that will be added to the events -493 @param {DomElement} theTarget A dom element to fire the event on -494 @param {String} evt the Event to fire -495 @param {Object} opts (optional) the attributes to be attached to the event -496 +488 /** fire a custom event of your choosing. Will notify any subscribers to that evt +489 You can also attach a payload to the event that will be added to the events +490 @param {DomElement} theTarget A dom element to fire the event on +491 @param {String} evt the Event to fire +492 @param {Object} opts (optional) the attributes to be attached to the event +493 +494 @example +495 MBX.EventHandler.fireCustom($('element'), 'mycustomeevent'); +496 497 @example -498 MBX.EventHandler.fireCustom($('element'), 'mycustomeevent'); -499 -500 @example -501 MBX.EventHandler.fireCustom($("element"), 'mycustomevent', { -502 theseAttributes: "will be attached to the event" -503 }); -504 */ -505 fireCustom: function (theTarget, evt, opts) { -506 opts = opts || {}; -507 if (Object.isElement(theTarget)) { -508 var theEvent = new CustomEvent(theTarget, evt, opts); -509 Event.extend(theEvent); -510 handleEvent(theEvent); -511 } else { -512 callFunctionsFromIdOrObject("objects", getSubscriptionMarker(theTarget), evt, opts); -513 } -514 }, -515 -516 /** these functions will be fired as soon as the dom is ready (using prototypes dom:ready event) -517 @param {Function or Array} funcs the function(s) to be fired at the Dom Ready event -518 */ -519 onDomReady: function (funcs) { -520 if (!Object.isArray(funcs)) { -521 funcs = [funcs]; -522 } -523 return MBX.EventHandler.subscribe(document, "dom:loaded", funcs); -524 }, -525 -526 //TEST FUNCTION ONLY! -527 dirSubscriptions: function () { -528 console.dir(subscriptions); -529 }, -530 dirEventListeners: function () { -531 console.dir(eventListeners); -532 }, -533 debugSubscriptions: function () { -534 return subscriptions; -535 } -536 }; -537 })(); -538 </pre></body></html> \ No newline at end of file +498 MBX.EventHandler.fireCustom($("element"), 'mycustomevent', { +499 theseAttributes: "will be attached to the event" +500 }); +501 */ +502 fireCustom: function (theTarget, evt, opts) { +503 opts = opts || {}; +504 if (Object.isElement(theTarget)) { +505 var theEvent = new CustomEvent(theTarget, evt, opts); +506 Event.extend(theEvent); +507 handleEvent(theEvent); +508 } else { +509 callFunctionsFromIdOrObject("objects", getSubscriptionMarker(theTarget), evt, opts); +510 } +511 }, +512 +513 /** Accepts functions that will be fired as soon as the dom is ready (using prototypes dom:loaded event) +514 @param {Function or Array} funcs the function(s) to be fired at the Dom Ready event +515 @returns a handler object that can be used to unsubscribe +516 */ +517 onDomReady: function (funcs) { +518 if (!Object.isArray(funcs)) { +519 funcs = [funcs]; +520 } +521 return MBX.EventHandler.subscribe(document, "dom:loaded", funcs); +522 }, +523 +524 //TEST FUNCTION ONLY! +525 dirSubscriptions: function () { +526 console.dir(subscriptions); +527 }, +528 dirEventListeners: function () { +529 console.dir(eventListeners); +530 }, +531 debugSubscriptions: function () { +532 return subscriptions; +533 } +534 }; +535 })(); +536 </pre></body></html> \ No newline at end of file docs/jsdoc/symbols/src/_Users_Topper_Sites_mbox_motionbox-eventhandler_src_event_handler.js.html @@ -312,13 +312,6 @@ MBX.EventHandler = (function () { return subscriptionArray; }; - // utility functions - var isArray = function (obj) { - if (obj) { - return obj.constructor == Array; - } - }; - var isId = function (specifierString) { return /^\#[\w-]+$/.test(specifierString); }; @@ -399,9 +392,14 @@ MBX.EventHandler = (function () { or: @example MBX.EventHandler.subscribe("p#blah.cool", "click", function(evt) {console.dir(evt);}); + @example + var someObj = {}; + // the below will use a setTimeout to fire the function when "myEvent" is fired on someObj + MBX.EventHandler.subscribe(someObj, "myEvent", function () {alert('hi'); }, {defer: true}); + events may be custom events - @param {String} specifiers the class, id or CSS selector that you want to subscribe to + @param {String or Object or Array} specifiers the Object, class, id or CSS selector that you want to subscribe to (or array of any of those) @param {String or Array} evtTypes the types of events you want to subscribe to @param {Function or Array} funcs the functions you want to be called with this subscription @param {Object} opts Right now only takes a "defer" option which will fire functions with setTimeout @@ -409,16 +407,15 @@ MBX.EventHandler = (function () { @returns A handler object that can be used to unsubscribe @see MBX.EventHandler.fireCustom. - returns an object you can use to unsubscribe */ subscribe: function (specifiers, evtTypes, funcs, opts) { - if (!isArray(specifiers)) { + if (!Object.isArray(specifiers)) { specifiers = [specifiers]; } - if (!isArray(evtTypes)) { + if (!Object.isArray(evtTypes)) { evtTypes = [evtTypes]; } - if (!isArray(funcs)) { + if (!Object.isArray(funcs)) { funcs = [funcs]; } opts = opts || {}; @@ -456,7 +453,7 @@ MBX.EventHandler = (function () { }, /** Unsubscribe a previous subscribed handler - @param {Object or Array} handlerObjects the handler objects that were originally passed to the + @param {Object} handlerObjects the handler objects that were originally passed to the subscriptions @example var handlerObj = MBX.EventHandler.subscribe("#blah", "click", function () {alert('hi')!}); @@ -513,8 +510,9 @@ MBX.EventHandler = (function () { } }, - /** these functions will be fired as soon as the dom is ready (using prototypes dom:ready event) + /** Accepts functions that will be fired as soon as the dom is ready (using prototypes dom:loaded event) @param {Function or Array} funcs the function(s) to be fired at the Dom Ready event + @returns a handler object that can be used to unsubscribe */ onDomReady: function (funcs) { if (!Object.isArray(funcs)) { src/event_handler.js 145bc1015b4d4914b2cd15283eaba530c8bda7ff topper topper@toppingdesign.com http://github.com/tobowers/motionbox-eventhandler/commit/58b95b829a641e545a26eb88a586a888391f0b1b 58b95b829a641e545a26eb88a586a888391f0b1b

2008-07-29T19:19:59-07:00

docs fe5847aa9accb2cc028af6461d6b0eec0a8bcc4f topper topper@toppingdesign.com