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

ReaderViewGotoOptions

data class ReaderViewGotoOptions(val scrollRendererScrollBehavior: ScrollRendererGotoScrollBehavior = ScrollRendererGotoScrollBehavior.SCROLL_IF_OUTSIDE_VISIBLE_RANGE, val setReadingPositionToVisibleRangeStart: Boolean = false)

Options object used with ReaderView.goTo()

Constructors

Link copied to clipboard
constructor(scrollRendererScrollBehavior: ScrollRendererGotoScrollBehavior = ScrollRendererGotoScrollBehavior.SCROLL_IF_OUTSIDE_VISIBLE_RANGE, setReadingPositionToVisibleRangeStart: Boolean = false)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val scrollRendererScrollBehavior: ScrollRendererGotoScrollBehavior

This option applies to scrolling renderers only.

Link copied to clipboard
val setReadingPositionToVisibleRangeStart: Boolean = false

If this option is false, the ReaderView will use the location specified to ReaderView.goTo() as the reading position if the navigation is successful. This is the default behaviour.

Functions

Link copied to clipboard
fun serialize(generator: JsonGenerator)