ModalHelper()
Creates ModalHelper instance
Class: ModalHelper
Methods
_doLog(debugMessage){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| debugMessage | Object | Message object to be logged (returned by this.getMessageObject method) |
Return
Does actual logging to console (and log file is file logging is enabled)
_getStack(){array}
Return
Helper method for getting call stack array for debug or user message objects
addBoundMethods(){undefined}
Return
Method that sets up this.boundMethods property by binding this objects
functions to itself to be used as event listener handlers
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 |
Return
Displays desktop notification
Notification message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
addEventListeners(){undefined}
Return
Adds event listeners for this object
addModalMessage(messageObject){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| messageObject | Object | Message object |
Return
Adds modal message to currently visible modal
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 |
Return
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 |
Return
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 |
Return
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 |
Return
Returns info on async messages that can be passed to mainScript
autoCloseModal(){undefined}
Return
Automatically closes modal after timeout from modal options
clearIntervals(){undefined}
Return
Clears all intervals bound to this AppWrapper instance
clearModalMessages(){undefined}
Return
Clears modal messages from currently visible modal
clearTimeouts(){undefined}
Return
Clears all timeouts bound to this AppWrapper instance
closeCurrentModal(force){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| force | Boolean | Flag to force modal closing even if modal is busy |
Return
Closes currently visible modal dialog
closeCurrentModalDelayed(delay, busyText, force){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| delay | Integer | Delay in milliseconds |
| busyText | string | Busy message to show |
| force | Boolean | Flag to force modal closing even if modal is busy |
Return
Closes current modal dialog with delay, setting busy status and message grom argument
confirm(title, text, confirmButtonText, cancelButtonText, confirmAction){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| title | string | Modal title |
| text | string | Modal text |
| confirmButtonText | string | Confirm button text |
| cancelButtonText | string | Cancel button text |
| confirmAction | function | Modal confirm callback |
Return
Opens confirm modal dialog using basic parameters from method arguments
confirmResolve(e){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| e | Event | Event that triggered the method |
Return
Resolve method for confirm modal promise
destroy(){undefined}
Return
Destructor method - cleans up references for this instance
freeing memory upon object destruction
emptyModal(){undefined}
Return
Empties current modal, reverting it to default values
finalize(){Boolean}
Return
Finalizes current class instance, setting up any additional properties
etc. Entire app structure, including frontend app is available here
getAppState(){Object}
Return
Helper method to get appState object
getAppWrapper(){AppWrapper}
Return
Helper method to get appWrapper instance
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 |
Return
Returns configuration var value
getDebugMessageFileLine(message){string}
Parameters
| Name | Type | Description |
|---|---|---|
| message | obj | Message object to be logged (returned by this.getMessageObject method) |
Return
Returns string representing log line for appending
to debug log file
getDebugMessageFilePath(){string}
Return
Returns path to debug message log file
getHelper(name){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| name | string | Name of the helper |
Return
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) |
Return
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 |
Return
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 |
Return
Gets single row for tabular message logging
getModalObject(modalName, options){Object|Boolean}
Parameters
| Name | Type | Description |
|---|---|---|
| modalName | string | Name of modal object |
| options | Object | Modal option overrides |
Return
Gets modal data object by its name, applying optional option overrides
getModalVar(name){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| name | string | Name of the variable |
Return
Gets current modal variable value by name
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 |
Return
Returns appState var value
getTableMessageData(message){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| message | Object | Tabular data |
Return
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) |
Return
Returns string representing log line for appending
to user message log file
getUserMessageFilePath(){string}
Return
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 |
Return
Emits event to globalEmitter (listened by both main script and app code)
initialize(){ModalHelper}
Return
Initializes ModalHelper object instance
initializeLogging(options){appWrapper.AppBaseClass}
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) |
Return
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)
inlineConfirm(title, text, confirmButtonText, cancelButtonText, confirmAction){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| title | string | Modal title |
| text | string | Modal text |
| confirmButtonText | string | Confirm button text |
| cancelButtonText | string | Cancel button text |
| confirmAction | function | Modal confirm callback |
Return
Shows inline confirm modal dialog (preserving original modal content) using basic parameters from method arguments
isDebugEnabled(){Boolean}
Return
Checks whether debug mode is on
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 |
Return
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 |
Return
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 |
Return
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 |
Return
Logs messages info to console
modalBusy(message){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| message | string | Optional message to display in modal |
Return
Sets modal dialog status to busy using message from argument (or default one if no message is passed)
modalNotBusy(){undefined}
Return
Sets modal dialog status to not busy
modalNotReady(){undefined}
Return
Resets modal dialog ready status to false
modalReady(){undefined}
Return
Sets modal dialog ready status to true
openCurrentModal(){undefined}
Return
Opens current modal dialog
openModal(modalName, options){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| modalName | string | Name of modal object |
| options | Object | Modal option overrides |
Return
Opens modal dialog by its name, applying optional option overrides
openSimpleModal(title, text, options, confirmAction, cancelAction){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| title | string | Modal title |
| text | string | Modal text |
| options | Object | Modal option overrides |
| confirmAction | function | Confirm modal callback |
| cancelAction | function | Cancel / close modal callback |
Return
Opens simple modal dialog using basic parameters from method arguments
queryModal(confirmAction, cancelAction){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| confirmAction | function | Modal confirm callback |
| cancelAction | function | Modal cancel/close callback |
Return
Opens query modal dialog
queryReject(e){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| e | Event | Event that triggered the method |
Return
Reject method for query modal
queryResolve(e){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| e | Event | Event that triggered the method |
Return
Resolve method for query modal
removeBoundMethods(){undefined}
Return
Method that cleans up this.boundMethods property
set in this.addBoundMethods method
removeEventListeners(){undefined}
Return
Removes event listeners for this object
resetAppError(){undefined}
Return
Resets (turns off) application error, removing app-error component
resetCurrentCallbacks(){undefined}
Return
Resets callbacks for current modal object
resetModalActions(){undefined}
Return
Resets modal action listeners to their defaults
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 |
Return
Sets (turns on) application error, triggering rendering of app-error component
setModalData(data, overwrite){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| data | Object | Modal data to set |
| overwrite | Boolean | Flag to indicate data overwriting instead of merging with existing data |
Return
Sets modal data using argument
setModalVar(name, value){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| name | string | Name of the variable |
| value | Object | Value of the variable |
Return
Sets modal variable for current modal
setModalVars(data){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| data | Object | Data with properties and values for variables tos et |
Return
Sets modal variables using data argument
stopAutoCloseModal(){undefined}
Return
Stops auto closing modal countdown
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 |
Return
Returns translated value for passed arguments
Translation is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
updateAutoCloseTimer(seconds){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| seconds | Integer | Remaining time in seconds |
Return
Updates auto close timer in modal dialog (for auto-closing modals)