DXP Framework

Module: managers/template-manager

This module process the project JSON modules into functional templates.

Source:

Requires

Methods

assignListeners()

Assigns listeners to events used in this class.

Source:
Listens to Events:
  • event:EVENT_ADMIN_GOT_MANIFEST
  • event:EVENT_NEW_PAGE
  • event:EVENT_BACK_BUTTON
  • event:EVENT_BACK_BUTTON_NO_ANIM
  • event:EVENT_TIMER_EXPIRED
  • event:EVENT_TOGGLE_MIC
  • event:EVENT_HISTORY

init()

Initializes class

Source:
Fires:
  • event:assignListeners()

assignListeners()

Assigns listeners to events used in this class.

Source:
Fires:
  • event:onJsonLoaded()
Listens to Events:
  • event:EVENT_JSON_LOADED

initSendKeyEvents()

Registers all of the project JSON events with the application event system

Source:

initModes()

Initializes application modes (ie IHA)

Source:

registerPages(modules)

Registers page modules. Where module ids are "m-page" or "iha-template-page" (if using IHA mode).

Parameters:
Name Type Description
modules Object

Collection of modules from the project json "module" node
Source:
Fires:
  • event:EVENT_NEW_PAGE - When page event is fired
  • event:onLoadPage(pageData) - When page event is fired
Listens to Events:
  • event:Page Events

getPageFromEvent(evt)

Returns module page data based on event string

Parameters:
Name Type Description
evt String

Event string
Source:
Returns:
  • Module data object
Type
Object

initPageEvents(pageData)

Initializes specialized module page events including video event handling.

Parameters:
Name Type Description
pageData Object

Module page data
Source:

initProxyEvents(proxyData)

Initializes event proxies

Parameters:
Name Type Description
proxyData Object

Proxy event data from the project JSON
Source:
Fires:
  • event:onCustomEventBehavior() - When proxy event is fired
Listens to Events:
  • event:Proxy events

onCustomEventBehavior(evt, proxyEvtStr)

Handles proxy event behavior

Parameters:
Name Type Description
evt String

Event string that is being proxied
proxyEvtStr String

Proxy event string
Source:
Fires:
  • event:EVENT_NEW_PAGE
  • event:onLoadPage()

onJsonLoaded(jData)

Got JSON data from core and project. Begins the template processing.

Parameters:
Name Type Description
jData JSON

JSON data
Source:
Fires:
  • event:EVENT_NEW_PAGE
  • event:onLoadPage()

onLoadPage(pageData)

Loads page from pageData

Parameters:
Name Type Description
pageData Object

Module page data
Source:
Fires:
  • event:EVENT_TEMPLATE_LOADED