Class: WindowObserver

Help4.observer.WindowObserver(callback)

observes windows using other observers: MutationObserver, EventObserver, FocusObserver

Constructor

new WindowObserver(callback)

Parameters:
Name Type Description
callback Help4.observer.Callback
Source:

Extends

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

count() → {number}

returns the number of active connections
Overrides:
Source:
Returns:
Type
number

destroy()

destroys the observer
Overrides:
Source:

disconnect() → {Help4.observer.WindowObserver}

stops all observations
Overrides:
Source:
Returns:
Type
Help4.observer.WindowObserver

isDestroyed() → {boolean}

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

observe(target, options) → {Help4.observer.WindowObserver}

observes one window
Parameters:
Name Type Description
target Window the to-be-observed window
options Help4.observer.WindowObserver.Options configuration
Overrides:
Source:
Returns:
Type
Help4.observer.WindowObserver

observeAll(options, targetsopt) → {Help4.observer.WindowObserver}

observes all accessible windows: same window, same-origin windows, nested same-origin windows, cross-origin windows with Agent
Parameters:
Name Type Attributes Description
options Help4.observer.WindowObserver.OptionsAll
targets Array.<Window> <optional>
Source:
Returns:
Type
Help4.observer.WindowObserver

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

Type Definitions

Options

options for WindowObserver.observe
Type:
  • Object
Properties:
Name Type Attributes Description
mutationObserver Object <optional>
 configuration for the MutationObserver
eventObserver Object <optional>
 configuration for the EventObserver
focusObserver Object <optional>
 configuration for the FocusObserver
Source:

OptionsAll

options for WindowObserver.observeAll
Type:
Properties:
Name Type Attributes Default Description
crossOrigin boolean <optional>
 false observe cross-origin windows with Agent
Source: