github-migration/prototype
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

prototype: Namespace all custom event names to avoid conflicts with native DOM events.

Browse Source
This commit is contained in:
Sam Stephenson 2007-10-11 06:00:45 +00:00
parent c35598ca2b
commit 115d3e456d
3 changed files with 61 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CHANGELOG
View File

@ -1,5 +1,10 @@
*SVN*
* Namespace all custom event names to avoid conflicts with native DOM events. [sam]
- All custom event names MUST include a namespace. Prefix custom event names for observe, stopObserving, and fire with the namespace followed by a colon. E.g. document.fire("widget:activated")
- The "contentloaded" event is now "dom:loaded".
- The Event.DOMEvents array is no longer present. If an event name does not include a namespace, the event is treated as a native event.
* Clean up the new class API. [sam, Tobie Langel]
- Add Class#addMethods for adding instance methods to classes.
- Remove Class.extend and Class.mixin.

10
src/event.js
View File

@ -16,12 +16,6 @@ Object.extend(Event, {
KEY_PAGEDOWN: 34,
KEY_INSERT: 45,
DOMEvents: ['click', 'dblclick', 'mousedown', 'mouseup', 'mouseover',
'mousemove', 'mouseout', 'keypress', 'keydown', 'keyup',
'load', 'unload', 'abort', 'error', 'resize', 'scroll',
'select', 'change', 'submit', 'reset', 'focus', 'blur',
'contextmenu'],
cache: { },
relatedTarget: function(event) {
@ -114,7 +108,7 @@ Object.extend(Event, (function() {
}
function getDOMEventName(eventName) {
if (!Event.DOMEvents.include(eventName)) return "dataavailable";
if (eventName && eventName.match(/:/)) return "dataavailable";
return { keypress: "keydown" }[eventName] || eventName;
}
@ -264,7 +258,7 @@ Object.extend(document, {
function fireContentLoadedEvent() {
if (fired) return;
if (timer) window.clearInterval(timer);
document.fire("contentloaded");
document.fire("dom:loaded");
fired = true;
}

108
test/unit/event.html
View File

@ -43,16 +43,16 @@
fired = true;
}
span.observe("somethingHappened", observer);
span.fire("somethingHappened", { index: 1 });
span.observe("test:somethingHappened", observer);
span.fire("test:somethingHappened", { index: 1 });
assert(fired);
fired = false;
span.fire("somethingElseHappened");
span.fire("test:somethingElseHappened");
assert(!fired);
span.stopObserving("somethingHappened", observer);
span.fire("somethingHappened");
span.stopObserving("test:somethingHappened", observer);
span.fire("test:somethingHappened");
assert(!fired);
}},
@ -63,16 +63,16 @@
fired = true;
};
outer.observe("somethingHappened", observer);
span.fire("somethingHappened");
outer.observe("test:somethingHappened", observer);
span.fire("test:somethingHappened");
assert(fired);
fired = false;
span.fire("somethingElseHappened");
span.fire("test:somethingElseHappened");
assert(!fired);
outer.stopObserving("somethingHappened", observer);
span.fire("somethingHappened");
outer.stopObserving("test:somethingHappened", observer);
span.fire("test:somethingHappened");
assert(!fired);
}},
@ -89,115 +89,115 @@
stopped = true;
}
inner.observe("somethingHappened", innerObserver);
outer.observe("somethingHappened", outerObserver);
span.fire("somethingHappened");
inner.observe("test:somethingHappened", innerObserver);
outer.observe("test:somethingHappened", outerObserver);
span.fire("test:somethingHappened");
assert(stopped);
assert(!fired);
fired = stopped = false;
inner.stopObserving("somethingHappened", innerObserver);
span.fire("somethingHappened");
inner.stopObserving("test:somethingHappened", innerObserver);
span.fire("test:somethingHappened");
assert(!stopped);
assert(fired);
outer.stopObserving("somethingHappened", outerObserver);
outer.stopObserving("test:somethingHappened", outerObserver);
}},
testEventObjectIsExtended: function() { with(this) {
var span = $("span"), event, observedEvent, observer = function(e) { observedEvent = e };
span.observe("somethingHappened", observer);
event = span.fire("somethingHappened");
span.observe("test:somethingHappened", observer);
event = span.fire("test:somethingHappened");
assertEqual(event, observedEvent);
assertEqual(Event.Methods.stop.methodize(), event.stop);
span.stopObserving("somethingHappened", observer);
span.stopObserving("test:somethingHappened", observer);
}},
testEventObserversAreBoundToTheObservedElement: function() { with(this) {
var span = $("span"), target, observer = function() { target = this };
span.observe("somethingHappened", observer);
span.fire("somethingHappened");
span.stopObserving("somethingHappened", observer);
span.observe("test:somethingHappened", observer);
span.fire("test:somethingHappened");
span.stopObserving("test:somethingHappened", observer);
assertEqual(span, target);
target = null;
var outer = $("outer");
outer.observe("somethingHappened", observer);
span.fire("somethingHappened");
outer.stopObserving("somethingHappened", observer);
outer.observe("test:somethingHappened", observer);
span.fire("test:somethingHappened");
outer.stopObserving("test:somethingHappened", observer);
assertEqual(outer, target);
}},
testMultipleCustomEventObserversWithTheSameHandler: function() { with(this) {
var span = $("span"), count = 0, observer = function() { count++ };
span.observe("somethingHappened", observer);
span.observe("somethingElseHappened", observer);
span.fire("somethingHappened");
span.observe("test:somethingHappened", observer);
span.observe("test:somethingElseHappened", observer);
span.fire("test:somethingHappened");
assertEqual(1, count);
span.fire("somethingElseHappened");
span.fire("test:somethingElseHappened");
assertEqual(2, count);
}},
testStopObservingWithoutArguments: function() { with(this) {
var span = $("span"), count = 0, observer = function() { count++ };
span.observe("somethingHappened", observer);
span.observe("somethingElseHappened", observer);
span.observe("test:somethingHappened", observer);
span.observe("test:somethingElseHappened", observer);
span.stopObserving();
span.fire("somethingHappened");
span.fire("test:somethingHappened");
assertEqual(0, count);
span.fire("somethingElseHappened");
span.fire("test:somethingElseHappened");
assertEqual(0, count);
}},
testStopObservingWithoutHandlerArgument: function() { with(this) {
var span = $("span"), count = 0, observer = function() { count++ };
span.observe("somethingHappened", observer);
span.observe("somethingElseHappened", observer);
span.stopObserving("somethingHappened");
span.fire("somethingHappened");
span.observe("test:somethingHappened", observer);
span.observe("test:somethingElseHappened", observer);
span.stopObserving("test:somethingHappened");
span.fire("test:somethingHappened");
assertEqual(0, count);
span.fire("somethingElseHappened");
span.fire("test:somethingElseHappened");
assertEqual(1, count);
span.stopObserving("somethingElseHappened");
span.fire("somethingElseHappened");
span.stopObserving("test:somethingElseHappened");
span.fire("test:somethingElseHappened");
assertEqual(1, count);
}},
testStopObservingRemovesHandlerFromCache: function() { with(this) {
var span = $("span"), observer = function() { }, eventID;
span.observe("somethingHappened", observer);
span.observe("test:somethingHappened", observer);
eventID = span._eventID;
assert(Event.cache[eventID]);
assert(Object.isArray(Event.cache[eventID].somethingHappened));
assertEqual(1, Event.cache[eventID].somethingHappened.length);
assert(Object.isArray(Event.cache[eventID]["test:somethingHappened"]));
assertEqual(1, Event.cache[eventID]["test:somethingHappened"].length);
span.stopObserving("somethingHappened", observer);
span.stopObserving("test:somethingHappened", observer);
assert(Event.cache[eventID]);
assert(Object.isArray(Event.cache[eventID].somethingHappened));
assertEqual(0, Event.cache[eventID].somethingHappened.length);
assert(Object.isArray(Event.cache[eventID]["test:somethingHappened"]));
assertEqual(0, Event.cache[eventID]["test:somethingHappened"].length);
}},
testObserveAndStopObservingAreChainable: function() { with(this) {
var span = $("span"), observer = function() { };
assertEqual(span, span.observe("somethingHappened", observer));
assertEqual(span, span.stopObserving("somethingHappened", observer));
assertEqual(span, span.observe("test:somethingHappened", observer));
assertEqual(span, span.stopObserving("test:somethingHappened", observer));
span.observe("somethingHappened", observer);
assertEqual(span, span.stopObserving("somethingHappened"));
span.observe("test:somethingHappened", observer);
assertEqual(span, span.stopObserving("test:somethingHappened"));
span.observe("somethingHappened", observer);
span.observe("test:somethingHappened", observer);
assertEqual(span, span.stopObserving());
assertEqual(span, span.stopObserving()); // assert it again, after there are no observers
span.observe("somethingHappened", observer);
assertEqual(span, span.observe("somethingHappened", observer)); // try to reuse the same observer
span.observe("test:somethingHappened", observer);
assertEqual(span, span.observe("test:somethingHappened", observer)); // try to reuse the same observer
span.stopObserving();
}},
@ -212,7 +212,7 @@
}, 'testlog');
document.observe("contentloaded", function(event) {
document.observe("dom:loaded", function(event) {
eventResults.contentLoaded = {
endOfDocument: eventResults.endOfDocument,
windowLoad: eventResults.windowLoad