API Docs for: 1.0.0
Show:

Rebar.Mediator Class

Uses
Defined in: ../temp/backbone.rebar.js:610

Simple implementation of the mediator pattern for use with Backbone.Views

Constructor

Rebar.Mediator

()

Defined in ../temp/backbone.rebar.js:610

Example:

var mediator = new Mediator({
    events:{
        "appwide1":{
            dispatcher:app
            callback:"method"
        }
    },
    initialize:function(options){
        ...
    },
    method:function(e){
        ...
    },
    handle:function(eventName,module){
        ...
    }
});
mediator.addView(view,"event1 event2");
view.trigger("something",view);
mediator.removeView(view);

Methods

addView

(
  • view
  • eventNames
)

Defined in ../temp/backbone.rebar.js:684

Adds module as one that the mediator should be listening for events.

Parameters:

  • view Backbone.View
  • eventNames String

assignCallbackToDispatcher

(
  • eventName
  • callbackName
  • dispatcher
)
private

Defined in ../temp/backbone.rebar.js:847

Assigns a callback to the passed dispatcher for the event to be fired.

Parameters:

  • eventName String
  • callbackName String
  • dispatcher Object

destroy

()

Defined in ../temp/backbone.rebar.js:786

destroys a mediator and removes all listeners.

getView

(
  • attribute
)

Defined in ../temp/backbone.rebar.js:741

Returns a view that has the same value/key pairs provided

Parameters:

  • attribute Object

    Key/Value pair to use with an UnderscoreJS _.with look up

Example:

...
mediator.getView({name:"foo"});

getViewByName

(
  • name
)

Defined in ../temp/backbone.rebar.js:765

Returns a view that has the same user defined name provided

Parameters:

  • name String

    User defined view name

Example:

...
mediator.getView({name:"foo"});

handle

(
  • eventName
  • module
)

Defined in ../temp/backbone.rebar.js:799

Handler method that is called when one of the module the mediator is listening for is fired. Should be overwritten in Mediator instances.

Parameters:

  • eventName Object
  • module Object

hasView

(
  • view
)

Defined in ../temp/backbone.rebar.js:727

Returns boolean for whether the mediator contains a view or not.

Parameters:

  • view Backbone.View

initialize

()

Defined in ../temp/backbone.rebar.js:675

Called for any modules that extend the Mediator prototype.

processEvents

(
  • events
)
private

Defined in ../temp/backbone.rebar.js:811

Runs through all of the events that the mediator should be listening for.

Parameters:

  • events Object

processViewEvents

(
  • events
)
private

Defined in ../temp/backbone.rebar.js:830

Processes all of the viewEvents passes in through the mediator config options

Parameters:

  • events String

removeView

(
  • view
)

Defined in ../temp/backbone.rebar.js:708

Removes module from one that the mediator should be listening for.

Parameters:

  • view Backbone.View

Properties

_views

Array private

Defined in ../temp/backbone.rebar.js:652

Stores reference to all views added to the mediator.

view

Backbone.View

Defined in ../temp/backbone.rebar.js:664

Reference to a single view who we'll be mediating for.