Ext.ux.Sprocket

Ext.ux.Sprocket.js

/* Hierarchical PubSub for Extjs * Ext.ux.Sprocket.PubSub
 * Version: 2.0
 *
 * Copyright (c) 2008-2009 - David Davis, All Rights Reserved
 * [email protected]
 * http://xant.us/
 *
 * License: BSD
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY <copyright holder> ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Please do not remove this header
 */

Ext.namespace('Ext.ux.Sprocket');

Ext.override(Ext.util.Observable, {

    subscribe: function( eventName, fn, scope, o ) {
        Ext.ux.Sprocket.PubSub.addEvents( eventName );
        Ext.ux.Sprocket.PubSub.on( eventName, fn, scope, o);
    },

    publish: function( eventName, event ) {
        if ( Ext.ux.Sprocket.PubSub.eventsSuspended === true )
            return true;
        if ( !Ext.ux.Sprocket.PubSub.events )
            return false;
       
        // a global event listener
        var glob = Ext.ux.Sprocket.PubSub.events[ '*' ];
        if ( glob )
            if ( glob.fire.call( glob, event, eventName ) === false )
                return true;

        if ( eventName.substr( 0, 1 ) == '/' && eventName.length > 1 ) {
            var chans = eventName.substr( 1 ).split( '/' );
            var matched = false;
            for ( var i = 0, len = chans.length; i <= len; i++ ) {
                var fn = Ext.ux.Sprocket.PubSub.events[ '/' + chans.slice( 0, i ).join( '/' ).toLowerCase() ];
                if ( fn ) {
                    matched = true;
                    if ( fn.fire.call( fn, event, eventName ) === false )
                        return true;
                }
            }
            return matched;
        } else {
            var fn = Ext.ux.Sprocket.PubSub.events[ eventName.toLowerCase() ];
            if ( fn ) {
                fn.fire.call( fn, event, eventName );
                return true;
            }
        }
        return false;
    },

    removeSubscribers: function( eventName ) {
        for ( var evt in Ext.ux.Sprocket.PubSub.events ) {
            if ( ( evt == eventName ) || ( !eventName ) ) {
                var fn = Ext.ux.Sprocket.PubSub.events[ evt ];
                if ( fn )
                    Ext.ux.Sprocket.PubSub.events[ fn ].clearListeners();
            }
        }
    }

});

Ext.ux.Sprocket.PubSub = new Ext.util.Observable();


/* Example: log all events

if ( window.app ) {
    Ext.onReady(function() {
        app.subscribe( '*', function(event, channel) {
            window.console.log('event:'+channel,event);
        });
    });
}

*/