API Docs for: 0.13.12
Show:

Classes Class

Defined in: src\firebrick.js:278
Module: Firebrick

Methods

_callParentConstructor

(
  • func
  • parent
)
Function private

Defined in src\firebrick.js:401

Parameters:

  • func Function
  • parent Function

Returns:

Function:

new function

_create

(
  • clazz
  • name
  • config
)
private

Defined in src\firebrick.js:503

use create()

Parameters:

  • clazz Object

    class currently being created

  • name String

    first argument of create()

  • config Object

    second argument of create()

_doMix

(
  • obj
  • mix
)
private

Defined in src\firebrick.js:594

Parameters:

  • obj Object

    core class

  • mix Object

    mixin to mix into the core class (obj}

_initMixins

(
  • clazz
  • name
)
Object private

Defined in src\firebrick.js:528

Parameters:

  • clazz Object
  • name String

    optional

Returns:

Object:

clazz

addLookups

(
  • name
  • config
)

Defined in src\firebrick.js:314

sName lookups

Parameters:

  • name Object
  • config Object
    • classname String

Returns:

self

Example:

addLookups({"button.button": {classname: "Firebrick.ui.button.Button"}});
addLookups("button.button", "Firebrick.ui.button.Button")

addSName

(
  • sName
  • clazz
)

Defined in src\firebrick.js:347

Parameters:

  • sName String
  • clazz Object

Returns:

self

create

(
  • name
  • config
)
Object | Null

Defined in src\firebrick.js:460

get or returns a firebrick class by name and calls init()

Parameters:

  • name String
  • config Object

Returns:

Object | Null:

if null then asynchronous dependency calls were made

Example:

Firebrick.create("SomeAlreadyDefinedClass"); Firebrick.create("MyNewClass", { a:1 } ); Firebrick.create({a:1}); Firebrick.create({extend:"someclass"});

define

(
  • name
  • config
  • callback
)
Object | Null

Defined in src\firebrick.js:605

define a firebrick class

Parameters:

  • name String
  • config Object

    optional

  • callback Function

    optional - needed if you wish to call actions after all dependencies have loaded

Returns:

Object | Null:

if null then asynchronous dependency calls were made

define

(
  • name
  • config
)
Object private

Defined in src\firebrick.js:636

do not call directly... call Firebrick.define()

Parameters:

  • name String
  • config Object

    optional

Returns:

Object:

the newly created class

extend

(
  • obj
  • superc
)
Object

Defined in src\firebrick.js:432

pass a simple object and a super class that you wish to extend from OOP

Parameters:

  • obj Object
  • superc Object

    object class

Returns:

Object:

prototype of superc (i.e. obj which extends from super

get

(
  • name
)
Object

Defined in src\firebrick.js:336

returns a firebrick class by name from the registry

Parameters:

  • name String

Returns:

Object:

getById

(
  • id
)
Object | Null

Defined in src\firebrick.js:358

get a class by property: classId

Parameters:

  • id String

Returns:

Object | Null:

getSNameConfig

(
  • name
)
Object | Null

Defined in src\firebrick.js:374

Parameters:

  • name String

    components unique shortname "fields.input"

Returns:

Object | Null:

hasMixin

(
  • name
)
Boolean

Defined in src\firebrick.js:584

Parameters:

  • name String

Returns:

Boolean:

mixinAdded

(
  • name
)
Object

Defined in src\firebrick.js:571

Parameters:

  • name String

Returns:

Object:

clazz

overwrite

(
  • name
  • properties
)
Object

Defined in src\firebrick.js:679

overwrite a class with new properties - uses Firebrick.utils.overwrite

Parameters:

  • name String
  • properties Object

Returns:

Object:

Overwritten

removeClass

(
  • clazz
)

Defined in src\firebrick.js:383

remove a class from the created classes registry

Parameters:

  • clazz Object | String

    clazz object or classname

Properties

_classRegistry

Object map of all classes private

Defined in src\firebrick.js:284

Class Registry

_createdClasses

Object map of all classes private

Defined in src\firebrick.js:292

_lookup

Object map private

Defined in src\firebrick.js:299

sName lookups - map with sName and path to file

_sNames

Object map private

Defined in src\firebrick.js:307