API Docs for: 0.13.12
Show:

Router.class.Base Class

Defined in: src\firebrick.js:2539
Module: Firebrick.class

Methods

_addEvent

(
  • eventName
  • funct
  • scope
)
private

Defined in src\firebrick.js:2683

use .on()

Parameters:

  • eventName String

    singular or comma separated

  • funct Function
  • scope Object

_cloneListener

(
  • function
)
Function private

Defined in src\firebrick.js:2553

create a copy of the listener for each class

Parameters:

  • function Function

Returns:

Function:

fireEvent

(
  • eventName
  • args
)
Object

Defined in src\firebrick.js:2775

Fire an event on this object

Parameters:

  • eventName String

    name of the event to fire

  • args Any...

    (optional)

Returns:

Object:

eventObject

getId

() String

Defined in src\firebrick.js:2647

Returns:

String:

uniqueId

init

()

Defined in src\firebrick.js:2573

Returns:

self

off

(
  • eventName
  • callback
)
Object

Defined in src\firebrick.js:2752

remove a listener that was registered with .on()

Parameters:

  • eventName String
  • callback Function

    the function that was used when registering the event with .on()

Returns:

Object:

on

(
  • eventName
  • callback
  • scope
)
Object

Defined in src\firebrick.js:2711

register a listener to this object class, when the object fires a specific event

Parameters:

  • eventName String
  • callback Function
  • scope Object

    (optional)

Returns:

Object:

self

Example:

on("someEvent", callback)
on({
"someevent": callback,        //comma separate event names for the same callback
"someotherevent": callback1,
scope: this
})

Properties

_idPrefix

String private

Defined in src\firebrick.js:2626

autoDestroy

Boolean

Defined in src\firebrick.js:2604

controls which data will be destoryed

Default: true

classReadyEvent

String

Defined in src\firebrick.js:2598

Default: "ready"

id

String private

Defined in src\firebrick.js:2632

use Firebrick.class.Base:getId

initialConfig

Object

Defined in src\firebrick.js:2544

when calling Firebrick.create("xxx", {}); the second parameter {} (config) is stored in this property as a reference

  • in case one needs to know with what paramters the object was intialised with

Default: null

listeners

Object map

Defined in src\firebrick.js:2672

shorthand for defining class listeners so you don't have to create the init function and use this.on()

Example:

     listeners:{
            "ready": function(){},
            scope:this
        }

localEventRegistry

Object map private

Defined in src\firebrick.js:2639

event registry

mixedIn

Object private

Defined in src\firebrick.js:2617

reference for mixins that have been mixed in. works only if "mixins" is a String or array or strings

Default: : null

mixins

String | Object | String

Defined in src\firebrick.js:2611

Default: null

sName

String

Defined in src\firebrick.js:2565

use this give the class a shortname to reference Firebrick.get(sname) is also possible if this property is defined

Default: null

Events

destroy

Defined in src\firebrick.js:2661

remove class from registry