Classes

• _global_
• AsyncCompiler.createWorker.AsyncCompiler#createWorker-asyncCompiler
• ContentElement
• Controller
• Dictionary
• DisabledLogger
• GrammarConverter
• Helper
• Html5AudioOutput#newMediaPlugin.initialize-MediaError
• Layout
• Layout.TagElement
• Logger
• mmir
• mmir.CommonUtils
• mmir.CommonUtils.setToCompatibilityModeExtension
• mmir.ConfigurationManager
• mmir.Constants
• mmir.ControllerManager
• mmir.DialogManager
• mmir.DisabledLogging
• mmir.env.grammar.AsyncGenerator
• mmir.env.grammar.JisonAsyncGenerator
• mmir.env.grammar.JisonGenerator
• mmir.env.grammar.JsccAsyncGenerator
• mmir.env.grammar.JsccGenerator
• mmir.env.grammar.PegJsAsyncGenerator
• mmir.env.grammar.PegJsGenerator
• mmir.env.media.AudioCordovaImpl
• mmir.env.media.AudioHtml5Impl
• mmir.env.view.JqmViewEngine
• mmir.InputManager
• mmir.LanguageManager
• mmir.LanguageManager.setToCompatibilityModeExtension
• mmir.Logging
• mmir.main
• mmir.MediaManager
• mmir.ModelManager
• mmir.NotificationManager
• mmir.parser
• mmir.parser.element
• mmir.parser.ParserUtils
• mmir.parser.ParsingResult
• mmir.parser.RenderUtils
• mmir.parser.StorageUtils
• mmir.parser.TemplateProcessor
• mmir.PresentationManager
• mmir.SemanticInterpreter
• mmir.tools.ChecksumUtils
• Partial
• ScriptEvalError
• String
• View
• ViewConstants
• YieldDeclaration

Namespace mmir.CommonUtils

mmir.CommonUtils
Defined in: commonUtils.js.

	{
	  id: "5",
	  name: ["heinz", "kunz"],
   
	  //utility functions
	  has: function(key) : Boolean,
	  isMultiple: function(key) : Boolean,// is entry an Array of values
	  getKeys: function() : String[],     // get list of all keys
	}
	

var isList = mmir.CommonUtils.isArray(list);

Returns:

{Boolean} true if a network connection is enabled

Requires:

Cordova: org.apache.cordova.network-information

Parameters:

array

Returns:

{string} text

Parameters:

{jQuery} $ Optional

the jQuery instance/object (OPTIONAL); some few function need jQuery to work correctly (see requires annotations)

constants

Parameters:

{Object} _o

the object to convert to a JSON String.

Returns:

{String} the String value

 var jsonValue = mmir.CommonUtils.convertJSONStringValueToHTML(someValue);
 var data = JSON.parse('"theValue":"' + jsonValue + '"');
 ...

Parameters:

{Object} theObjectValue

the object to convert to a JSON String value. If NULL or UNDEFINED, an EMPTY String will be returned

Returns:

{String} the String value

Parameters:

{String} generatedGrammarsPath

Path of the grammars which should be loaded, e.g. gen/grammar/

{String} grammarId

the ID (e.g. language code) for the grammar

{Boolean} isFileNameOnly Optional

OPTIONAL if TRUE then only the file name will be returned, otherwise the full path is returned

Returns:

{String} file path / name for the compiled grammar (returns an empty string, if there is no compile grammar for the specified grammar ID)

Parameters:

{String} pathname

Path of the directory which contents should be returned

Returns:

{Array} Array of Strings which contains the contents of the directory

Parameters:

{String} pathname

Path of the directory which's contents should be returned

{String} filter

Filter for file-names which may contain a wildcard, e.g.: *.js, * or *.ehtml

Returns:

{Array} Array of Strings which contains the contents of the directory. Or null, if no matching contents could be found.

Returns:

{Object} Directory structure as json object

Parameters:

{String} scriptUrl

source of javascript-file

{Function} success

success callback function

{Function} fail

fail callback function

Returns:

{String} The Prefix for the file names of partial-files

Parameters:

success

errorFunc

 var checkArray = mmir.CommonUtils.getInstance().isArray;
if( checkArray(someObject) ){
  ...

Parameters:

{Object} object

the Object for checking if it is an Array

Returns:

{Boolean} true if object is an Array, otherwise false.

Parameters:

obj

Returns:

{Function} a function that takes one parameter (Object) and returns true if this parameter is an Array (false otherwise)

Returns:

{Boolean} True if application is running on Android, False otherwise

Returns:

{Boolean} True if application is running on smartphone, False otherwise

Parameters:

{String} pluginsPath Optional

OPTIONAL Path of the plugins which should be loaded, e.g. mmirf/plugins/ If omitted: the default plugin-path is used (see mmir.Constants#getPluginsPath)

{Function} cbFunction Optional

OPTIONAL The function that should be executed after the plugins are loaded. If the execution of following functions is dependent on the present of plugins, they should be triggered from inside the callback-function

Returns:

{Promise} a Deferred.promise (see loadImpl())

Parameters:

{String} generatedGrammarsPath

Path of the grammars which should be loaded, e.g. gen/grammar/

{Function} cbFunction

The function that should be executed after the plugins are loaded. If the execution of following functions is dependent on the presence of the grammars, they should be triggered from inside the callback-function.

{Array} ignoreGrammarIds Optional

OPTIONAL grammar IDs that should be ignored, i.e. not loaded, even if there is a file available

Returns:

{Promise} a Deferred.promise (see loadImpl())

Requires:

mmir.SemanticInterpreter (must be loaded as dependency "semanticInterpreter" at least once before this function is loaded)

Parameters:

{Function} success Optional

The function that should be executed after the diretories are parsed - it's best to include all following functions inside the callback-function.

{Function} errorFunc Optional

callback function that is invoked if an error occured during initialization.

Parameters:

{String|Array} librariesPath

Path (or list of of the plugins which should be loaded, e.g. mmirf/plugins/ NOTE: The (String) path must be an entry in directories.json! (directories.json is used to generate/"query" the file-list for the path)

{Boolean} isSerial

Set true if the libraries should be loaded serially, i.e. synchronously, that is "one after the other" (later ones may depend on earlier ones). set false if libraries should be loaded in parallel, i.e. "asychronously" (NOTE in this case, the libraries must not depend on each other). NOTE: The loading process as a hole is asynchronous (regardless of parameter isSerial), i.e. loading is completed when completedCallback() is invoked, NOT when this function returns!

{Function} completedCallback Optional

The function that should be executed after the libraries are loaded. If the execution of following functions is dependent on the presence of the libraries, they should be capsuled inside this callback-function.

{Function} checkIsAlreadyLoadedFunc Optional

If provided, this function checks (based on the file-name), if the library is already loaded. The signature for the callback is checkIsAlreadyLoadedFunc(String fileName) return [true|false], i.e. the function may check - based on the file-name - if the library is already loaded. If the function returns true, the library will not be loaded, and loading continues with the next library-file. NOTE: if isSerial is flase, libraries with lower indices in the list may still be loading, when later entries are checked with this callback. In consequence, the "is already loaded"-check may not be accurate, in case parallel loading is used and the library-list contains "duplicate" entries.

{Function} statusCallback Optional

If provided, this function is invoked, when a library was loaded loaded (INFO) or an error occurs. The signature for the callback is statusCallback(String statusLevel, String fileName, String message) where statusLevel is one of info, warning, error, fileName is the file-name for the library that this status message concerns, and message is a message text with details concerning the status

Returns:

{Promise} a Deferred.promise that will be fullfilled when loadImpl() has finished.

Parameters:

{String} url

source of javascript-file

{Function} callback

callback function

Deprecated:

instead use #getLocalScript()

	{
	  id: "5",
	  name: ["heinz", "kunz"],
   
	  //utility functions
	  has: function(key) : Boolean,
	  isMultiple: function(key) : Boolean,// is entry an Array of values
	  getKeys: function() : String[],     // get list of all keys
	}
	

Parameters:

{String} urlParamsPartStrings

the parameter-part of the URL, i.e. &...

Returns:

{Object} a "dictionary" for the parameters

Parameters:

{String} class_name

Name of the class which inner text should be fitted to the size of the element

Requires:

jQuery

Parameters:

{Function} success Optional

a callback function that is invoked, after compatibility mode was set (alternatively the returned promise can be used).

Deprecated:

use only for backward compatibility

Returns:

{jQuery.Promise} a Deffered.promise that is resolved, after compatibility mode was set

Requires:

jQuery.Deferred

mmir.CommonUtils.setToCompatibilityModeExtension

See:

mmir.CommonUtils.setToCompatibilityModeExtension

Parameters:

{string} pathname

The path that should be stripped of "file://" and a beginning or trailing "/"

Returns:

{String} The stripped pathname - devoid of beginning "file://" or "/" and trailing "/"

 var jsonValue = mmir.CommonUtils.toJSONStringValue(someValue);
 var data = JSON.parse('"theValue":"' + jsonValue + '"');

Parameters:

{Object} theObjectValue

the object to convert to a JSON String value. If NULL or UNDEFINED, an EMPTY String will be returned

Returns:

{String} the String value