readium-navigator-web-internals/org.readium.navigator.web.internals.gestures/Scrollable2DState

Scrollable2DState

interface Scrollable2DState

An object representing something that can be scrolled.

Inheritors

RenditionScrollState

WebViewScrollController

Properties

canScrollBottom

open val canScrollBottom: Boolean

open val canScrollLeft: Boolean

open val canScrollRight: Boolean

open val canScrollTop: Boolean

isScrollInProgress

abstract val isScrollInProgress: Boolean

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

Functions

dispatchRawDelta

abstract fun dispatchRawDelta(delta: Offset): Offset

Dispatch scroll delta in pixels avoiding all scroll related mechanisms.

abstract suspend fun scroll(scrollPriority: MutatePriority = MutatePriority.Default, 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.