API Docs for: 0.13.12
Show:

Views Class

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

Methods

_basicViewConfigurations

(
  • config
)
Object private

Defined in src\firebrick.js:845

Basic view configurations when defining/creating a view with shorthand function calls

Parameters:

  • config Object

    (optional)

Returns:

Object:

_loadSubView

(
  • subView
)
Object private

Defined in src\firebrick.js:819

used by initSubViews

Parameters:

  • subView Object

Returns:

Object:

subView passed

bootView

(
  • options
)
private

Defined in src\firebrick.js:730

used by Firebrick.Boot:prepApplication to render the "view/Index.html" when autoRender is true

Parameters:

  • options Object
    • viewData Object

      to pass to the view Store parameter

createView

(
  • name
  • config
)
Object

Defined in src\firebrick.js:752

Create and render a view (shorthand function)

Parameters:

  • name String

    example: "MyApp.view.MyView"

  • config Object

    (optional) object to config the View class with

Returns:

Object:

Firebrick.view.Base class

Example:

createView({...})
createView("MyApp.view.MyView")
createView("MyApp.view.MyView", {...})

defineView

(
  • name
  • config
)
Object

Defined in src\firebrick.js:784

Note: different to Firebrick.define() for classes - Firebrick.defineView, defines and fetches if not already loaded the given view by name

Parameters:

  • name String

    name of the view to me shown "MyApp.view.MyView"

  • config Object

    (optional) object to config the View class with

Returns:

Object:

Firebrick.view.Base class

getBody

(
  • refresh
)
Object

Defined in src\firebrick.js:866

Shortcut to get jQuery("body")

Parameters:

  • refresh Boolean

    [default=false] (optional) if true gets the body object fresh from dom and not from cache

Returns:

Object:

jquery object

getTarget

(
  • selector
)
Object, Null

Defined in src\firebrick.js:879

find the target using a selector - same as jQuery(selector)

Parameters:

  • selector String, jQuery Object

Returns:

Object, Null:

jquery object || null

initSubViews

(
  • view
)
Object private

Defined in src\firebrick.js:797

initialise subviews of a view

Parameters:

  • view Object

Returns:

Object:

view passed

renderTo

(
  • target
  • html
  • append
  • options
)
JQuery Object private

Defined in src\firebrick.js:889

Render HTML or Template to the given target

Parameters:

  • target JQuery Object
  • html String

    template or html

  • append Boolean

    [default=false] if true will append to instead of overwriting content of target

  • options $.show ( options )

    arguments - optional

Returns:

JQuery Object:

target

Properties

_body

Object jquery object private

Defined in src\firebrick.js:859

jQuery body object (cache) - is set initally by {{crossLink Firebrick.views:getBody}}{{/crossLink}}