Class: AccessibleReadingOrderManager

Core. AccessibleReadingOrderManager

A manager class that controls Accessible Reading Order.

new AccessibleReadingOrderManager()

Extends

  • EventHandler

Methods


endAccessibleReadingOrderMode()

Ends Accessible Reading Order Mode.
Returns:
Type
void

getPreProcessingLevel()

Gets the current pre-processing level for the AccessibleReadingOrderManager.
Returns:
Type
number

isInAccessibleReadingOrderMode()

Gets if the Accessible Reading Order Manager is currently in Accessible Reading Order Mode.
Returns:
Type
boolean

isStructuredFile()

Gets if the loaded file is structured.
Returns:
Resolves to a boolean to indicate whether the file is structured or not.
Type
Promise.<boolean>

setPreProcessingLevel(level)

Sets the pre-processing level for the AccessibleReadingOrderManager. The default is 9, meaning that the AccessibleReadingOrderManager will pre-process 9 pages ahead along with the current page.
Parameters:
Name Type Description
level number The number of pages to pre-process ahead of the current page.

startAccessibleReadingOrderMode()

Starts Accessible Reading Order Mode.
Returns:
Resolves after the manager is prepared for start adding the accessible reading order elements to the DOM.
Type
Promise.<void>

Events


accessibleReadingOrderModeEnded

Triggered when Accessible Reading Order Mode is ended.

accessibleReadingOrderModeNoStructure

Triggered when a document without a logical structure is loaded while in Accessible Reading Order mode.

accessibleReadingOrderModeStarted

Triggered when Accessible Reading Order Mode is started.