Methods
_doLog(debugMessage) {undefined}
Parameters
Name
Type
Description
debugMessage
Object
Message object to be logged (returned by this.getMessageObject method)
Does actual logging to console (and log file is file logging is enabled)
_getStack() {array}
Helper method for getting call stack array for debug or user message objects
addBoundMethods() {undefined}
Method that sets up this.boundMethods property by binding this objects
functions to itself to be used as event listener handlers
addCss(href, noWatch, silent) {undefined}
Parameters
Name
Type
Description
href
string
Path to css file
noWatch
Boolean
Flag that prevents file watching
silent
Boolean
Flag that prevents logging
Add css files to current page head tag
addCssFiles(cssFiles, noWatch, silent) {undefined}
Parameters
Name
Type
Description
cssFiles
Array.<string>
An array of css files to add
noWatch
Boolean
Flag to prevent filesystem watching of compiled files
silent
Boolean
Flag to prevent logging output
Adds css files to head
addDesktopNotification(message, data, dontTranslate, options, callbacks) {undefined}
Parameters
Name
Type
Description
message
string
Notification message
data
array
An array of data strings that are to be applied to notification
dontTranslate
Boolean
Flag to prevent automatic notification translation
options
Object
Desktop notification options (passed to HTML5 Notification object constructor)
callbacks
Object
Object with onshow, onClicked, onClosed and onerror notification handlers
Displays desktop notification
Notification message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
addEventListeners() {undefined}
Adds event listeners for this object
addModalMessage(message, type, data, important, dontTranslate, force, passToDebug) {undefined}
Parameters
Name
Type
Description
message
string
Message to be logged
type
string
Type of log message (debug, info, warning, error)
data
array
An array of data strings that are to be applied to logging message
important
Boolean
Flag to indicate message importance
dontTranslate
Boolean
Flag to prevent automatic message translation
force
Boolean
Flag to force message output even if configuration wouldn't allow it
passToDebug
Boolean
Flag to force passing same message to debug log
Adds modal message to currently open modal dialog
Message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
addNotification(message, type, data, dontTranslate, options) {undefined}
Parameters
Name
Type
Description
message
string
Notification message
type
string
Notification message type
data
array
An array of data strings that are to be applied to notification
dontTranslate
Boolean
Flag to prevent automatic notification translation
options
Object
Additional notification options
Displays app notification
Notification message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
addUserMessage(message, type, data, important, dontTranslate, force, passToDebug) {undefined}
Parameters
Name
Type
Description
message
string
Message to be logged
type
string
Type of log message (debug, info, warning, error)
data
array
An array of data strings that are to be applied to logging message
important
Boolean
Flag to indicate message importance
dontTranslate
Boolean
Flag to prevent automatic message translation
force
Boolean
Flag to force message output even if configuration wouldn't allow it
passToDebug
Boolean
Flag to force passing same message to debug log
Logs user message if conditions are met
Message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
asyncMessage(data) {mixed}
Parameters
Name
Type
Description
data
Object
Message data object
Emits 'asyncMessage' global event, listened by main script
asyncMessageInfo(data, verboseOutput) {Object}
Parameters
Name
Type
Description
data
Object
Message data.data object
verboseOutput
Boolean
Toggles verbose output
Returns info on async messages that can be passed to mainScript
clearIntervals() {undefined}
Clears all intervals bound to this AppWrapper instance
clearTimeouts() {undefined}
Clears all timeouts bound to this AppWrapper instance
compileCss(noWatch, silent) {string}
Parameters
Name
Type
Description
noWatch
Boolean
Flag that prevents file watching
silent
Boolean
Flag that prevents logging
Compiles all css file contents to minified css, based on configuration
compileCssTypeGroup(cssFiles, type, noWatch, silent) {string}
Parameters
Name
Type
Description
cssFiles
Array.<string>
An array of css file paths to load
type
string
Type of css file paths to load
noWatch
Boolean
Flag to prevent filesystem watching of compiled files
silent
Boolean
Flag to prevent logging output
Loads css from all files in group and returns compiled css value
cssFileChanged(e, filename) {undefined}
Parameters
Name
Type
Description
e
Event
Event that triggered the method
filename
string
Path to changed file
Handler that gets triggered when css file is changed on disk
destroy() {undefined}
Destructor method - cleans up references for this instance
freeing memory upon object destruction
detectMissingVariables(silent) {Array.<string>}
Parameters
Name
Type
Description
silent
Boolean
Flag to prevent logging
Detects eventual missing css variables
doReloadCss() {undefined}
Handler that reloads all css on page
finalize() {Boolean}
Finalizes current class instance, setting up any additional properties
etc. Entire app structure, including frontend app is available here
generateCss(noWatch, silent) {undefined}
Parameters
Name
Type
Description
noWatch
Boolean
Flag that prevents file watching
silent
Boolean
Flag that prevents logging
Generates css by compiling all files or adding all files to head tag based on configuration
getAppState() {Object}
Helper method to get appState object
getAppWrapper() {AppWrapper}
Helper method to get appWrapper instance
getCompiledCssPath(relativePath) {string}
Parameters
Name
Type
Description
relativePath
Boolean
Flag to indicate that relative path should be returned
Returns path to compiled css file (relative or absolute, based on parameter)
getConfig(name, defaultValue) {mixed}
Parameters
Name
Type
Description
name
string
String representing path to requested var (i.e. 'appConfig.appInfo.name')
defaultValue
mixed
Default value to be returned if configuration var is not found
Returns configuration var value
getCssFileData() {Object}
Returns prepared css data object, getting info from appState and configuration
getCssFiles() {Array.<string>}
Returns list of css files to be loaded, using appState and configuration
getDebugMessageFileLine(message) {string}
Parameters
Name
Type
Description
message
obj
Message object to be logged (returned by this.getMessageObject method)
Returns string representing log line for appending
to debug log file
getDebugMessageFilePath() {string}
Returns path to debug message log file
getHelper(name) {Object}
Parameters
Name
Type
Description
name
string
Name of the helper
Returns instance of helper object based on passed parameter (or false if helper can't be found)
getMessageFileLine(message) {string}
Parameters
Name
Type
Description
message
obj
Message object to be logged (returned by this.getMessageObject method)
Gets JSON represenation of message object for saving into log file,
removing unneccessary properties and adding necessary ones
getMessageObject(messageLevel, message, type, data, important, dontTranslate, force) {Object}
Parameters
Name
Type
Description
messageLevel
int
Number representing current message level (0=debug, 1=info, 2=warning, 3=error)
message
string
Message to be logged
type
string
Type of log message (debug, info, warning, error)
data
array
An array of data strings that are to be applied to logging message
important
Boolean
Flag to indicate message importance
dontTranslate
Boolean
Flag to prevent automatic message translation
force
Boolean
Flag to force message output even if configuration wouldn't allow it
Returns prepared message object based on passed arguments.
Message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
getMessageObjectRow(index, messageRowData) {Object}
Parameters
Name
Type
Description
index
mixed
Key or array index
messageRowData
Object
Message row data for logging
Gets single row for tabular message logging
getStateVar(varPath, defaultValue) {mixed}
Parameters
Name
Type
Description
varPath
string
String representing path to requested var (i.e. 'appData.appMainData.cancelable')
defaultValue
mixed
Default value to be returned if appState var is not found
Returns appState var value
getTableMessageData(message) {Object}
Parameters
Name
Type
Description
message
Object
Tabular data
Prepares table data for tabular message logging
getUserMessageFileLine(message) {string}
Parameters
Name
Type
Description
message
obj
Message object to be logged (returned by this.getMessageObject method)
Returns string representing log line for appending
to user message log file
getUserMessageFilePath() {string}
Returns path to user message log file
globalEmit(eventName, data) {undefined}
Parameters
Name
Type
Description
eventName
String
Name of the event
data
Object
Event data object
Emits event to globalEmitter (listened by both main script and app code)
Initializes current class instance, setting up logging and
bound methods to be used in event listeners
Parameters
Name
Type
Description
options
Object
Options for logging initialization (currently only 'silent' property is used, determining whether warnings should be printed if no config found)
Determines whether logging for this class is regulated through
configuration, setting the logging by it (or warning if there
are no configuration settings for this class)
isDebugEnabled() {Boolean}
Checks whether debug mode is on
loadCss(href, noWatch) {string}
Parameters
Name
Type
Description
href
string
Relative or absolute path to css file
noWatch
Boolean
Flag that prevents file watching
Loads css file, returning its contents
loadCssFiles(silent) {undefined}
Parameters
Name
Type
Description
silent
Boolean
Flag that prevents logging
Prepares and loads css files using appState and config data
loadJs(jsFile) {Boolean}
Parameters
Name
Type
Description
jsFile
string
Path to js file
Adds js file script tag to document head element
loadJsFiles() {undefined}
Loads all js files using configuration
loadJsTypeGroup(jsFiles, type) {undefined}
Parameters
Name
Type
Description
jsFiles
Array.<string>
An array of js files to load
type
string
Type of js files to load
Loads group of js files of given type
log(message, type, data, force) {undefined}
Parameters
Name
Type
Description
message
string
Message to be logged
type
string
Type of log message (debug, info, warning, error, group, groupCollaped, groupend)
data
array
An array of data strings that are to be applied to logging message
force
Boolean
Flag to force logging output even if config does not allow it
Logs debug message if conditions are met
Message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
message(data) {undefined}
Parameters
Name
Type
Description
data
Object
Event data object
Emits 'message' global event, listened by main script
messageInfo(data, verboseOutput) {Object}
Parameters
Name
Type
Description
data
Object
Message data.data object
verboseOutput
Boolean
Toggles verbose output
Returns info on messages that can be passed to mainScript
messageInfoOutput(messageData, verboseOutput) {undefined}
Parameters
Name
Type
Description
messageData
Object
Message response data
verboseOutput
Boolean
Toggles verbose output
Logs messages info to console
rebaseAsset(asset, dir) {string}
Parameters
Name
Type
Description
asset
Object
Asset data
dir
Object
Directories data
refreshCss() {undefined}
Refreshes css loaded on page by adding random query selector to file url
refreshCssFiles(changedFiles) {undefined}
Parameters
Name
Type
Description
changedFiles
Array.<string>
Array of changed css file paths
Refreshses css files upon css file change on disk
refreshLinkTags(links) {undefined}
Parameters
Name
Type
Description
links
Array.<DOMElement>
Array of elements to refresh
Refreshes selected tags on page by adding (or replacing) random query string to their urls
reloadCss(e) {undefined}
Parameters
Name
Type
Description
e
Event
Event that triggered the method
Handler that reloads all css on page
removeBoundMethods() {undefined}
Method that cleans up this.boundMethods property
set in this.addBoundMethods method
removeEventListeners() {undefined}
Removes event listeners for this object
removeOldCssTags(links) {undefined}
Parameters
Name
Type
Description
links
Array.<DOMElement>
Array of elements to remove
Removes old CSS tags from head element
resetAppError() {undefined}
Resets (turns off) application error, removing app-error component
setAppError(title, text, debugText, data, doNotTranslate, messageType, omitIcon) {undefined}
Parameters
Name
Type
Description
title
String
App error title
text
String
App error text
debugText
String
App error debug text (shown only if debug is enabled)
data
Array.<String>
An array with replacement data for error title, text and debugText
doNotTranslate
Boolean
Flag to prevent automatic traslation of title and text
messageType
String
|
null
Type of messages to show in app-error ('user', 'debug' or null)
omitIcon
Boolean
Flag to control app-error icon rendering
Sets (turns on) application error, triggering rendering of app-error component
translate(text, currentLanguage, data) {string}
Parameters
Name
Type
Description
text
string
Text to be translated
currentLanguage
string
Curent language code
data
array
An array of data strings that are to be applied to translated message
Returns translated value for passed arguments
Translation is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
unwatchFiles() {undefined}
Removes watchers from all watched files
writeCss(filePath, cssContents) {undefined}
Parameters
Name
Type
Description
filePath
string
Absolute css file path
cssContents
string
CSS contents to write
Writes css contents to file from argument