readium-navigator-web-internals/org.readium.navigator.web.internals.webview/WebViewScrollController

WebViewScrollController

class WebViewScrollController(webView: RelaxedWebView) : Scrollable2DState

Constructors

WebViewScrollController

constructor(webView: RelaxedWebView)

Properties

val canMoveBottom: Boolean

val canMoveLeft: Boolean

val canMoveRight: Boolean

val canMoveTop: Boolean

canScrollBottom

open override val canScrollBottom: Boolean

open override val canScrollLeft: Boolean

open override val canScrollRight: Boolean

open override val canScrollTop: Boolean

isScrollInProgress

open override val isScrollInProgress: Boolean

Whether this Scrollable2DState is currently scrolling by gesture, fling or programmatically or not.

val maxScrollX: Int

val maxScrollY: Int

val scrollX: Int

val scrollY: Int

Functions

canMoveBackward

fun canMoveBackward(orientation: Orientation, direction: LayoutDirection): Boolean

fun canMoveForward(orientation: Orientation, direction: LayoutDirection): Boolean

dispatchRawDelta

open override fun dispatchRawDelta(delta: Offset): Offset

Dispatch scroll delta in pixels avoiding all scroll related mechanisms.

fun moveBackward(orientation: Orientation, direction: LayoutDirection)

fun moveBottom()

fun moveForward(orientation: Orientation, direction: LayoutDirection)

fun moveRight()

moveToProgression

fun moveToProgression(progression: Double, snap: Boolean, orientation: Orientation, direction: LayoutDirection)

fun progression(orientation: Orientation, direction: LayoutDirection): Double?

open suspend override fun scroll(scrollPriority: MutatePriority, block: suspend Scroll2DScope.() -> Unit)

Call this function to take control of scrolling and gain the ability to send scroll events via Scroll2DScope.scrollBy. All actions that change the logical scroll position must be performed within a scroll block (even if they don't call any other methods on this object) in order to guarantee that mutual exclusion is enforced.

fun scrollBy(delta: Offset): Offset

fun scrollToMax(orientation: Orientation): Int

fun scrollToMin(orientation: Orientation): Int