Class: CMP4

Help4.controller.CMP4(params)

CMP4 controller

Constructor

new CMP4(params)

Parameters:
Name Type Description
params Help4.controller.CMP4.Params
Properties:
Name Type Attributes Description
__controller Help4.controller.Controller
docked boolean
position Help4.control2.PositionLeftTop <nullable>
started boolean
active boolean
panel Help4.control2.bubble.Panel <nullable>
mltPreferredLanguage string
mltTranslationActive boolean
mltTargetLanguage string
_helpAvailable boolean
_statusObserver Help4.observer.EventBusObserver <nullable>
_autoStartTourObserver Help4.observer.EventBusObserver <nullable>
_widget string <nullable>
_cmp3 Object <nullable>
Source:

Extends

Methods

(protected) ____defineStaticProperties()

auto define all to be cleaned properties
Overrides:
Source:
Throws:
Error

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

Overrides:
Source:
Returns:
Type
Help4.jscore.Base.Params

(protected) ____mergeDerivedParam(level0, type, value)

Parameters:
Name Type Description
level0 Help4.jscore.Base.Params
type string
value *
Overrides:
Source:
Throws:
Error

(protected) ____mergeDerivedParams(level0, level1)

Parameters:
Name Type Description
level0 Help4.jscore.Base.Params
level1 Help4.jscore.Base.Params
Overrides:
Source:
Throws:
Error

(protected) ____resolveDerivedParams(classConfig)

Parameters:
Name Type Description
classConfig Help4.jscore.Base.Params
Overrides:
Source:

(protected) _destroyControl(…keys)

destroys class properties
Parameters:
Name Type Attributes Description
keys string <repeatable>
Overrides:
Source:

(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:
Source:
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:
Source:
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:
Source:
Returns:
Type
Array.<Help4.EmbeddedEvent.EventResponse>

(async) activate(infoopt) → {Promise.<void>}

activates CMP4 mode
Parameters:
Name Type Attributes Default Description
info Object <optional>
 {}
Properties
Name Type Attributes Default Description
cmp3 Object <optional>
 {} resume info fom CMP3
editor Object <optional>
<nullable>
 null switch from CMP3 editing to CMP4 playback
callback function <optional>
 () => {}
Source:
Returns:
Type
Promise.<void>

addListener(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:
Source:
Returns:
Type
Help4.jscore.Base

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:
Source:
Returns:
Type
Help4.jscore.Base

(async) deactivate(paramsopt) → {Promise.<void>}

activates CMP3 mode
Parameters:
Name Type Attributes Default Description
params Object <optional>
 {}
Properties
Name Type Attributes Default Description
terminate boolean <optional>
 false
Source:
Returns:
Type
Promise.<void>

deserialize(obj, getSerializedData, full) → (nullable) {Object}

Parameters:
Name Type Description
obj Object
getSerializedData function
full boolean
Source:
Returns:
Type
Object

destroy()

destroy instance
Overrides:
Source:

isDestroyed() → {boolean}

whether instance is destroyed
Overrides:
Source:
Returns:
Type
boolean

minimize(minimized)

Parameters:
Name Type Description
minimized boolean
Source:

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

remove an event listener
Parameters:
Name Type Description
eventType string | Array.<string>
listener Help4.EmbeddedEvent.Listener
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

serialize(paramsopt) → {Object}

Parameters:
Name Type Attributes Default Description
params Object <optional>
 {}
Properties
Name Type Attributes Default Description
full boolean <optional>
 true whether full storage is enabled
Source:
Returns:
Type
Object

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

starts CMP4 infrastructure
Source:
Returns:
Type
Promise.<void>

Type Definitions

Params

Type:
Properties:
Name Type Description
controller Help4.controller.Controller
Source: