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

ScrollRendererGotoScrollBehavior

enum ScrollRendererGotoScrollBehavior : Enum<ScrollRendererGotoScrollBehavior>

Different behaviors related to when a scrolling renderer should scroll when performing a ReaderView.goTo().

Entries

The renderer will not scroll if the location is inside the reading area. Otherwise, it will scroll so that the target location is at the top of the reading area.

SCROLL_IF_OUTSIDE_VISIBLE_RANGE

The renderer will not scroll if the location is inside the visible range. Otherwise, it will scroll so that the target location is at the top of the reading area.

ALWAYS_SCROLL

Always scroll so that the target location is at the top of the reading area.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<ScrollRendererGotoScrollBehavior>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

value

val value: String

Functions

serialize

fun serialize(generator: JsonGenerator)

valueOf

fun valueOf(value: String): ScrollRendererGotoScrollBehavior

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<ScrollRendererGotoScrollBehavior>

Returns an array containing the constants of this enum type, in the order they're declared.