Class: DocumentSupportLoader

document-support-loader~DocumentSupportLoader(streamServerUrlnon-null, withCssSupportnon-null, withTextRendererSupportnon-null)

Provides the functionality necessary to support a wica-aware html page.

Constructor

new DocumentSupportLoader(streamServerUrlnon-null, withCssSupportnon-null, withTextRendererSupportnon-null)

Constructs a new instance to work with the specified Wica Server.
Parameters:
Name Type Default Description
streamServerUrl string The URL of the Wica Server with whom this instance should communicate.
withCssSupport boolean true whether or not to load the CSS file when this class instance is activated. Default is true.
withTextRendererSupport boolean whether or not to enable the wica HTML element text renderer when this class instance is activated. Default is true.

Methods

activate(textRendererRefreshRateopt, eventManagerRefreshRateopt)

Activates support for the current document.
Parameters:
Name Type Attributes Default Description
textRendererRefreshRate number <optional>
100 The rate at which the document's text renderer should run to update the visual state of the document's wica-aware elements.
eventManagerRefreshRate number <optional>
100 The rate at which the document's event manager should run to fire notification events on the state of the document's wica-aware elements.

shutdown()

Shuts down support for the current document.