readium-navigator-web-internals/org.readium.navigator.web.internals.pager/RenditionScrollState

RenditionScrollState

class RenditionScrollState(pagerState: PagerState, pageStates: List<PageScrollState>, overflow: State<Overflow>) : Scrollable2DState

Constructors

RenditionScrollState

constructor(pagerState: PagerState, pageStates: List<PageScrollState>, overflow: State<Overflow>)

Properties

canScrollBottom

open val canScrollBottom: Boolean

open val canScrollLeft: Boolean

open val canScrollRight: Boolean

open val canScrollTop: Boolean

isScrollInProgress

open override val isScrollInProgress: Boolean

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

Functions

dispatchRawDelta

open override fun dispatchRawDelta(delta: Offset): Offset

Dispatch scroll delta in pixels avoiding all scroll related mechanisms.

onDocumentResized

fun onDocumentResized(index: Int)

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.