Namespace: widget

Help4.widget

Source:

Classes

Infrastructure
Requirement
Widget

Namespaces

bpm
companionCore
filter
help
learning
monitor
tour
tourlist
whatsnew

Members

(static) COLOR :string

color definition; values to-be-defined in LESS
Type:
  • string
Properties:
Name Type Description
color1 string
color2 string
color3 string
color4 string
color5 string
color6 string
color7 string
color8 string
Source:

(static) INSTANCES :Array.<Help4.widget.Widget>

Type:
Source:

(static) POSITION :string

Type:
  • string
Properties:
Name Type Description
panel string
lightbox string
tab string
Source:

(static) TRACK_STATUS :Object

Type:
  • Object
Source:

Methods

(static) assertSingleton(name)

throws an error that an instance of the same widget already exists
Parameters:
Name Type Description
name string widget namespace
Source:
Throws:
Error

(static) awaitAll(executor, modeopt) → {Promise.<Object>}

Parameters:
Name Type Attributes Default Description
executor Help4.widget.AwaitAllExecutor
mode 'parallel' | 'sequential' <optional>
 'parallel'
Source:
Returns:
Type
Promise.<Object>

(static) create(name) → {Help4.widget.Widget}

creates a widget of a certain namespace
Parameters:
Name Type Description
name string widget namespace
Source:
Throws:
Error
Returns:
Type
Help4.widget.Widget

(generator, static) entries() → {Array.<number, Help4.widget.Widget>}

for (const [index, widgetInstance] of Help4.widget.entries()) { ... }
Source:
Yields:
Type
Array.<number, Help4.widget.Widget>

(static) focusApp()

sets focus to the application; this works very unspecific and sets focus to the first or <>button> or that is found on the page
Source:

(static) focusHelp4()

sets focus to the Help4 framework
Source:

(static) focusListItem(key)

sets the focus to next item in the list - arrow keys
Parameters:
Name Type Description
key string
Source:

(static) forEach(executor)

Help4.widget.forEach(widgetInstance => ...)
Parameters:
Name Type Description
executor Help4.typedef.ForEachExecutor
Source:

(static) getActiveElement() → {HTMLElement}

gets the currently focussed element from the CMP4 shadow dom
Source:
Returns:
Type
HTMLElement

(static) getActiveInstance() → (nullable) {Help4.widget.Widget}

delivers the active widget instance
Source:
Returns:
Type
Help4.widget.Widget

(static) getInstance(names) → {Help4.widget.Widget|null|Object}

get the widget instance of a certain namespace
Parameters:
Name Type Description
names string widget namespace(s)
Source:
Returns:
Type
Help4.widget.Widget | null | Object

(static) getTexts() → {Promise.<Object>}

used to retrieve a list of all visible texts for all widgets
Source:
Returns:
Type
Promise.<Object>

(static) redrawAll() → {Promise.<void>}

redraws all existing widgets
Source:
Returns:
Type
Promise.<void>

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

used to replace all visible texts for all widgets
Parameters:
Name Type Description
texts Object
Source:
Returns:
Type
Promise.<void>

(static) trackOpenClose(widget, params) → {Promise.<void>}

Parameters:
Name Type Description
widget Help4.widget.Widget
params Help4.tracking.Tracking.TrackParams
Source:
Returns:
Type
Promise.<void>

(static) updateAll() → {Promise.<void>}

updates all existing widgets
Source:
Returns:
Type
Promise.<void>

Type Definitions

AwaitAllExecutor(instance) → {Promise.<*>}

Parameters:
Name Type Description
instance Help4.widget.Widget
Source:
Returns:
Type
Promise.<*>