Class: Widget

Help4.widget.whatsnew.Widget()

SEN What's New functionality widget

Constructor

new Widget()

Properties:
Name Type Description
_domRefreshExecutor function
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
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:
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

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

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

(protected) ____getData() → {Object}

Overrides:
Source:
Returns:
Type
Object

(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) ____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:
Source:

(protected) _cleanInfobar()

Overrides:
Source:

(async, protected) _createView2(statusnullable, dataopt, paramsopt) → {Promise.<void>}

Parameters:
Name Type Attributes Default Description
status Help4.widget.help.view2.SerializedStatus <nullable>
data Object <optional>
 null
params Object <optional>
 {}
Properties
Name Type Attributes Description
stealth boolean <optional>
Overrides:
Source:
Returns:
Type
Promise.<void>

(protected) _destroyControl(…keys)

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

(protected) _destroyView2()

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>

(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

(protected) _getView2Status() → (nullable) {Help4.widget.help.view2.SerializedStatus}

Overrides:
Source:
Returns:
Type
Help4.widget.help.view2.SerializedStatus

(async, protected) _hasData() → {Promise.<boolean>}

Overrides:
Source:
Returns:
Type
Promise.<boolean>

(protected) _isView2Visible(dataopt) → {Object}

Parameters:
Name Type Attributes Default Description
data * <optional>
 null
Overrides:
Source:
Returns:
Type
Object

(async, protected) _onAfterDestroy() → {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) _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) _onPropertyChange(event) → {Promise.<void>}

Parameters:
Name Type Description
event Help4.jscore.ControlBase.PropertyChangeEvent the change event
Overrides:
Source:
Returns:
Type
Promise.<void>

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

Parameters:
Name Type Description
widget Help4.widget.Widget
Overrides:
Source:
Returns:
Type
Promise.<void>

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

Parameters:
Name Type Description
widget Help4.widget.Widget
Overrides:
Source:
Returns:
Type
Promise.<void>

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

Parameters:
Name Type Description
widget Help4.widget.Widget
Overrides:
Source:
Returns:
Type
Promise.<void>

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

Parameters:
Name Type Description
widget Help4.widget.Widget
Overrides:
Source:
Returns:
Type
Promise.<void>

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

Overrides:
Source:
Returns:
Type
Promise.<void>

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

Parameters:
Name Type Description
data Help4.widget.help.TileDescriptor
Overrides:
Source:
Returns:
Type
Promise.<void>

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

Parameters:
Name Type Attributes Default Description
data Help4.widget.help.Widget.UpdateView2Params <optional>
<nullable>
 null
Overrides:
Source:
Returns:
Type
Promise.<void>

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

Parameters:
Name Type Description
stealth boolean
Overrides:
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
Overrides:
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>

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

returns widget descriptor
Overrides:
Source:
Returns:
Type
Help4.widget.Widget.Descriptor

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

registerPanel(panelnullable)

registers the panel instance within this widget
Parameters:
Name Type Attributes Description
panel Help4.control2.bubble.Panel <nullable>
Overrides:
Source:

selectTile(data)

Parameters:
Name Type Description
data Help4.widget.help.TileDescriptor
Overrides:
Source:

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

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

showQuickTour()

shows quick tour, if available
Overrides:
Source:

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

Overrides:
Source:
Returns:
Type
Promise.<void>

(async) startFromFilter(data) → {Promise.<void>}

Parameters:
Name Type Description
data Help4.widget.help.TileDescriptor
Overrides:
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.whatsnew Object
Properties
Name Type Description
data Help4.widget.whatsnew.Data
Source: