Ticket #6723: connect.patch

_base/connect.js

@@ -100 +100 @@
         //              If obj[event] is null, it is assigned a function.
         //
         //              The return value is a handle that is needed to 
-        //              remove this connection with dojo.disconnect.
+        //              remove this connection with dojo.disconnect.  The handle
+        //              also contains methods for suspending and resuming the 
+        //              connection.
         //
         // obj: 
         //              The source object for the event function. 
@@ -144 +146 @@
         //      |       dojo.disconnect(link);
         //
         // example:
+        //              Using return value to suspend and resume the connection:
+        //      |       var link = dojo.connect(obj, "onchange", ui, "update");
+        //      |       ...
+        //      |       link.suspend();
+        //      |       ...
+        //      |       link.resume();
+        //      |       ...
+        //      |       dojo.disconnect(link);
+        //
+        // example:
         //              When onglobalevent executes, watcher.handler is invoked:
         //      |       dojo.connect(null, "onglobalevent", watcher, "handler");
         //
@@ -174 +186 @@
         // absorb any additional arguments
         for(var l=a.length; i<l; i++){  args.push(a[i]); }
         // do the actual work
-        return dojo._connect.apply(this, args); /*Handle*/
+        return dojo.mixin(dojo._connect.apply(this, args), dojo._connectFns, { _args: args }); /*Handle*/
 }
 
+dojo._connectFns = {
+        suspend: function() {
+                dojo._disconnect.apply(dojo, this);
+        },
+        resume: function() {
+                dojo.mixin(this, dojo._connect.apply(dojo, this._args));
+        }
+}
+
 // used by non-browser hostenvs. always overriden by event.js
 dojo._connect = function(obj, event, context, method){
         var l=dojo._listener, h=l.add(obj, event, dojo.hitch(context, method)); 

tests/_base/connect.js

@@ -133 +133 @@
                         obj.baz();
                         t.is('baz', out);
                 },
+                function suspendResumeTest(t){
+                        var out = '';
+                        var obj = {
+                                foo: function() {
+                                        out += 'foo';
+                                },
+                                bar: function() {
+                                        out += 'bar';
+                                },
+                                baz: function() {
+                                        out += 'baz';
+                                }
+                        };
+                        //      initial test.
+                        var foobar = dojo.connect(obj, "foo", obj, "bar");
+                        dojo.connect(obj, "bar", obj, "baz");
+                        //
+                        out = '';
+                        obj.foo();
+                        t.is('foobarbaz', out);
+                        //
+                        out = '';
+                        obj.bar();
+                        t.is('barbaz', out);
+                        //
+                        out = '';
+                        obj.baz();
+                        t.is('baz', out);
+                        
+                        // connect foo and baz, suspend foobar
+                        var foobaz = dojo.connect(obj, "foo", obj, "baz");
+                        foobar.suspend();
+                        //
+                        out = '';
+                        obj.foo();
+                        t.is('foobaz', out);
+                        //
+                        out = '';
+                        obj.bar();
+                        t.is('barbaz', out);
+                        //
+                        out = '';
+                        obj.baz();
+                        t.is('baz', out);
+
+                        //      suspend foobaz, resume foobar
+                        foobaz.suspend();
+                        foobar.resume();
+                        out = '';
+                        obj.foo();
+                        t.is('foobarbaz', out);
+                        //
+                        out = '';
+                        obj.bar();
+                        t.is('barbaz', out);
+                        //
+                        out = '';
+                        obj.baz();
+                        t.is('baz', out);
+
+                        //      resume foobaz, disconnect foobar
+                        foobaz.resume();
+                        dojo.disconnect(foobar);
+                        
+                        out='';
+                        obj.foo();
+                        t.is('foobaz', out);
+
+                        out='';
+                        obj.bar();
+                        t.is('barbaz', out);
+
+                        out='';
+                        obj.baz();
+                        t.is('baz', out);
+                },
                 function hubConnectDisconnect1000(t){
                         t.is(0, markAndSweepTest(1000));
                 },