JSDoc: Class: MLTEngine

Constructor

new MLTEngine(params)

Parameters:

Name	Type	Description
`params`	Help4.engine.MLTEngine.Params

Properties:

Name	Type	Description
`controller`	Help4.controller.Controller
`domRefreshEngine`	Help4.engine.DomRefreshEngine
`_started`	boolean
`_domRefreshExecutor`	function
`_onPanelEvent`	function
`_targetLanguage`	string
`_sourceLanguages`	Array.<string>
`_preferredLanguage`	string
`_languageMap`	Object	{en-US: ['de-DE', 'es-ES'], de-DE: ['en-US', 'es-ES'], ...}
`_translationActive`	boolean
`_openBubbles`	Array.<Help4.engine.MLTEngine.Bubbles>
`_activeBubble`	Help4.engine.MLTEngine.Bubbles
`_translatedBubble`	Help4.engine.MLTEngine.Bubbles
`_excludeBubble`	string \| null
`_translationAvailable`	boolean
`_cache`	Object	{en: {id1: {translation: , original: }, id2: {}}, de: {id3: {...}, id4: {...}}}
`_xhrPromiseContainer`	Object
`_xhrError`	boolean

Source:

engine/MLTEngine.js, line 92

Extends

Help4.jscore.ControlBase

Members

TRANSLATION_STATES :Object

Type:

Object

Properties:

Name	Type	Description
`success`	'success'
`fail`	'fail'
`partial`	'partial'
`skipped`	'skipped'

Source:

engine/MLTEngine.js, line 140

Methods

(protected) ____defineDataFunctions()

Overrides:

Help4.jscore.ControlBase#____defineDataFunctions

Source:

jscore/ControlBase.js, line 472

(protected) ____defineProperties(params, derivedopt, nullable)

Parameters:

Name Type Attributes Default Description

params Object

derived

Object

null

Properties

Name	Type	Description
`GET`	Object
`SET`	Object

Overrides:

Help4.jscore.ControlBase#____defineProperties

Source:

jscore/ControlBase.js, line 374

(protected) ____defineProperty(args)

Parameters:

Name Type Description

args

Object

Properties

Name	Type	Attributes	Default	Description
`type`	string	<optional>	'param'	for Help4.jscore.DataBase
`key`	string
`info`	Help4.jscore.ControlBase.Param
`funGet`	Help4.jscore.ControlBase.FunGet
`funSet`	Help4.jscore.ControlBase.FunSet

Overrides:

Help4.jscore.ControlBase#____defineProperty

Source:

jscore/ControlBase.js, line 408

(protected) ____defineStaticProperties()

auto define all to be cleaned properties

Overrides:

Help4.jscore.ControlBase#____defineStaticProperties

Source:

jscore/Base.js, line 309

Throws:

Error

(protected) ____extendParams(dest, src) → {Object}

Parameters:

Name	Type	Description
`dest`	Object
`src`	Object

Overrides:

Help4.jscore.ControlBase#____extendParams

Source:

jscore/ControlBase.js, line 321

Returns:

Type: Object

(protected) ____getClassConfig() → {Help4.jscore.Base.Params}

Overrides:

Help4.jscore.ControlBase#____getClassConfig

Source:

jscore/Base.js, line 249

Returns:

Type: Help4.jscore.Base.Params

(protected) ____getData() → {Object}

Overrides:

Help4.jscore.ControlBase#____getData

Source:

jscore/ControlBase.js, line 311

Returns:

Type: Object

(protected) ____mergeDerivedParams(level0, level1)

Parameters:

Name	Type	Description
`level0`	Help4.jscore.Base.Params
`level1`	Help4.jscore.Base.Params

Overrides:

Help4.jscore.ControlBase#____mergeDerivedParams

Source:

jscore/Base.js, line 279

Throws:

Error

(protected) ____resolveDerivedParams(classConfig)

Parameters:

Name	Type	Description
`classConfig`	Help4.jscore.Base.Params

Overrides:

Help4.jscore.ControlBase#____resolveDerivedParams

Source:

jscore/Base.js, line 257

(protected) ____setInitValue(args)

Parameters:

Name Type Description

args

Object

Properties

Name	Type	Description
`key`	string
`info`	Help4.jscore.ControlBase.Param
`params`	Object
`funSet`	Help4.jscore.ControlBase.FunSet

Overrides:

Help4.jscore.ControlBase#____setInitValue

Source:

jscore/ControlBase.js, line 455

(protected) _destroyControl(…keys)

destroys class properties

Parameters:

Name	Type	Attributes	Description
`keys`	string	<repeatable>

Overrides:

Help4.jscore.ControlBase#_destroyControl

Source:

jscore/Base.js, line 238

(protected) _fireEvent(event) → {Help4.jscore.Base}

fires an event that can be observed from outside

Parameters:

Name	Type	Description
`event`	Object	the event to be fired

Overrides:

Help4.jscore.ControlBase#_fireEvent

Source:

jscore/Base.js, line 178

Returns:

Type: Help4.jscore.Base

(async, protected) _fireEvent2(event) → {Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>}

fires an event that can be observed from outside

Parameters:

Name	Type	Description
`event`	Object	the event to be fired

Overrides:

Help4.jscore.ControlBase#_fireEvent2

Source:

jscore/Base.js, line 198

Returns:

Type: Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>

(protected) _fireEventSync(event) → {Array.<Help4.EmbeddedEvent.EventResponse>}

fires an event that can be observed from outside

Parameters:

Name	Type	Description
`event`	Object	the event to be fired

Overrides:

Help4.jscore.ControlBase#_fireEventSync

Source:

jscore/Base.js, line 220

Returns:

Type: Array.<Help4.EmbeddedEvent.EventResponse>

addListenerSync(eventType, listener) → {Help4.jscore.Base}

add an event listener

Parameters:

Name	Type	Description
`eventType`	string \| Array.<string>	event type to be observed
`listener`	Help4.EmbeddedEvent.Listener	the callback function

Overrides:

Help4.jscore.ControlBase#addListenerSync

Source:

jscore/Base.js, line 116

Returns:

Type: Help4.jscore.Base

destroy()

destroys this instance

Overrides:

Help4.jscore.ControlBase#destroy

Source:

engine/MLTEngine.js, line 148

getPreferredLanguage() → {string}

Source:

engine/MLTEngine.js, line 249

Returns:

Type: string

getTargetLanguage() → {string}

Source:

engine/MLTEngine.js, line 239

Returns:

Type: string

isDestroyed() → {boolean}

whether instance is destroyed

Overrides:

Help4.jscore.ControlBase#isDestroyed

Source:

jscore/Base.js, line 84

Returns:

Type: boolean

isStarted() → {boolean}

Source:

engine/MLTEngine.js, line 229

Returns:

Type: boolean

isTranslationActive() → {boolean}

Source:

engine/MLTEngine.js, line 234

Returns:

Type: boolean

isTranslationAvailable() → {boolean}

Source:

engine/MLTEngine.js, line 244

Returns:

Type: boolean

(async) onBubbleClick(params) → {Promise.<void>}

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`bubble`	Help4.engine.MLTEngine.Bubbles
`active`	boolean

Source:

engine/MLTEngine.js, line 289

Throws:

Error

Returns:

Type: Promise.<void>

(async) registerBubble(bubble)

Parameters:

Name	Type	Description
`bubble`	Help4.engine.MLTEngine.Bubbles

Source:

engine/MLTEngine.js, line 254

(async) start() → {Promise.<void>}

Source:

engine/MLTEngine.js, line 154

Returns:

Type: Promise.<void>

(async) stop() → {Promise.<void>}

Source:

engine/MLTEngine.js, line 195

Returns:

Type: Promise.<void>

unregisterBubble(bubble)

Parameters:

Name	Type	Description
`bubble`	Help4.engine.MLTEngine.Bubbles

Source:

engine/MLTEngine.js, line 267

Type Definitions

Bubbles

Type:

Help4.widget.help.view2.GlobalHelpDialogControl | Help4.widget.help.view2.BubbleControl | Help4.widget.tour.BubbleControl

Source:

engine/MLTEngine.js, line 25

ContentObject

Type:

Object

Properties:

Name	Type	Description
`data`	string
`contentType`	string
`language`	string

Source:

engine/MLTEngine.js, line 11

Params

Type:

Help4.jscore.ControlBase.Params

Properties:

Name	Type	Description
`controller`	Help4.controller.Controller
`domRefreshEngine`	Help4.engine.DomRefreshEngine

Source:

engine/MLTEngine.js, line 33

PermissionsResponse

Type:

Object

Properties:

Name Type Description

response

Object

Properties

Name Type Description

permission

Object

Properties

Name	Type	Description
`permissionNames`	Array.<string>

Source:

engine/MLTEngine.js, line 46

ServerResponse

Type:

Object

Properties:

Name	Type	Description
`content`	Help4.engine.MLTEngine.ServerResponseContent
`sourceLanguage`	string
`targetLanguage`	string

Source:

engine/MLTEngine.js, line 61

ServerResponseContent

Type:

Object

Properties:

Name	Type	Description
`contentType`	string	content type of the text
`data`	string	translated text
`encoding`	string
`status`	number	status code of the translation e.g. 200, 500 etc.

Source:

engine/MLTEngine.js, line 53

SupportedFeaturesResponse

Type:

Object

Properties:

Name Type Description

response

Object

Properties

Name Type Description

feature

Object

Properties

Name	Type	Description
`featureNames`	Array.<string>

Source:

engine/MLTEngine.js, line 39

TranslationData

Type:

Object

Properties:

Name	Type	Description
`data`	Object	{en-US: Help4.engine.MLTEngine.ContentObject[], ...}
`meta`	Object	{en-US: [{original: , id: , widgetName: , subName?: }], de-DE: [{}]}
`cache`	Object	{en-US: [{translation: , original: , id: , widgetName: , subName?: }], de-DE: [{}]}

Source:

engine/MLTEngine.js, line 18

UrlConfig

Type:

Object

Properties:

Name	Type	Description
`serverBaseUrl`	string	base URL of the content server
`translation`	string	URL extension for translation calls
`feature`	string	URL extension to check if feature is supported in SEN
`permission`	string	URL extension to check if user has permission in SEN
`supportedLanguages`	string	URL extension to get supported languages

Source:

engine/MLTEngine.js, line 2