Class: module:argos/ApplicationModule

(abstract) module:argos/ApplicationModule()

ApplicationModule is intended to be extended in the resulting application so that it references all the views, toolbars and customizations and registers them to App.

You may think of ApplicationModule as "loader" or initializer.

Constructor

(abstract) new module:argos/ApplicationModule()

Source:

Members

application

Properties:
Name Type Description
The Object

App instance for the application

Source:

Methods

destroy()

Destroy loops and disconnects all _connects and unsubscribes all _subscribes. Also calls uninitialize

Source:

init(application)

Saves the passed application instance and calls:

  1. loadCustomizations
  2. loadToolbars
  3. loadViews
Parameters:
Name Type Description
application Object
Source:

initDynamic()

initDynamic is invoked after appStatePromises run.

Source:

loadAppStatePromises()

Source:

loadAppStatPromises()

Deprecated:
  • - typo, use loadAppStatePromises instead.
Source:

loadCustomizations()

Source:

(abstract) loadCustomizationsDynamic()

loadCustomizationsDynamic is invoked after appStatePromises run.

Source:

(abstract) loadToolbars()

This function should be overriden in the app and be used to register all toolbars.

Source:

(abstract) loadToolbarsDynamic()

loadToolbarsDynamic is invoked after appStatePromises run.

Source:

(abstract) loadViews()

This function should be overriden in the app and be used to register all views.

Source:

(abstract) loadViewsDynamic()

loadViewsDynamic is invoked after appStatePromises run.

Source:

registerAppStatePromise(promise)

Registers a promise that will resolve when initAppState is invoked.

Parameters:
Name Type Description
promise Promise | function

A promise or a function that returns a promise

Source:

registerCustomization(set, id, spec)

Passes the customization instance to App.registerCustomization.

Parameters:
Name Type Description
set String

The customization set name, or type. Examples: list, detail/tools, list/hashTagQueries

id String

The View id the customization will be applied to

spec Object

The customization object containing at least at and type.

Source:

registerToolbar(name, toolbar, domNode)

Passes the toolbar instance to App.registerToolbar.

Parameters:
Name Type Description
name String

Unique name of the toolbar to register.

toolbar Object

Toolbar instance to register.

domNode DOMNode

Optional. DOM node to place the view in.

Source:

registerView(view, domNode, position)

Passes the view instance to App.registerView.

Parameters:
Name Type Default Description
view Object

View instance to register

domNode DOMNode

Optional. DOM node to place the view in.

position String first

Optional. The position to place in the given DOM node. (first, last)

Source:

uninitialize()

Performs any additional destruction requirements

Source: