Changeset 4001

Timestamp:

12/03/07 21:41:10 (9 months ago)

Author:

davidserduke

Message:

Fixed [1993] although it actually wasn't a bug in the core but rather a misunderstanding of how the extra function was supposed to work in jQuery.event.trigger(). That said, it seems more useful and robust for the code to work the way the ticket author thought it should work so this change was made.

Now, if anything is returned from the extra function it will overwrite the return value of the event handlers. This should only effect custom events unless someone had an extra function that returned a value other than false which would have been ignored before.

Location:

trunk/jquery

Files:

• src/event.js (modified) (1 diff)
• test/unit/event.js (modified) (9 diffs)

trunk/jquery/src/event.js

@@ -172 +172 @@
 
             // Handle triggering of extra function
-            if ( extra && extra.apply( element, data ) === false )
-                val = false;
+            if ( extra ) {
+                // call the extra function and tack the current return value on the end for possible inspection
+                var ret = extra.apply( element, data.concat( val ) );
+                // if anything is returned, give it precedence and have it overwrite the previous value
+                if (ret !== undefined)
+                    val = ret;
+            }
 
             // Trigger the native events (except for clicks on links)

trunk/jquery/test/unit/event.js

@@ -32 +32 @@
     // 
     // doc.body.innerHTML = "<input type='text'/>";
-    //  
+    //
     // var input = doc.getElementsByTagName("input")[0];
-    //  
+    //
     // $(input).bind("click",function() {
     //  ok( true, "Binding to element inside iframe" );
@@ -49 +49 @@
     reset();
 
-        $("#firstp").bind("click",function(e){
+    $("#firstp").bind("click",function(e){
         ok(true, "Normal click triggered");
-        });
-
-        $("#firstp").bind("click.test",function(e){
+    });
+
+    $("#firstp").bind("click.test",function(e){
         ok(true, "Namespaced click triggered");
-        });
+    });
 
     // Trigger both bound fn (2)
-        $("#firstp").trigger("click");
+    $("#firstp").trigger("click");
 
     // Trigger one bound fn (1)
-        $("#firstp").trigger("click.test");
+    $("#firstp").trigger("click.test");
 
     // Remove only the one fn
-        $("#firstp").unbind("click.test");
+    $("#firstp").unbind("click.test");
 
     // Trigger the remaining fn (1)
-        $("#firstp").trigger("click");
+    $("#firstp").trigger("click");
 });
 
@@ -73 +73 @@
     expect(4);
     $('<li><a href="#">Change location</a></li>').prependTo('#firstUL').find('a').bind('click', function() {
-        var close = $('spanx', this); // same with $(this).find('span');
-        ok( close.length == 0, "Context element does not exist, length must be zero" );
-        ok( !close[0], "Context element does not exist, direct access to element must return undefined" );
-        return false;
+        var close = $('spanx', this); // same with $(this).find('span');
+        ok( close.length == 0, "Context element does not exist, length must be zero" );
+        ok( !close[0], "Context element does not exist, direct access to element must return undefined" );
+        return false;
     }).click();
     
@@ -117 +117 @@
 
 test("trigger(event, [data], [fn])", function() {
-    expect(40);
+    expect(66);
 
     var handler = function(event, a, b, c) {
@@ -131 +131 @@
         equals( b, "2", "check passed data" );
         equals( c, "abc", "check passed data" );
-        return "test2";
+        return false;
+    };
+
+    var handler3 = function(a, b, c, v) {
+        equals( a, 1, "check passed data" );
+        equals( b, "2", "check passed data" );
+        equals( c, "abc", "check passed data" );
+        equals( v, "test", "check current value" );
+        return "newVal";
+    };
+
+    var handler4 = function(a, b, c, v) {
+        equals( a, 1, "check passed data" );
+        equals( b, "2", "check passed data" );
+        equals( c, "abc", "check passed data" );
+        equals( v, "test", "check current value" );
     };
 
@@ -144 +159 @@
 
     // Triggers handlers, native, and extra fn
-    // Triggers 8
-    $("#firstp").trigger("click", [1, "2", "abc"], handler2);
+    // Triggers 9
+    $("#firstp").trigger("click", [1, "2", "abc"], handler4);
 
     // Simulate a "native" click
@@ -152 +167 @@
     };
 
+    // Triggers handlers, native, and extra fn
+    // Triggers 7
+    $("#firstp").trigger("click", [1, "2", "abc"], handler2);
+
     // Trigger only the handlers (no native)
     // Triggers 5
@@ -158 +177 @@
     // Trigger only the handlers (no native) and extra fn
     // Triggers 8
-    equals( $("#firstp").triggerHandler("click", [1, "2", "abc"], handler2), "test", "Verify handler response" );
+    equals( $("#firstp").triggerHandler("click", [1, "2", "abc"], handler2), false, "Verify handler response" );
 
     // Build fake click event to pass in
@@ -170 +189 @@
     // Triggers 9
     equals( $("#firstp").triggerHandler("click", [eventObj, 1, "2", "abc"], handler), "test", "Verify handler response" );
+
+    // have the extra handler override the return
+    // Triggers 9
+    equals( $("#firstp").triggerHandler("click", [1, "2", "abc"], handler3), "newVal", "Verify triggerHandler return is overwritten by extra function" );
+
+    // have the extra handler leave the return value alone
+    // Triggers 9
+    equals( $("#firstp").triggerHandler("click", [1, "2", "abc"], handler4), "test", "Verify triggerHandler return is not overwritten by extra function" );
 });