Class: EventBus

Help4.EventBus()

central event bus

Constructor

new EventBus()

Source:

Extends

Members

(static) TYPES :Help4.EventBus.Types

Type:
Source:

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>

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

destroy()

destroys the EventBus
Overrides:
Source:

fire(event) → {Help4.EventBus}

Parameters:
Name Type Description
event Object
Source:
Returns:
Type
Help4.EventBus

isDestroyed() → {boolean}

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

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

subscribe(subscriber) → {Help4.EventBus}

Parameters:
Name Type Description
subscriber Help4.observer.EventBusObserver.EventBusSubscriber
Source:
Throws:
TypeError
Returns:
Type
Help4.EventBus

unsubscribe(subscriber) → {Help4.EventBus}

Parameters:
Name Type Description
subscriber Help4.observer.EventBusObserver.EventBusSubscriber
Source:
Returns:
Type
Help4.EventBus

Type Definitions

Types

Type:
  • Object
Properties:
Name Type Description
controllerStart 'controllerStart'
controllerDestroy 'controllerDestroy'
controllerOpen 'controllerOpen'
controllerClose 'controllerClose'
controllerAfterNavigate 'controllerAfterNavigate'
controllerPlaybackServiceReady 'controllerPlaybackServiceReady'
controllerEditMode 'controllerEditMode'
controllerPlaybackActive 'controllerPlaybackActive'
autoStartTour 'autoStartTour'
hotspotAssignStart 'hotspotAssignStart'
hotspotAssignStop 'hotspotAssignStop'
hotspotAssignPostpone 'hotspotAssignPostpone'
hotspotAssignResume 'hotspotAssignResume'
hotspotOver 'hotspotOver'
hotspotOut 'hotspotOut'
hotspotClick 'hotspotClick'
bubbleOver 'bubbleOver'
bubbleOut 'bubbleOut'
bubbleOpen 'bubbleOpen'
carouselTileOver 'carouselTileOver'
carouselTileOut 'carouselTileOut'
carouselTileClick 'carouselTileClick'
dragdrop 'dragdrop'
selectionTileSelect 'selectionTileSelect'
selectionTileDeselect 'selectionTileDeselect'
lightboxClose 'lightboxClose'
hotkey 'hotkey'
widgetStart 'widgetStart'
widgetVisibility 'widgetVisibility'
widgetActivate 'widgetActivate'
widgetStatus 'widgetStatus'
xhrStatus 'xhrStatus'
controlCreate 'controlCreate'
controlDestroy 'controlDestroy'
tourOpen 'tourOpen'
tourClose 'tourClose'
Source: