Constructor
Parameters:
Properties:
- Source:
Extends
Methods
(protected) ____defineDataFunctions()
- Overrides:
- Source:
(protected) ____defineProperties(params, derivedopt, nullable)
Parameters:
Name |
Type |
Attributes |
Default |
Description |
params |
Object
|
|
|
|
derived |
Object
|
<optional>
<nullable>
|
null
|
Properties
Name |
Type |
Description |
GET |
Object
|
|
SET |
Object
|
|
|
- Overrides:
- Source:
(protected) ____defineProperty(args)
Parameters:
Name |
Type |
Description |
args |
Object
|
Properties
|
- Overrides:
- Source:
(protected) ____defineStaticProperties()
auto define all to be cleaned properties
- Overrides:
- Source:
Throws:
Error
(protected) ____extendParams(dest, src) → {Object}
Parameters:
Name |
Type |
Description |
dest |
Object
|
|
src |
Object
|
|
- Overrides:
- Source:
Returns:
-
Type
-
Object
- Overrides:
- Source:
Returns:
-
Type
-
Help4.jscore.Base.Params
(protected) ____getData() → {Object}
- Overrides:
- Source:
Returns:
-
Type
-
Object
(protected) ____mergeDerivedParams(level0, level1)
Parameters:
- Overrides:
- Source:
Throws:
Error
(protected) ____resolveDerivedParams(classConfig)
Parameters:
- Overrides:
- Source:
(protected) ____setInitValue(args)
Parameters:
Name |
Type |
Description |
args |
Object
|
Properties
|
- Overrides:
- Source:
(protected) _cleanInfobar()
- Overrides:
- Source:
(async, protected) _createView2(statusnullable, dataopt, nullable, paramsopt) → {Promise.<void>}
Parameters:
- Source:
Returns:
-
Type
-
Promise.<void>
(protected) _destroyControl(…keys)
destroys class properties
Parameters:
Name |
Type |
Attributes |
Description |
keys |
string
|
<repeatable>
|
|
- Overrides:
- Source:
(protected) _destroyView2()
- Source:
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
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>>
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>
(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:
- Source:
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:
- Source:
Returns:
-
Type
-
boolean
- Source:
Returns:
-
Type
-
Help4.widget.help.view2.SerializedStatus
(async, protected) _hasData() → {Promise.<boolean>}
- Source:
Returns:
-
Type
-
Promise.<boolean>
(protected) _isView2Visible(dataopt, nullable) → {Object}
Parameters:
- Source:
Returns:
-
Type
-
Object
(async, protected) _onAfterActivate(dataopt, nullable) → {Promise.<void>}
Parameters:
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _onAfterDeactivate(dataopt, nullable) → {Promise.<void>}
Parameters:
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _onAfterDestroy() → {Promise.<void>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _onAfterInit() → {Promise.<void>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _onAfterStart() → {Promise.<void>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _onAfterStop() → {Promise.<void>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _onBeforeActivate(dataopt) → {Promise.<(boolean|void)>}
Parameters:
Name |
Type |
Attributes |
Default |
Description |
data |
Object
|
<optional>
|
null
|
|
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<(boolean|void)>
(async, protected) _onBeforeDeactivate(dataopt) → {Promise.<(boolean|void)>}
Parameters:
Name |
Type |
Attributes |
Default |
Description |
data |
*
|
<optional>
|
null
|
|
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<(boolean|void)>
(async, protected) _onBeforeDestroy() → {Promise.<(boolean|void)>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<(boolean|void)>
(async, protected) _onBeforeInit() → {Promise.<(boolean|void)>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<(boolean|void)>
(async, protected) _onBeforeStart() → {Promise.<(boolean|void)>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<(boolean|void)>
(async, protected) _onBeforeStop() → {Promise.<(boolean|void)>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<(boolean|void)>
(async, protected) _onContextAvailable() → {Promise.<void>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _onControllerClose() → {Promise.<void>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _onControllerEditMode(value) → {Promise.<void>}
Parameters:
Name |
Type |
Description |
value |
boolean
|
|
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _onControllerOpen() → {Promise.<void>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _onControllerPlaybackActive(value) → {Promise.<void>}
Parameters:
Name |
Type |
Description |
value |
boolean
|
|
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
- Overrides:
- Source:
Throws:
Error
Returns:
-
Type
-
Promise.<Help4.widget.Widget.Descriptor>
(async, protected) _onPropertyChange(event) → {Promise.<void>}
Parameters:
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<(Help4.widget.Widget.SerializedData|false)>
(async, protected) _onSystemNavigate() → {Promise.<void>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
Parameters:
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
Parameters:
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
Parameters:
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
Parameters:
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
Parameters:
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
Parameters:
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _setVisible() → {Promise.<void>}
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _trackProject(data, tilesopt) → {Promise.<void>}
Parameters:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _updateView2(dataopt, nullable) → {Promise.<void>}
Parameters:
- Source:
Returns:
-
Type
-
Promise.<void>
(async, protected) _view2Stealth(stealth) → {Promise.<void>}
Parameters:
Name |
Type |
Description |
stealth |
boolean
|
|
- Source:
Returns:
-
Type
-
Promise.<void>
(async) activate(dataopt) → {Promise.<void>}
Parameters:
Name |
Type |
Attributes |
Default |
Description |
data |
Object
|
<optional>
|
null
|
|
- Overrides:
- Source:
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:
- Source:
Returns:
-
Type
-
Help4.jscore.Base
awaitActivated() → {Promise.<boolean>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<boolean>
awaitStarted() → {Promise.<boolean>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<boolean>
closeLightbox()
closes an open lightbox
see Help4.receiveMessage
- Source:
(async) deactivate(dataopt) → {Promise.<void>}
Parameters:
Name |
Type |
Attributes |
Default |
Description |
data |
*
|
<optional>
|
null
|
|
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async) destroy() → {Promise.<void>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
used to retrieve filter results
Parameters:
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<Array.<Help4.widget.Widget.SearchResult>>
focus()
accessibility: implement to all to focus the current widget
- Overrides:
- Source:
focusListItem(direction)
accessibility: implement to all to focus the list item tile using up/down arrow keys
Parameters:
Name |
Type |
Description |
direction |
string
|
|
- Overrides:
- Source:
returns system context
- Overrides:
- Source:
Returns:
-
Type
-
Help4.widget.help.Widget.Context
returns widget descriptor
- Overrides:
- Source:
Returns:
-
Type
-
Help4.widget.Widget.Descriptor
getName() → {string}
- Overrides:
- Source:
Returns:
unique name of widget
-
Type
-
string
(async) getTexts() → {Promise.<{panel: (?Object|undefined), content: ?Object}>}
used to retrieve a list of all visible texts for the current widget
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<{panel: (?Object|undefined), content: ?Object}>
isActive() → {boolean}
returns whether widget is active
- Overrides:
- Source:
Returns:
-
Type
-
boolean
isDestroyed() → {boolean}
whether instance is destroyed
- Overrides:
- Source:
Returns:
-
Type
-
boolean
isStarted() → {boolean}
returns whether widget is started
- Overrides:
- Source:
Returns:
-
Type
-
boolean
isVisible() → {boolean}
returns whether widget is visible
- Overrides:
- Source:
Returns:
-
Type
-
boolean
(async) redraw() → {Promise.<void>}
called when each widget should consider to redraw itself
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
registerPanel(panelnullable)
registers the panel instance within this widget
Parameters:
- Overrides:
- Source:
selectTile(data)
Parameters:
- Source:
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<(Help4.widget.Widget.SerializedStatus|false)>
(async) setTexts(texts) → {Promise.<void>}
used to replace all visible texts for the current widget
Parameters:
Name |
Type |
Description |
texts |
Object
|
|
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
showQuickTour()
shows quick tour, if available
- Source:
(async) start() → {Promise.<void>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async) startFromFilter(data) → {Promise.<void>}
Parameters:
- Source:
Returns:
-
Type
-
Promise.<void>
(async) stop(forceopt) → {Promise.<void>}
Parameters:
Name |
Type |
Attributes |
Default |
Description |
force |
boolean
|
<optional>
|
false
|
|
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
(async) updateData() → {Promise.<void>}
- Overrides:
- Source:
Returns:
-
Type
-
Promise.<void>
Type Definitions
Context
Type:
Properties:
Name |
Type |
Description |
widget.help |
Object
|
Properties
|
- Source:
SerializedStatus
Type:
Properties:
Name |
Type |
Description |
full.data |
Object
|
Properties
|
interaction.data |
Object
|
Properties
|
- Source:
Sources
Type:
- Source:
UpdateView2Params
Type:
Properties:
- Source: