mmir-lib
Version:
MMIR (Mobile Multimodal Interaction and Relay) library
162 lines (146 loc) • 5.83 kB
JavaScript
define([
'mmirf/util/deferredWithState'
, 'mmirf/configurationManager'
, 'mmirf/logger', 'module'
],
/**
* @class
* @name StubViewLoader
* @memberOf mmir.env.view
* @hideconstructor
*/
function(
deferred,
configurationManager,
Logger, module
){
/**
* Loads views (layouts and partials):
* either compiled views (i.e. JS files), or raw views (i.e. eHTML files).
*
* The loader checks, if compiled views are up-to-date (using the corresponding
* checksum file).
* If a compiled view is not up-to-date (or its checksum file is missing), then
* the raw view will be loaded and compiled.
*
* If raw views are loaded, the parsing-module will loaded for compiling the
* views (i.e. if only compiled views are loaded, the dependency for the template
* parser and renderer is not required).
*
*
* <br>
* <strong>Configuration (configuration.json)</strong>
* <br>
*
* The configuration value <code>"usePrecompiledViews"</code> (Boolean) allows
* the determine, if views should always be compiled from the eHTML files (even
* if up-to-date compiled views are present).
*
* For example, configuration <code>"usePrecompiledViews": true</code> will use
* compiled views, while <code>"usePrecompiledViews": false</code> will always
* compile the eHTML files.
*
*
* If the configuration value for {@link mmir.PresentationManager.CONFIG_DEFAULT_LAYOUT_NAME} is
* set to <code>NULL</code> no default layout will be loaded.
*
* If {@link mmir.PresentationManager.CONFIG_DEFAULT_LAYOUT_NAME} is a non-empty string, then
* the corresponding layout will be used as default layout, instead of
* {@link mmir.PresentationManager.DEFAULT_LAYOUT_NAME}.
*
*
* @param {PresentationManager} _instance
* the instance of the PresentationManager
* @param {Map<string, Layout>} _layouts
* the layout collection of the PresentationManager for adding loaded layouts
* @param {Map<string, View>} _views
* the view collection of the PresentationManager for adding loaded views
* @param {Map<string, Partial>} _partials
* the partials collection of the PresentationManager for adding loaded partials
* @param {Function} createViewKey
* the PresentationManager's helper function for creating keys to be used when
* adding views to <code>_views</code>:<br>
* <code>createViewKey(ctrl: {mmir.ctrl.Controller|String}, view: {mmir.view.View|String}) : {String}</code>
* @param {Function} createPartialKey
* the PresentationManager's helper function for creating keys to be used when
* adding partials to <code>_partials</code>:<br>
* <code>createPartialKey(partial: {mmir.view.Partial|String}, view: {mmir.view.View|String}) : {String}</code>
* @return {Promise}
* a deferred promise that gets resolved when the views (layouts, and partials) are loaded
*
* @memberOf mmir.env.view.StubViewLoader
*/
function loadViews (
_instance, _layouts, _views, _partials, _createViewKey, _createPartialKey
) {
/**
* The name of the configuration field that holds
* the name for the default layout.
*
* @private
* @type String
* @constant
* @memberOf mmir.env.view.StubViewLoader#
*/
var CONFIG_DEFAULT_LAYOUT_NAME = _instance.CONFIG_DEFAULT_LAYOUT_NAME;
/**
* Name for the default layout, that will be loaded.
*
* If NULL, no default layout will be loaded
* (see below configurationManager.get(CONFIG_DEFAULT_LAYOUT_NAME...))
*
* @private
* @type String
* @memberOf mmir.env.view.StubViewLoader#
*/
var defaultLayoutName = _instance.DEFAULT_LAYOUT_NAME;
/**
* The logger for the PresentationManager.
*
* @private
* @type mmir.tools.Logger
* @memberOf mmir.env.view.StubViewLoader#
*/
var logger = Logger.create(module);//initialize with requirejs-module information
// /**
// * Name of the configuration property that specifies whether or not to use
// * pre-compiled views, i.e. whether to use generated JavaScript files
// * instead of parsing & compiling the "raw" templates (eHTML files).
// *
// * <p>
// * NOTE: the configuration value, that can be retrieved by querying this configuration-property
// * has is either a Boolean, or a String representation of a Boolean value:
// * <code>[true|false|"true"|"false"]</code>
// * <br>
// * NOTE2: There may be no value set at all in the configuration for this property.
// * In this case you should assume that it was set to <code>false</code>.
// *
// * @type String
// * @private
// * @constant
// * @memberOf mmir.env.view.StubViewLoader#
// *
// * @example var isUsePrecompiledViews = mmir.conf.getBoolean("usePrecompiledViews");
// *
// */
// var CONFIG_PRECOMPILED_VIEWS_MODE = 'usePrecompiledViews';//TODO move this to somewhere else (collected config-vars?)? this should be a public CONSTANT...
// determine if default-layout has a custom name (or is disabled, in it was set to null)
var defLayoutName = configurationManager.get(CONFIG_DEFAULT_LAYOUT_NAME, void(0));
if(typeof defLayoutName !== 'undefined'){
defaultLayoutName = defLayoutName;
}
///////////// start intialization: ////////////////
logger.debug('initializing stub view loader with default layout '+JSON.stringify(defaultLayoutName));
/**
* Deferred / promise for loading views.
*
* @type Promise
* @private
* @memberOf mmir.env.view.StubViewLoader#
*/
var defer = deferred();
defer.resolve();
return defer;
};//END: loadViews(){
return loadViews;
});