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

VisiblePageData

data class VisiblePageData(val boundingClientRect: Rect?, val pageIndexInReflowedDocument: Int, val pageSpreadSlot: PageSpreadSlot, val rangeLocator: SimpleLocatorData, val readerDocumentIndexInSpine: Int, val startLocator: SimpleLocatorData)

A page fully visible or partially visible in the ReaderView.

Constructors

VisiblePageData

fun VisiblePageData(boundingClientRect: Rect?, pageIndexInReflowedDocument: Int, pageSpreadSlot: PageSpreadSlot, rangeLocator: SimpleLocatorData, readerDocumentIndexInSpine: Int, startLocator: SimpleLocatorData)

Types

object Companion

Functions

fun serialize(generator: JsonGenerator)

Properties

boundingClientRect

val boundingClientRect: Rect?

The bounding client rect of the visible page in application viewport coordinate system. Set to null if this page is not visible.

pageIndexInReflowedDocument

val pageIndexInReflowedDocument: Int

The zero-based index in the list of pages generated when reflowing the ReaderDocument. Always returns 0 for non-reflowable ReaderDocuments.

val pageSpreadSlot: PageSpreadSlot

The page spread slot for this page when using a Renderer capable of showing spreads.

val rangeLocator: SimpleLocatorData

The range locator representing the entire page contents.

readerDocumentIndexInSpine

val readerDocumentIndexInSpine: Int

The index of the ReaderDocument in the ReaderPublication spine this page was generated from.

val startLocator: SimpleLocatorData

The locator to the start of this page.