colibrio-reader-framework/com.colibrio.readingsystem.base/FocusOnReadingPositionOptions

FocusOnReadingPositionOptions

data class FocusOnReadingPositionOptions(val focusOnPageContainer: Boolean = false, val focusOnPageBodyElement: Boolean = false, val focusNearContentLocation: Boolean = false, val focusTargetOptions: FocusOnReadingPositionTargetOptions = FocusOnReadingPositionTargetOptions())

Options related to ReaderView.focusOnReadingPosition() deciding which elements should receive focus.

When multiple properties are set, focus is applied in the following order:

Page container iframe (focusOnPageContainer)
Page body element (focusOnPageBodyElement)
Reading position element (focusTargetOptions.target)

At least one property must be set for any focus action to be performed.

Constructors

FocusOnReadingPositionOptions

constructor(focusOnPageContainer: Boolean = false, focusOnPageBodyElement: Boolean = false, focusNearContentLocation: Boolean = false, focusTargetOptions: FocusOnReadingPositionTargetOptions = FocusOnReadingPositionTargetOptions())

Types

Companion

object Companion

Properties

focusNearContentLocation

val focusNearContentLocation: Boolean = false

If the element or the nearest element matching the content location should be focused.

focusOnPageBodyElement

val focusOnPageBodyElement: Boolean = false

If the body element of the page content should be focused.

focusOnPageContainer

val focusOnPageContainer: Boolean = false

If focus should be applied to the page container iframe, before applying focus on elements within the iframe. This is necessary on some platforms in order for accessibility technologies to detect focus() changes inside iframes. If the page container isn't an iframe, this option has no effect.

focusTargetOptions

val focusTargetOptions: FocusOnReadingPositionTargetOptions

This option determines how to select a focus target when focusing on the reading position

Functions

serialize

fun serialize(generator: JsonGenerator)