JSDoc: Class: Widget

Constructor

Properties:

Name	Type	Attributes
`projectId`	string	<nullable>
`_autoStart`	Object
`_view`	Help4.widget.tour.View	<nullable>
`_startStatus`	Help4.widget.tour.Widget.StartStatus	<nullable>

Source:

widget/tour/Widget.js, line 49

Extends

Help4.widget.Widget

Members

(static) NAVIGATE_WAIT_TIME :number

see Help4.widget.tour.Widget#_onSystemNavigate
see Help4.widget.tour.Observer#onElementEvent

Type:

number

Source:

widget/tour/Widget.js, line 73

Methods

(protected) ____defineDataFunctions()

Overrides:

Help4.widget.Widget#____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.widget.Widget#____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.widget.Widget#____defineProperty

Source:

jscore/ControlBase.js, line 408

(protected) ____defineStaticProperties()

auto define all to be cleaned properties

Overrides:

Help4.widget.Widget#____defineStaticProperties

Source:

jscore/Base.js, line 309

Throws:

Error

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

Parameters:

Name	Type	Description
`dest`	Object
`src`	Object

Overrides:

Help4.widget.Widget#____extendParams

Source:

jscore/ControlBase.js, line 321

Returns:

Type: Object

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

Overrides:

Help4.widget.Widget#____getClassConfig

Source:

jscore/Base.js, line 249

Returns:

Type: Help4.jscore.Base.Params

(protected) ____getData() → {Object}

Overrides:

Help4.widget.Widget#____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.widget.Widget#____mergeDerivedParams

Source:

jscore/Base.js, line 279

Throws:

Error

(protected) ____resolveDerivedParams(classConfig)

Parameters:

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

Overrides:

Help4.widget.Widget#____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.widget.Widget#____setInitValue

Source:

jscore/ControlBase.js, line 455

(protected) _cleanInfobar()

Overrides:

Help4.widget.Widget#_cleanInfobar

Source:

widget/Widget.js, line 683

(protected) _destroyControl(…keys)

destroys class properties

Parameters:

Name	Type	Attributes	Description
`keys`	string	<repeatable>

Overrides:

Help4.widget.Widget#_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.widget.Widget#_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.widget.Widget#_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.widget.Widget#_fireEventSync

Source:

jscore/Base.js, line 220

Returns:

Type: Array.<Help4.EmbeddedEvent.EventResponse>

(protected) _fulltextMatchesHtml(fulltext, html) → {boolean}

for use with filter: checks whether the given fulltext matches a HTML

Parameters:

Name	Type	Description
`fulltext`	string
`html`	string

Overrides:

Help4.widget.Widget#_fulltextMatchesHtml

Source:

widget/Widget.js, line 422

Returns:

Type: boolean

(protected) _fulltextMatchesText(fulltext, text) → {boolean}

for use with filter: checks whether the given fulltext matches a text

Parameters:

Name	Type	Description
`fulltext`	string
`text`	string

Overrides:

Help4.widget.Widget#_fulltextMatchesText

Source:

widget/Widget.js, line 411

Returns:

Type: boolean

(async, protected) _onAfterActivate(dataopt) → {Promise.<void>}

Parameters:

Name	Type	Attributes	Default	Description
`data`	Object	<optional>	null

Overrides:

Help4.widget.Widget#_onAfterActivate

Source:

widget/tour/Widget.js, line 162

Returns:

Type: Promise.<void>

(async, protected) _onAfterDeactivate(dataopt) → {Promise.<void>}

Parameters:

Name	Type	Attributes	Default	Description
`data`	*	<optional>	null

Overrides:

Help4.widget.Widget#_onAfterDeactivate

Source:

widget/Widget.js, line 240

Returns:

Type: Promise.<void>

(async, protected) _onAfterDestroy() → {Promise.<void>}

Overrides:

Help4.widget.Widget#_onAfterDestroy

Source:

widget/Widget.js, line 196

Returns:

Type: Promise.<void>

(async, protected) _onAfterInit() → {Promise.<void>}

Overrides:

Help4.widget.Widget#_onAfterInit

Source:

widget/Widget.js, line 186

Returns:

Type: Promise.<void>

(async, protected) _onAfterStart() → {Promise.<void>}

Overrides:

Help4.widget.Widget#_onAfterStart

Source:

widget/Widget.js, line 206

Returns:

Type: Promise.<void>

(async, protected) _onAfterStop() → {Promise.<void>}

Overrides:

Help4.widget.Widget#_onAfterStop

Source:

widget/Widget.js, line 216

Returns:

Type: Promise.<void>

(async, protected) _onBeforeActivate(dataopt) → {Promise.<(boolean|void)>}

Parameters:

Name	Type	Attributes	Default	Description
`data`	Object	<optional>	null

Overrides:

Help4.widget.Widget#_onBeforeActivate

Source:

widget/Widget.js, line 222

Returns:

Type: Promise.<(boolean|void)>

(async, protected) _onBeforeDeactivate(dataopt) → {Promise.<(boolean|void)>}

Parameters:

Name	Type	Attributes	Default	Description
`data`	*	<optional>	null

Overrides:

Help4.widget.Widget#_onBeforeDeactivate

Source:

widget/tour/Widget.js, line 178

Returns:

Type: Promise.<(boolean|void)>

(async, protected) _onBeforeDestroy() → {Promise.<(boolean|void)>}

Overrides:

Help4.widget.Widget#_onBeforeDestroy

Source:

widget/Widget.js, line 191

Returns:

Type: Promise.<(boolean|void)>

(async, protected) _onBeforeInit() → {Promise.<(boolean|void)>}

Overrides:

Help4.widget.Widget#_onBeforeInit

Source:

widget/Widget.js, line 181

Returns:

Type: Promise.<(boolean|void)>

(async, protected) _onBeforeStart() → {Promise.<(boolean|void)>}

Overrides:

Help4.widget.Widget#_onBeforeStart

Source:

widget/Widget.js, line 201

Returns:

Type: Promise.<(boolean|void)>

(async, protected) _onBeforeStop() → {Promise.<(boolean|void)>}

Overrides:

Help4.widget.Widget#_onBeforeStop

Source:

widget/Widget.js, line 211

Returns:

Type: Promise.<(boolean|void)>

(async, protected) _onContextAvailable() → {Promise.<void>}

Overrides:

Help4.widget.Widget#_onContextAvailable

Source:

widget/Widget.js, line 167

Returns:

Type: Promise.<void>

(async, protected) _onControllerClose() → {Promise.<void>}

Overrides:

Help4.widget.Widget#_onControllerClose

Source:

widget/Widget.js, line 255

Returns:

Type: Promise.<void>

(async, protected) _onControllerEditMode(value) → {Promise.<void>}

Parameters:

Name	Type	Description
`value`	boolean

Overrides:

Help4.widget.Widget#_onControllerEditMode

Source:

widget/Widget.js, line 261

Returns:

Type: Promise.<void>

(async, protected) _onControllerOpen() → {Promise.<void>}

Overrides:

Help4.widget.Widget#_onControllerOpen

Source:

widget/Widget.js, line 250

Returns:

Type: Promise.<void>

(async, protected) _onControllerPlaybackActive(value) → {Promise.<void>}

Parameters:

Name	Type	Description
`value`	boolean

Overrides:

Help4.widget.Widget#_onControllerPlaybackActive

Source:

widget/Widget.js, line 267

Returns:

Type: Promise.<void>

(async, protected) _onGetDescriptor() → {Promise.<Help4.widget.Widget.Descriptor>}

Overrides:

Help4.widget.Widget#_onGetDescriptor

Source:

widget/tour/Widget.js, line 104

Throws:

Error

Returns:

Type: Promise.<Help4.widget.Widget.Descriptor>

(async, protected) _onPropertyChange(event) → {Promise.<void>}

Parameters:

Name	Type	Description
`event`	Help4.jscore.ControlBase.PropertyChangeEvent	the change event

Overrides:

Help4.widget.Widget#_onPropertyChange

Source:

widget/Widget.js, line 651

Returns:

Type: Promise.<void>

(async, protected) _onSerialize() → {Promise.<(Help4.widget.Widget.SerializedData|false)>}

Overrides:

Help4.widget.Widget#_onSerialize

Source:

widget/tour/Widget.js, line 210

Returns:

Type: Promise.<(Help4.widget.Widget.SerializedData|false)>

(async, protected) _onSystemNavigate() → {Promise.<void>}

Overrides:

Help4.widget.Widget#_onSystemNavigate

Source:

widget/tour/Widget.js, line 188

Returns:

Type: Promise.<void>

(async, protected) _onWidgetActivate(widget) → {Promise.<void>}

Parameters:

Name	Type	Description
`widget`	Help4.widget.Widget

Overrides:

Help4.widget.Widget#_onWidgetActivate

Source:

widget/Widget.js, line 285

Returns:

Type: Promise.<void>

(async, protected) _onWidgetDeactivate(widget, dataopt) → {Promise.<void>}

Parameters:

Name	Type	Attributes	Description
`widget`	Help4.widget.Widget
`data`	*	<optional>

Overrides:

Help4.widget.Widget#_onWidgetDeactivate

Source:

widget/Widget.js, line 292

Returns:

Type: Promise.<void>

(async, protected) _onWidgetInvisible(widget) → {Promise.<void>}

Parameters:

Name	Type	Description
`widget`	Help4.widget.Widget

Overrides:

Help4.widget.Widget#_onWidgetInvisible

Source:

widget/Widget.js, line 304

Returns:

Type: Promise.<void>

(async, protected) _onWidgetStart(widget) → {Promise.<void>}

Parameters:

Name	Type	Description
`widget`	Help4.widget.Widget

Overrides:

Help4.widget.Widget#_onWidgetStart

Source:

widget/Widget.js, line 273

Returns:

Type: Promise.<void>

(async, protected) _onWidgetStop(widget) → {Promise.<void>}

Parameters:

Name	Type	Description
`widget`	Help4.widget.Widget

Overrides:

Help4.widget.Widget#_onWidgetStop

Source:

widget/Widget.js, line 279

Returns:

Type: Promise.<void>

(async, protected) _onWidgetVisible(widget) → {Promise.<void>}

Parameters:

Name	Type	Description
`widget`	Help4.widget.Widget

Overrides:

Help4.widget.Widget#_onWidgetVisible

Source:

widget/Widget.js, line 298

Returns:

Type: Promise.<void>

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

Parameters:

Name	Type	Attributes	Default	Description
`data`	Object	<optional>	null

Overrides:

Help4.widget.Widget#activate

Source:

widget/Widget.js, line 565

Returns:

Type: Promise.<void>

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.widget.Widget#addListenerSync

Source:

jscore/Base.js, line 116

Returns:

Type: Help4.jscore.Base

awaitActivated() → {Promise.<boolean>}

Overrides:

Help4.widget.Widget#awaitActivated

Source:

widget/Widget.js, line 341

Returns:

Type: Promise.<boolean>

awaitStarted() → {Promise.<boolean>}

Overrides:

Help4.widget.Widget#awaitStarted

Source:

widget/Widget.js, line 329

Returns:

Type: Promise.<boolean>

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

Parameters:

Name	Type	Attributes	Default	Description
`data`	*	<optional>	null

Overrides:

Help4.widget.Widget#deactivate

Source:

widget/Widget.js, line 601

Returns:

Type: Promise.<void>

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

Overrides:

Help4.widget.Widget#destroy

Source:

widget/Widget.js, line 461

Returns:

Type: Promise.<void>

(async) filter(search) → {Promise.<Array.<Help4.widget.Widget.SearchResult>>}

used to retrieve filter results

Parameters:

Name	Type	Description
`search`	Help4.widget.Widget.SearchFilter

Overrides:

Help4.widget.Widget#filter

Source:

widget/Widget.js, line 400

Returns:

Type: Promise.<Array.<Help4.widget.Widget.SearchResult>>

focus()

accessibility: implement to all to focus the current widget

Overrides:

Help4.widget.Widget#focus

Source:

widget/tour/Widget.js, line 133

(async) focusApp() → {Promise.<boolean>}

Source:

widget/tour/Widget.js, line 138

Returns:

Type: Promise.<boolean>

focusListItem(direction)

accessibility: implement to all to focus the list item tile using up/down arrow keys

Parameters:

Name	Type	Description
`direction`	string

Overrides:

Help4.widget.Widget#focusListItem

Source:

widget/Widget.js, line 320

getAutoProgressKeys() → (nullable) {Array.<string>}

Source:

widget/tour/Widget.js, line 183

Returns:

Type: Array.<string>

getContext() → {Help4.widget.tour.Widget.Context}

returns system context

Overrides:

Help4.widget.Widget#getContext

Source:

widget/tour/Widget.js, line 84

Returns:

Type: Help4.widget.tour.Widget.Context

getDescriptor() → {Help4.widget.Widget.Descriptor}

returns widget descriptor

Overrides:

Help4.widget.Widget#getDescriptor

Source:

widget/Widget.js, line 380

Returns:

Type: Help4.widget.Widget.Descriptor

getName() → {string}

Overrides:

Help4.widget.Widget#getName

Source:

widget/tour/Widget.js, line 76

Returns:

unique name of widget

Type: string

(async) getTexts() → {Promise.<?Object>}

used to retrieve a list of all visible texts for the current widget

Overrides:

Help4.widget.Widget#getTexts

Source:

widget/tour/Widget.js, line 238

Returns:

Type: Promise.<?Object>

isActive() → {boolean}

returns whether widget is active

Overrides:

Help4.widget.Widget#isActive

Source:

widget/Widget.js, line 372

Returns:

Type: boolean

isDestroyed() → {boolean}

whether instance is destroyed

Overrides:

Help4.widget.Widget#isDestroyed

Source:

jscore/Base.js, line 84

Returns:

Type: boolean

isStarted() → {boolean}

returns whether widget is started

Overrides:

Help4.widget.Widget#isStarted

Source:

widget/Widget.js, line 364

Returns:

Type: boolean

isVisible() → {boolean}

returns whether widget is visible

Overrides:

Help4.widget.Widget#isVisible

Source:

widget/Widget.js, line 356

Returns:

Type: boolean

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

called when each widget should consider to redraw itself

Overrides:

Help4.widget.Widget#redraw

Source:

widget/Widget.js, line 456

Returns:

Type: Promise.<void>

registerPanel(panelnullable)

registers the panel instance within this widget

Parameters:

Name	Type	Attributes	Description
`panel`	Help4.control2.bubble.Panel	<nullable>

Overrides:

Help4.widget.Widget#registerPanel

Source:

widget/Widget.js, line 443

(async) serialize() → {Promise.<(Help4.widget.Widget.SerializedStatus|false)>}

Overrides:

Help4.widget.Widget#serialize

Source:

widget/Widget.js, line 629

Returns:

Type: Promise.<(Help4.widget.Widget.SerializedStatus|false)>

setAutoStartTour(alias)

is called in case an autostart tour is configured and not yet played

Parameters:

Name	Type	Description
`alias`	string

Source:

widget/tour/Widget.js, line 224

(async) setTexts(texts) → {Promise.<void>}

used to replace all visible texts for the current widget

Parameters:

Name	Type	Description
`texts`	Object

Overrides:

Help4.widget.Widget#setTexts

Source:

widget/tour/Widget.js, line 249

Returns:

Type: Promise.<void>

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

Overrides:

Help4.widget.Widget#start

Source:

widget/Widget.js, line 477

Returns:

Type: Promise.<void>

(async) startTour(status) → {Promise.<void>}

Parameters:

Name	Type	Description
`status`	Help4.widget.tour.Widget.StartStatus

Source:

widget/tour/Widget.js, line 146

Returns:

Type: Promise.<void>

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

Parameters:

Name	Type	Attributes	Default	Description
`force`	boolean	<optional>	false

Overrides:

Help4.widget.Widget#stop

Source:

widget/Widget.js, line 538

Returns:

Type: Promise.<void>

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

Source:

widget/tour/Widget.js, line 156

Returns:

Type: Promise.<void>

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

Overrides:

Help4.widget.Widget#updateData

Source:

widget/Widget.js, line 323

Returns:

Type: Promise.<void>

vetoNavigation(screenId) → {boolean}

Parameters:

Name	Type	Description
`screenId`	string

Source:

widget/tour/Widget.js, line 233

Returns:

Type: boolean

Type Definitions

AutoStartInfo

Type:

Object

Properties:

Name	Type	Attributes
`project`	Help4.widget.help.Project	<nullable>
`catalogueKey`	Help4.widget.help.CatalogueKeys	<optional>
`alias`	string	<optional>

Source:

widget/tour/Widget.js, line 22

Context

Type:

Help4.widget.Widget.Context

Properties:

Name Type Description

widget.help

Object

Properties

Name	Type	Description
`data`	Help4.widget.help.Data

widget.tour

Object

Properties

Name	Type	Description
`View`	Help4.widget.tour.View

Source:

widget/tour/Widget.js, line 33

SerializedStatus

Type:

Help4.widget.Widget.SerializedStatus

Properties:

Name	Type	Description
`full.data`	Help4.widget.tour.View.SerializedStatus

Source:

widget/tour/Widget.js, line 8

StartStatus

Type:

Object

Properties:

Name	Type	Attributes
`projectId`	string
`catalogueKey`	Help4.widget.help.CatalogueKeys
`catalogueType`	Help4.widget.help.CatalogueTypes
`dataType`	Help4.widget.help.DataTypes
`whatsnew`	boolean	<optional>

Source:

widget/tour/Widget.js, line 13

Class: Widget

Constructor

new Widget()

Properties:

Extends

Members

(static) NAVIGATE_WAIT_TIME :number

Type:

Methods

(protected) ____defineDataFunctions()

(protected) ____defineProperties(params, derivedopt, nullable)

Parameters:

Properties

(protected) ____defineProperty(args)

Parameters:

Properties

(protected) ____defineStaticProperties()

Throws:

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

Parameters:

Returns:

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

Returns:

(protected) ____getData() → {Object}

Returns:

(protected) ____mergeDerivedParams(level0, level1)

Parameters:

Throws:

(protected) ____resolveDerivedParams(classConfig)

Parameters:

(protected) ____setInitValue(args)

Parameters:

Properties

(protected) _cleanInfobar()

(protected) _destroyControl(…keys)

Parameters:

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

Parameters:

Returns:

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

Parameters:

Returns:

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

Parameters:

Returns:

(protected) _fulltextMatchesHtml(fulltext, html) → {boolean}

Parameters:

Returns:

(protected) _fulltextMatchesText(fulltext, text) → {boolean}

Parameters:

Returns:

(async, protected) _onAfterActivate(dataopt) → {Promise.<void>}

Parameters:

Returns:

(async, protected) _onAfterDeactivate(dataopt) → {Promise.<void>}

Parameters:

Returns:

(async, protected) _onAfterDestroy() → {Promise.<void>}

Returns:

(async, protected) _onAfterInit() → {Promise.<void>}

Returns:

(async, protected) _onAfterStart() → {Promise.<void>}

Returns:

(async, protected) _onAfterStop() → {Promise.<void>}

Returns:

(async, protected) _onBeforeActivate(dataopt) → {Promise.<(boolean|void)>}

Parameters:

Returns:

(async, protected) _onBeforeDeactivate(dataopt) → {Promise.<(boolean|void)>}

Parameters:

Returns:

(async, protected) _onBeforeDestroy() → {Promise.<(boolean|void)>}

Returns:

(async, protected) _onBeforeInit() → {Promise.<(boolean|void)>}

Returns:

(async, protected) _onBeforeStart() → {Promise.<(boolean|void)>}

Returns:

(async, protected) _onBeforeStop() → {Promise.<(boolean|void)>}

Returns:

(async, protected) _onContextAvailable() → {Promise.<void>}