Class FlameHoverer

Highlights maction nodes on hovering.

Hierarchy (View Summary)

Hoverer<void>
- FlameHoverer

Index

Constructors

Properties

events nodeAccess nodeQuery region stoppable

Accessors

active highlighter

Methods

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

Constructors

`Protected`constructor

new FlameHoverer(
    document: A11yDocument,
    pool: ExplorerPool,
    _ignore: any,
    node: HTMLElement,
): FlameHoverer
Parameters
- document: A11yDocument
- pool: ExplorerPool
- _ignore: any
- node: HTMLElement
Returns FlameHoverer
Overrides Hoverer.constructor
- Defined in ts/a11y/explorer/MouseExplorer.ts:201

Properties

`Protected`events

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

`Protected`nodeAccess

nodeAccess: (node: HTMLElement) => void

Accessor to extract node value that is passed to the region.

`Protected`nodeQuery

nodeQuery: (node: HTMLElement) => boolean

Predicate on nodes that will fire the hoverer.

region

region: Region<void>

A region to display results.

stoppable

stoppable: boolean = true

Accessors

active

get active(): boolean
Returns boolean
Inherited from Hoverer.active
- Defined in ts/a11y/explorer/Explorer.ts:203
set active(flag: boolean): void
Parameters
- flag: boolean
Returns void
Inherited from Hoverer.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 Hoverer.highlighter
- Defined in ts/a11y/explorer/Explorer.ts:123

Methods

AddEvents

AddEvents(): void
Returns void
Inherited from Hoverer.AddEvents
- Defined in ts/a11y/explorer/Explorer.ts:249

Attach

Attach(): void
Returns void
Inherited from Hoverer.Attach
- Defined in ts/a11y/explorer/Explorer.ts:217

Detach

Detach(): void
Returns void
Inherited from Hoverer.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 Hoverer.Events
- Defined in ts/a11y/explorer/Explorer.ts:196

getNode

getNode(node: HTMLElement): [HTMLElement, void]
Retrieves the closest node on which the node query fires. Thereby closest is defined as:
1. The node or its ancestor on which the query is true.
2. In case 1 does not exist the left-most child on which query is true.
3. Otherwise fails.
Parameters
- node: HTMLElement
  The node on which the mouse event fired.
Returns [HTMLElement, void]
Node and output pair if successful.
Inherited from Hoverer.getNode
- Defined in ts/a11y/explorer/MouseExplorer.ts:152

MouseOut

MouseOut(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
Inherited from Hoverer.MouseOut
- Defined in ts/a11y/explorer/MouseExplorer.ts:120

MouseOver

MouseOver(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
Inherited from Hoverer.MouseOver
- Defined in ts/a11y/explorer/MouseExplorer.ts:129

RemoveEvents

RemoveEvents(): void
Returns void
Inherited from Hoverer.RemoveEvents
- Defined in ts/a11y/explorer/Explorer.ts:258

Start

Start(): void
Returns void
Inherited from Hoverer.Start
- Defined in ts/a11y/explorer/Explorer.ts:231

Stop

Stop(): void
Returns void
Inherited from Hoverer.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 Hoverer.stopEvent
- Defined in ts/a11y/explorer/Explorer.ts:274

Update

Update(_force?: boolean): void
Parameters
- _force: boolean = false
Returns void
Inherited from Hoverer.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 Hoverer.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 Hoverer.stopEvent
- Defined in ts/a11y/explorer/Explorer.ts:139