digitalsignage.com - open source docs digitalsignage.com - open source docs

  • API Docs for Version: 1.5.118

    • APIs

    Show:

    ComBroker Class

    Defined in: _controllers\ComBroker.js:1

    The ComBroker is lite weight event bus that can be used inside MV* frameworks and offer services for the application. Services provided include registration and query of data members, registration and query of instances (often registered instances are service providers themselves) and a central location for binding and triggering of events.

    Constructor

    ComBroker

    () Object

    Defined in _controllers\ComBroker.js:1

    Returns:

    Object:

    instantiated ComBroker

    Example:

    Backbone.comBroker = new ComBroker.bus();
Backbone.comBroker.setService('me',function(i_var){
                alert('I am a service ' + i_var)});
var g = com.getService('me');
g("hello again");
$(com).bind('change',function(e){
                alert('pop ' +e);
            });
$(Backbone.comBroker).triggerHandler('change');
example: Backbone.comBroker.fire(loginManager.LOGINBUTTON, this, '#loginButton', "hellow world" );
example: Backbone.comBroker.listen(loginManager.AUTHENITCATING,loginManager.LOGINBUTTON,function(e){});

    Methods

    clearServices

    ()

    Defined in _controllers\ComBroker.js:112

    Clear all current registered services

    event

    (
    • i_event
    • i_context
    • i_caller
    • i_data
    )

    Defined in _controllers\ComBroker.js:215

    The jQuery.Event constructor is exposed and can be used when calling trigger. The new operator is optional.

    Parameters:

    • i_event Event
    • i_context Object
    • i_caller Object
    • i_data Object

    Returns:

    none.

    fire

    (
    • i_event
    • i_context
    • i_caller
    • i_data
    )

    Defined in _controllers\ComBroker.js:122

    Trigger an event within the context of the CommBroker thus reducing DOM capture / bubble.

    Parameters:

    • i_event Event
    • i_context Event
    • i_caller Event
    • i_data Event

    Returns:

    none

    getAllServices

    () Object

    Defined in _controllers\ComBroker.js:103

    Expose all services and data members.

    Returns:

    Object:

    m_services

    getService

    (
    • i_name
    )
    Object

    Defined in _controllers\ComBroker.js:85

    Get a registered service.

    Parameters:

    • i_name String

    Returns:

    Object:

    m_services member

    getValue

    (
    • i_name
    )
    Object

    Defined in _controllers\ComBroker.js:54

    Get a registered data member.

    Parameters:

    • i_name String

    Returns:

    Object:

    m_services member

    initialize

    ()

    Defined in _controllers\ComBroker.js:31

    Constructor

    listen

    (
    • events
    • func
    )

    Defined in _controllers\ComBroker.js:135

    Listen to events within the context of the CommBroker thus reducing DOM capture / bubble. Once the even is triggered func will get called back.

    Parameters:

    • events Event
    • func Function

    Returns:

    none

    listenOnce

    (
    • events
    • func
    )

    Defined in _controllers\ComBroker.js:188

    Listen only once to an event and unbind. Once the event is triggered func will get called back.

    Parameters:

    • events Event
    • func Function

    Returns:

    none

    listenWithNamespace

    (
    • events
    • caller
    • call
    )

    Defined in _controllers\ComBroker.js:159

    Listen to events within the context of the CommBroker thus reducing DOM capture / bubble. However we only listen within the namespace of a unique context id so we can remove it later for a specific listener instance.

    Parameters:

    • events Event
    • caller Object
    • call Function

      back

    Returns:

    none

    setService

    (
    • i_name
    • i_service
    )

    Defined in _controllers\ComBroker.js:73

    Register a service that others can query.

    Parameters:

    • i_name String
    • i_service Object

    Returns:

    none

    setValue

    (
    • i_name
    • i_value
    • i_fireEvent
    )

    Defined in _controllers\ComBroker.js:40

    Register a data member that others can query.

    Parameters:

    • i_name String
    • i_value Object
    • i_fireEvent Event

    Returns:

    none

    stopListen

    (
    • events
    • func
    )

    Defined in _controllers\ComBroker.js:200

    Stop listening to an event.

    Parameters:

    • events Event
    • func Function

    Returns:

    none

    stopListenWithNamespace

    (
    • event
    • func
    )

    Defined in _controllers\ComBroker.js:176

    Stop listening to an event but only within the context of a specific listener instance.

    Parameters:

    • event String
    • func Function

    Returns:

    none