Class AbstractMouseExplorer<T>`Abstract`

Type Parameters

T
The type that is consumed by the Region of this explorer.

Hierarchy (View Summary)

AbstractExplorer<T>
- AbstractMouseExplorer
  - Hoverer

Implements

MouseExplorer

Index

Constructors

Properties

document events node pool region stoppable

Accessors

active highlighter

Methods

AddEvents Attach Detach Events MouseOut MouseOver RemoveEvents Start Stop stopEvent Update create stopEvent

Constructors

`Protected`constructor

new AbstractMouseExplorer<T>(
    document: A11yDocument,
    pool: ExplorerPool,
    region: Region<T>,
    node: HTMLElement,
    ..._rest: any[],
): AbstractMouseExplorer<T>
Type Parameters
- T
Parameters
- document: A11yDocument
  The current document.
- pool: ExplorerPool
  The explorer pool.
- region: Region<T>
  A region to display results.
- node: HTMLElement
  The node on which the explorer works.
- ..._rest: any[]
  Remaining information.
Returns AbstractMouseExplorer<T>
Inherited from AbstractExplorer.constructor
- Defined in ts/a11y/explorer/Explorer.ts:184

Properties

document

document: A11yDocument

The current document.

`Protected`events

events: [string, (x: Event) => void][] = ...

`Protected`node

node: HTMLElement

The node on which the explorer works.

pool

pool: ExplorerPool

The explorer pool.

region

region: Region<T>

A region to display results.

stoppable

stoppable: boolean = true

Accessors

active

get active(): boolean
Returns boolean
Implementation of MouseExplorer.active
Inherited from AbstractExplorer.active
- Defined in ts/a11y/explorer/Explorer.ts:203
set active(flag: boolean): void
Parameters
- flag: boolean
Returns void
Implementation of MouseExplorer.active
Inherited from AbstractExplorer.active
- Defined in ts/a11y/explorer/Explorer.ts:210

`Protected`highlighter

get highlighter(): Highlighter
Returns Highlighter
The Sre highlighter associated with the walker.
Inherited from AbstractExplorer.highlighter
- Defined in ts/a11y/explorer/Explorer.ts:123

Methods

AddEvents

AddEvents(): void
Returns void
Implementation of MouseExplorer.AddEvents
Inherited from AbstractExplorer.AddEvents
- Defined in ts/a11y/explorer/Explorer.ts:249

Attach

Attach(): void
Returns void
Implementation of MouseExplorer.Attach
Inherited from AbstractExplorer.Attach
- Defined in ts/a11y/explorer/Explorer.ts:217

Detach

Detach(): void
Returns void
Implementation of MouseExplorer.Detach
Inherited from AbstractExplorer.Detach
- Defined in ts/a11y/explorer/Explorer.ts:224

`Protected`Events

Events(): [string, (x: Event) => void][]
Returns [string, (x: Event) => void][]
The events associated with this explorer.
Inherited from AbstractExplorer.Events
- Defined in ts/a11y/explorer/Explorer.ts:196

MouseOut

MouseOut(_event: MouseEvent): void
Parameters
- _event: MouseEvent
Returns void
Implementation of MouseExplorer.MouseOut
- Defined in ts/a11y/explorer/MouseExplorer.ts:79

MouseOver

MouseOver(_event: MouseEvent): void
Parameters
- _event: MouseEvent
Returns void
Implementation of MouseExplorer.MouseOver
- Defined in ts/a11y/explorer/MouseExplorer.ts:72

RemoveEvents

RemoveEvents(): void
Returns void
Implementation of MouseExplorer.RemoveEvents
Inherited from AbstractExplorer.RemoveEvents
- Defined in ts/a11y/explorer/Explorer.ts:258

Start

Start(): void
Returns void
Implementation of MouseExplorer.Start
Inherited from AbstractExplorer.Start
- Defined in ts/a11y/explorer/Explorer.ts:231

Stop

Stop(): void
Returns void
Implementation of MouseExplorer.Stop
Inherited from AbstractExplorer.Stop
- Defined in ts/a11y/explorer/Explorer.ts:238

`Protected`stopEvent

stopEvent(event: Event): void
Stops the events of this explorer from bubbling.
Parameters
- event: Event
  The event to stop.
Returns void
Inherited from AbstractExplorer.stopEvent
- Defined in ts/a11y/explorer/Explorer.ts:274

Update

Update(_force?: boolean): void
Parameters
- _force: boolean = false
Returns void
Implementation of MouseExplorer.Update
Inherited from AbstractExplorer.Update
- Defined in ts/a11y/explorer/Explorer.ts:267

`Static`create

create<T>(
    document: A11yDocument,
    pool: ExplorerPool,
    region: Region<T>,
    node: HTMLElement,
    ...rest: any[],
): Explorer
Creator pattern for explorers.
Type Parameters
- T
Parameters
- document: A11yDocument
  The current document.
- pool: ExplorerPool
  The explorer pool.
- region: Region<T>
  A region to display results.
- node: HTMLElement
  The node on which the explorer works.
- ...rest: any[]
  Remaining information.
Returns Explorer
An object of the particular explorer class.
Inherited from AbstractExplorer.create
- Defined in ts/a11y/explorer/Explorer.ts:165

`Protected` `Static`stopEvent

stopEvent(event: Event): void
Stops event bubbling.
Parameters
- event: Event
  The event that is stopped.
Returns void
Inherited from AbstractExplorer.stopEvent
- Defined in ts/a11y/explorer/Explorer.ts:139