delegate.html revision cb4f4f79feb7498d1f3406b88fb62209e5f5a444
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<html>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<head>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <title>YUI Event Delegate Tests</title>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe</head>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<body class="yui3-skin-sam">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <div id="doc">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <div id="mod1">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <div id="mod-header" class="hd"><h3 class="title">H3 - Title</h3></div>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <div id="mod-body" class="bd">
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <p>simple paragraph with a link <a href="#"id="firstlink">simple link</a></p>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <p>another paragraph with a complex link <a href="#" id="secondlink"><strong>strong within link</strong><img alt="fake image" id="fakeimage" /> - complex <span id="spanwithinlink">link</span></a></p>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </div>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </div>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <div id="container">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <ul id="list-1">
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <li id="item-1"><em>Item Type One</em></li>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <li id="item-2"><em>Item Type Two</em></li>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <li id="item-3"><em>Item Type Three</em></li>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </ul>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </div>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <ul id="list-2">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <li id="list-2-li-1"><em><em>Item One</em></em></li>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <li id="list-2-li-2"><em>Item Two</em></li>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <li id="list-2-li-3"><em>Item Three</em>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <ul id="list-3">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <li id="list-3-li-1"><em>Item Three - One</em></li>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <li id="list-3-li-1"><em>Item Three - Two</em></li>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <li id="list-3-li-1"><em>Item Three - Three</em></li>
e7df7762bfed06e996cc80f583cbee2d8ed81d69Cody Peter Mello </ul>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </li>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </ul>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <div id="div-1" class="div-a">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <div id="div-1-1" class="div-b">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <div id="div-1-1-1" class="div-c"><em>Item One</em></div>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe </div>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <div id="div-1-2" class="div-x">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <em>Item Two</em>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <div id="div-1-2-1" class="div-b">
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <em>Item Two - One</em>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <div id="div-1-2-1-1" class="div-c"><em>Item Two - Two</em></div>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </div>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </div>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </div>
e7df7762bfed06e996cc80f583cbee2d8ed81d69Cody Peter Mello
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </div>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <!-- YUI3 Core //-->
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <script type="text/javascript" src="/build/yui/yui.js"></script>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <!-- Initialization process //-->
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe <script type="text/javascript">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe YUI({
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov logExclude: { Dom: true, Selector: true, Node: true, attribute: true, base: true, event: true, widget: true}
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe }).use('console', 'test', 'event', 'event-simulate', function (Y) {
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe // creating the console...
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov (new Y.Console()).render();
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov // starting the testing process
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov // add the test cases and suites
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe Y.Test.Runner.add(new Y.Test.Case({
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe name: "Event Delegate Tests",
e7df7762bfed06e996cc80f583cbee2d8ed81d69Cody Peter Mello
e7df7762bfed06e996cc80f583cbee2d8ed81d69Cody Peter Mello test_simple_delegate_for_anchors: function(){
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe var foo = false, t, ct, boundEl;
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe Y.delegate('click', function(e) {
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov foo = true;
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe t = e.target;
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov ct = e.currentTarget;
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe boundEl = e.container;
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe }, '#mod1', 'a');
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov Y.Event.simulate (document.getElementById('firstlink'), 'click');
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe Y.Assert.isTrue(foo, "simple delegation fails, mod1 should pickup the event and test target [firstlink]");
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov // Y.Assert.areEqual(t, Y.get('#firstlink'), "event delegate works but the target is an incorrect node, should be the matching node");
Y.Assert.areEqual(ct, Y.get('#firstlink'), "event delegate works but the currentTarget is an incorrect node, should be the matching node");
Y.Assert.areEqual(t, Y.get('#firstlink'), "event delegate works but the target is an incorrect node, should be the actual click target");
Y.Assert.areEqual(boundEl, Y.get('#mod1'), "event delegate works but the container property should be the bound element");
},
test_multiple_selectors: function () {
var foo = false, t, ct, boundEl;
Y.delegate('click', function(e) {
foo = true;
t = e.target;
ct = e.currentTarget;
boundEl = e.container;
}, '#mod1', '.hd,.bd');
Y.Event.simulate(document.getElementById('mod-header'), 'click');
Y.Assert.areEqual(ct, Y.get('#mod-header'), "event delegate works but the matched element is an incorrect node, should be the matching node");
Y.Event.simulate(document.getElementById('mod-body'), 'click');
Y.Assert.areEqual(ct, Y.get('#mod-body'), "event delegate works but the matched element is an incorrect node, should be the matching node");
},
test_document_as_container: function () {
var foo = false, t, ct, boundEl;
Y.delegate('click', function(e) {
foo = true;
t = e.target;
ct = e.currentTarget;
boundEl = e.container;
}, Y.get('#mod1').get('ownerDocument'), 'a');
Y.Event.simulate (document.getElementById('firstlink'), 'click');
Y.Assert.isTrue(foo, "simple delegation fails, mod1 should pickup the event and test target [firstlink]");
Y.Assert.areEqual(ct, Y.get('#firstlink'), "event delegate works but the currentTarget is an incorrect node, should be the matching node");
Y.Assert.areEqual(t, Y.get('#firstlink'), "event delegate works but the target is an incorrect node, should be the actual click target");
Y.Assert.areEqual(boundEl, Y.get('#mod1').get('ownerDocument'), "event delegate works but the container property should be the bound element");
},
test_checking_delegation_target: function(){
var foo = false, t, ct, boundEl;
Y.delegate('click', function(e) {
foo = true;
t = e.target;
ct = e.currentTarget;
boundEl = e.container;
}, '#mod1', 'a');
Y.Event.simulate (document.getElementById('fakeimage'), 'click');
Y.Assert.isTrue(foo, "delegation fails for an image within an anchor, mod1 should pickup the event and test target [secondlink]");
// in this case, the target should be the anchor, and not the image
// Y.Assert.areEqual(t, Y.get('#secondlink'), "event delegate works but the target is an incorrect node, should be the matching node");
// this has been changed. the target is unchanged, the anchor is
Y.Assert.areEqual(ct, Y.get('#secondlink'), "event delegate works but the currentTarget is an incorrect node, should be the matching node");
Y.Assert.areEqual(t, Y.get('#fakeimage'), "event delegate works but the target is an incorrect node, should be the actual click target");
Y.Assert.areEqual(boundEl, Y.get('#mod1'), "event delegate works but the container property should be the bound element");
},
test_including_container_in_selector: function(){
var foo = false, t;
Y.delegate('click', function(e) {
foo = true;
t = e.target;
}, '#mod1', '#mod1 a');
Y.Event.simulate (document.getElementById('firstlink'), 'click');
Y.Assert.isFalse(foo, "delegation fails, the container (specified in the on) can not be part of the selectors");
},
test_targeting_container_without_selectors: function(){
var foo = false, t;
Y.delegate('click', function(e) {
foo = true;
t = e.target;
}, '#mod1');
Y.Event.simulate (document.getElementById('firstlink'), 'click');
Y.Assert.isFalse(foo, "delegation fails, delegation without at least one selector should never trigger an event");
},
test_multiple_selectors_one_match: function(){
var foo = false, t;
Y.delegate('click', function(e) {
foo = true;
t = e.target;
}, '#mod1', 'a,a span');
Y.Event.simulate (document.getElementById('firstlink'), 'click');
Y.Assert.isTrue(foo, "multiple selectors fails, delegate should be able to match different selectors");
Y.Assert.areEqual(t, Y.get('#firstlink'), "event delegate works but the target is an incorrect node, should be the matching selector");
},
test_multiple_delegate_matches: function(){
var foo1 = false, foo2 = false, t1, t2, ct1, ct2;
Y.delegate('click', function(e) {
foo1 = true;
t1 = e.target;
ct1 = e.currentTarget;
}, '#mod1', 'a');
Y.delegate('click', function(e) {
foo2 = true;
t2 = e.target;
ct2 = e.currentTarget;
}, '#mod1', 'a span');
Y.Event.simulate (document.getElementById('spanwithinlink'), 'click');
Y.Assert.isTrue(foo1, "first match fail, delegate should be able to match [a]");
Y.Assert.isTrue(foo2, "second match fail, delegate should be able to match [a span]");
Y.Assert.areEqual(ct1, Y.get('#secondlink'), "event delegate works but the currentTarget is an incorrect node, should be the matching selector");
Y.Assert.areEqual(t1, Y.get('#spanwithinlink'), "event delegate works but the target is an incorrect node, should be the clicked node");
Y.Assert.areEqual(ct2, Y.get('#spanwithinlink'), "event delegate works but the target is an incorrect node, should be the matching selector");
Y.Assert.areEqual(t2, Y.get('#spanwithinlink'), "event delegate works but the target is an incorrect node, should be the clicked");
},
test_bubble_up_after_delegate: function(){
var foo1 = false, foo2 = false, t1, t2, ct;
Y.delegate('click', function(e) {
foo1 = true;
t1 = e.target;
ct = e.currentTarget;
}, '#mod1', 'a');
Y.on('click', function(e) {
foo2 = true;
t2 = e.target;
}, '#doc');
Y.Event.simulate (document.getElementById('spanwithinlink'), 'click');
Y.Assert.isTrue(foo1, "first match fail, delegate should be able to match [a]");
Y.Assert.isTrue(foo2, "second match fail, the event doesn't bubble up after the delegate routine");
// changed
// Y.Assert.areEqual(t1, Y.get('#secondlink'), "event delegate works but the target is an incorrect node, should be the matching selector");
Y.Assert.areEqual(ct, Y.get('#secondlink'), "event delegate works but the currentTarget is an incorrect node, should be the matching selector");
Y.Assert.areEqual(t1, Y.get('#spanwithinlink'), "event delegate works but the target is an incorrect node, should be the actual target");
// obsolete
Y.Assert.areEqual(t2, Y.get('#spanwithinlink'), "event delegate works but it doesn't restore e.target to the original value.");
},
test_bubble_up_after_delegate_halt: function(){
var foo1 = false, foo2 = false;
Y.delegate('click', function(e) {
foo1 = true;
e.halt();
}, '#mod1', 'a');
Y.on('click', function(e) {
foo2 = true;
}, '#doc');
Y.Event.simulate (document.getElementById('spanwithinlink'), 'click');
Y.Assert.isTrue(foo1, "first match fail, delegate should be able to match [a]");
Y.Assert.isFalse(foo2, "the listener for 'doc' got executed, which means that e.halt fails during the delegate routine");
},
test_direct_descendant_combinator: function () {
var matchID = null;
Y.one("#list-2").delegate("click", function (e) {
matchID = this.get("id");
}, ">li");
Y.Event.simulate(document.getElementById('list-3-li-1'), 'click');
Y.Assert.areEqual('list-2-li-3', matchID, "The currentTarget is an incorrect node, should be the matching node.");
matchID = null;
Y.one("#div-1").delegate("click", function (e) {
matchID = this.get("id");
}, ">.div-b");
Y.Event.simulate(document.getElementById('div-1-1-1'), 'click');
Y.Assert.areEqual('div-1-1', matchID, "The currentTarget is an incorrect node, should be the matching node.");
matchID = null;
Y.Event.simulate(document.getElementById('div-1-2-1'), 'click');
Y.Assert.isNull(matchID, "The currentTarget is an incorrect node, should be the matching node.");
},
test_successful_purge: function () {
var bHandler1Called = false,
bHandler2Called = false;
Y.delegate('click', function(e) {
bHandler1Called = true;
}, '#mod1', 'a');
Y.Event.purgeElement('#mod1');
// Test #1: Make sure first handler is not called after
// calling Y.Event.purgeElement
Y.Event.simulate (document.getElementById('firstlink'), 'click');
Y.Assert.isFalse(bHandler1Called, "No delegated listeners should be called after a call to Y.Event.purgeElement");
// Test #2: Make sure second handler is called after
// calling Y.Event.purgeElement
Y.delegate('click', function(e) {
bHandler2Called = true;
}, '#mod1', 'a');
Y.Event.simulate(document.getElementById('firstlink'), 'click');
Y.Assert.isFalse(bHandler1Called, "The first listener should not be be called.");
Y.Assert.isTrue(bHandler2Called, "The second delegated listener should be called.");
bHandler1Called = false;
bHandler2Called = false;
// Test #3: Make sure first handler is not called after
// calling Y.Event.purgeElement and passing in a type
Y.Event.purgeElement('#mod1', false, 'click');
Y.Event.simulate(document.getElementById('firstlink'), 'click');
Y.Assert.isFalse(bHandler2Called, "The second listener should not be be called.");
// Test #4: Make sure that it is possible to delegate
// a listener to a new element with the same id of
// an element that used to exist in the DOM.
bHandler1Called = false;
bHandler2Called = false;
Y.delegate("click", function () {
bHandler1Called = true;
}, "#list-1", ">li");
Y.Event.purgeElement('#list-1');
Y.one("#container").setContent('<ul id="list-1"><li id="item-1"><em>Item Type One</em></li><li id="item-2"><em>Item Type Two</em></li><li id="item-3"><em>Item Type Three</em></li></ul>');
Y.delegate("click", function () {
bHandler2Called = true;
}, "#list-1", ">li");
Y.Event.simulate(document.getElementById('item-1'), 'click');
Y.Assert.isFalse(bHandler1Called, "The first listener should not be be called.");
Y.Assert.isTrue(bHandler2Called, "The second delegated listener should be called.");
},
test_successful_detach: function () {
var bHandler1Called = false,
bHandler2Called = false;
var handle = Y.delegate('click', function(e) {
bHandler1Called = true;
}, '#mod1', 'a');
handle.detach();
// Test #1: Make sure first handler is not called after
// being detached
Y.Event.simulate (document.getElementById('firstlink'), 'click');
Y.Assert.isFalse(bHandler1Called, "Listener should not be called after being detached.");
// Test #2: Make sure second handler is called after
// detaching the first.
Y.delegate('click', function(e) {
bHandler2Called = true;
}, '#mod1', 'a');
Y.Event.simulate(document.getElementById('firstlink'), 'click');
Y.Assert.isFalse(bHandler1Called, "The first listener should not be be called.");
Y.Assert.isTrue(bHandler2Called, "The second delegated listener should be called.");
// Test #3: Make sure that it is possible to delegate
// a listener to a new element with the same id of
// an element that used to exist in the DOM.
bHandler1Called = false;
bHandler2Called = false;
handle = Y.delegate("click", function () {
bHandler1Called = true;
}, "#list-1", ">li");
handle.detach();
Y.one("#container").setContent('<ul id="list-1"><li id="item-1"><em>Item Type One</em></li><li id="item-2"><em>Item Type Two</em></li><li id="item-3"><em>Item Type Three</em></li></ul>');
Y.delegate("click", function () {
bHandler2Called = true;
}, "#list-1", ">li");
Y.Event.simulate(document.getElementById('item-1'), 'click');
Y.Assert.isFalse(bHandler1Called, "The first listener should not be be called.");
Y.Assert.isTrue(bHandler2Called, "The second delegated listener should be called.");
}
/*
* Other things that I consider should be tested in the future:
* - stopping the event, verifying the event ourside of the container
* - stopping the event and verify what happen with multiple matches
*/
}));
//run all tests
Y.Test.Runner.run();
/* finishing the testing process */
});
</script>
</body>
</html>