Class WorkerHandler<N, T, D>

The main WorkerHandler class

Type Parameters

N
The HTMLElement node class
T
The Text node class
D
The Document class

Index

Constructors

constructor

new WorkerHandler<N, T, D>(
adaptor: DOMAdaptor<N, T, D>,
options: OptionList,
): WorkerHandler<N, T, D>
The adaptor to work with typeset nodes.
Type Parameters
- N
- T
- D
Parameters
- adaptor: DOMAdaptor<N, T, D>
  The adaptor to use for DOM access.
- options: OptionList
  The worker options.
Returns WorkerHandler<N, T, D>
- Defined in ts/a11y/speech/WebWorker.ts:71

Properties

adaptor

adaptor: DOMAdaptor<N, T, D>

The adaptor to use for DOM access.

Commands

Commands: {
[id: string]: (handler: WorkerHandler<N, T, D>, data: Message) => void;
} = ...

The list of valid commands from the Worker.

ready

ready: boolean = false

Callback for ready signal

`Protected`worker

worker: minWorker

The webworker

Methods

Attach

Attach(
    item: SpeechMathItem<N, T, D>,
    speech: boolean,
    braille: boolean,
    structure: string,
): void
Attach the speech structure to an item's DOM
Parameters
- item: SpeechMathItem<N, T, D>
  The SpeechMathItem to attach to
- speech: boolean
  True when speech should be added
- braille: boolean
  True when Braille should be added
- structure: string
  The speech JSON structure to attach
Returns void
- Defined in ts/a11y/speech/WebWorker.ts:284

Cancel

Cancel(item: SpeechMathItem<N, T, D>): void
Remove a task from the task list.
Parameters
- item: SpeechMathItem<N, T, D>
  The item whose task is to be canceled.
Returns void
- Defined in ts/a11y/speech/WebWorker.ts:155

clearspeakLocalePreferences

clearspeakLocalePreferences(
options: OptionList,
prefs: Map<string, { [prop: string]: string[] }>,
): Promise<void>
Worker call to compute clearspeak preferences for the current locale.
Parameters
- options: OptionList
  The options list.
- prefs: Map<string, { [prop: string]: string[] }>
  Map to store the compute preferences.
Returns Promise<void>
The promise that resolves when the command is complete
- Defined in ts/a11y/speech/WebWorker.ts:504

clearspeakRelevantPreferences

clearspeakRelevantPreferences(
    math: string,
    nodeId: string,
    prefs: Map<number, string>,
    counter: number,
): Promise<void>
Computes the clearspeak preference category that are semantically relevant for the currently focused node.
Parameters
- math: string
  The linearized mml expression.
- nodeId: string
  The semantic id of node to compute the preference for.
- prefs: Map<number, string>
  Map for recording the computed preference.
- counter: number
  Counter for storing the result in the map.
Returns Promise<void>
The promise that resolves when the command is complete
- Defined in ts/a11y/speech/WebWorker.ts:528

Detach

Detach(item: SpeechMathItem<N, T, D>): void
Remove speech attributes from a MathItem
Parameters
- item: SpeechMathItem<N, T, D>
  The MathItem whose speech attributes should be removed.
Returns void
- Defined in ts/a11y/speech/WebWorker.ts:436

detachSpeech

detachSpeech(node: N): void
Recursively remove speech attributes from a DOM tree
Parameters
- node: N
  The root node of the tree to modify
Returns void
- Defined in ts/a11y/speech/WebWorker.ts:448

Listener

Listener(event: MessageEvent): void
Listener for the messages from the worker. The message will contain a command and data, and we look in the list of commands to see if we have an implementation for the given one. If so, we run the command on the data from the message, otherwise we throw an error.
Parameters
- event: MessageEvent
  The message event.
Returns void
- Defined in ts/a11y/speech/WebWorker.ts:108

nextRules

nextRules(
    math: string,
    options: OptionList,
    item: SpeechMathItem<N, T, D>,
): Promise<void>
Computes the next rule set for this particular SRE setting. We assume that the engine has been set to the options of the current expression.
Parameters
- math: string
  The mml string.
- options: OptionList
  The options list.
- item: SpeechMathItem<N, T, D>
  The mathitem for reattaching the speech.
Returns Promise<void>
A promise that resolves when the command completes
- Defined in ts/a11y/speech/WebWorker.ts:217

nextStyle

nextStyle(
    math: string,
    options: OptionList,
    nodeId: string,
    item: SpeechMathItem<N, T, D>,
): Promise<void>
Computes the next style for the particular SRE settings and the currently focused node. We pass the options of the current expression.

Note, that we compute not only the next style but also the next speech structure in the method, as smart computation is done wrt. the semantic node, and we do not want to reconstruct the semantic XML tree on the SRE side twice. Hence we pass the math expression, plus the semantic ID of the currently focused node.
Parameters
- math: string
  The linearized mml expression.
- options: OptionList
  The options list.
- nodeId: string
  The semantic Id of the currenctly focused node.
- item: SpeechMathItem<N, T, D>
  The mathitem for reattaching the speech.
Returns Promise<void>
A promise that resolves when the command completes
- Defined in ts/a11y/speech/WebWorker.ts:252

Post

Post(msg: ClientCommand, item?: SpeechMathItem<N, T, D>): Promise<any>
Send messages to the worker.
Parameters
- msg: ClientCommand
  The command message.
- Optionalitem: SpeechMathItem<N, T, D>
  Optional SpeechMathItem that is being processed command name as input.
Returns Promise<any>
A promise that resolves when the command completes
- Defined in ts/a11y/speech/WebWorker.ts:125

`Protected`setSpecialAttributes

setSpecialAttributes(
    node: N,
    map: OptionList,
    prefix: string,
    keys?: string[],
): void
Adds a set of attributes to the given node.
Parameters
- node: N
  The node on which to set attributes.
- map: OptionList
  The attribute to value map.
- prefix: string
  A possible prefix for the attribute name.
- Optionalkeys: string[]
  An optional list to select only those attributes.
Returns void
- Defined in ts/a11y/speech/WebWorker.ts:415

`Protected`setSpeechAttribute

setSpeechAttribute(
    node: N,
    data: Structure,
    speech: boolean,
    braille: boolean,
): void
Add the speech attributes to a node
Parameters
- node: N
  The node to add speech to
- data: Structure
  The speech data to use
- speech: boolean
  True when speech should be added
- braille: boolean
  True when Braille should be added
Returns void
- Defined in ts/a11y/speech/WebWorker.ts:345

`Protected`setSpeechAttributes

setSpeechAttributes(
    root: N | T,
    rootId: string,
    data: Structure,
    speech: boolean,
    braille: boolean,
): string
Add the speech attributes to a node's DOM tree
Parameters
- root: N | T
  The node to add speech to
- rootId: string
  The root nodes's ID
- data: Structure
  The speech data to use
- speech: boolean
  True when speech should be added
- braille: boolean
  True when Braille should be added
Returns string
The updated root ID
- Defined in ts/a11y/speech/WebWorker.ts:379

Setup

Setup(options: OptionList): Promise<void>
Setup the engine in the SRE worker.
Parameters
- options: OptionList
  The options list.
Returns Promise<void>
A promise that resolves when the command completes
- Defined in ts/a11y/speech/WebWorker.ts:169

Speech

Speech(
    math: string,
    options: OptionList,
    item: SpeechMathItem<N, T, D>,
): Promise<void>
Compute speech structure for the math.
Parameters
- math: string
  The mml string.
- options: OptionList
  The options list.
- item: SpeechMathItem<N, T, D>
  The mathitem for reattaching the speech.
Returns Promise<void>
A promise that resolves when the command completes
- Defined in ts/a11y/speech/WebWorker.ts:189

Start

Start(): Promise<void>
This starts the worker.

Returns Promise<void>
- Defined in ts/a11y/speech/WebWorker.ts:79

Stop

Stop(): void
Stop the worker and clear the values so that the worker can be restarted, if desired.

Returns void
- Defined in ts/a11y/speech/WebWorker.ts:488

Terminate

Terminate(): void
Terminates the worker.

Returns void
- Defined in ts/a11y/speech/WebWorker.ts:472

Class WorkerHandler<N, T, D>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WorkerHandler<N, T, D>

Properties

adaptor

Commands

ready

Protectedworker

Methods

Attach

Parameters

Returns void

Cancel

Parameters

Returns void

clearspeakLocalePreferences

Parameters

Returns Promise<void>

clearspeakRelevantPreferences

Parameters

Returns Promise<void>

Detach

Parameters

Returns void

detachSpeech

Parameters

Returns void

Listener

Parameters

Returns void

nextRules

Parameters

Returns Promise<void>

nextStyle

Parameters

Returns Promise<void>

Post

Parameters

Returns Promise<any>

ProtectedsetSpecialAttributes

Parameters

Returns void

ProtectedsetSpeechAttribute

Parameters

Returns void

ProtectedsetSpeechAttributes

Parameters

Returns string

Setup

Parameters

Returns Promise<void>

Speech

Parameters

Returns Promise<void>

Start

Returns Promise<void>

Stop

Returns void

Terminate

Returns void

Settings

On This Page

`Protected`worker

`Protected`setSpecialAttributes

`Protected`setSpeechAttribute

`Protected`setSpeechAttributes