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

VisiblePage

interface VisiblePage

A page fully visible or partially visible in the ReaderView.

Properties

Link copied to clipboard
abstract 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.

Link copied to clipboard
abstract val pageSpreadSlot: PageSpreadSlot

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

Link copied to clipboard
abstract val rangeLocator: SimpleLocatorData

The range locator representing the entire page contents.

Link copied to clipboard
abstract val readerDocumentIndexInSpine: Int

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

Link copied to clipboard
abstract val startLocator: SimpleLocatorData

The locator to the start of this page.

Functions

abstract suspend fun fetchBoundingClientRectForContentLocation(locator: SimpleLocatorData): ColibrioResult<Rect?>
abstract fun fetchBoundingClientRectForContentLocation(locator: SimpleLocatorData, onSuccess: (Rect?) -> Unit, onError: (ColibrioException) -> Unit)

Fetch one bounding client rect for the specified target locator on this visible page.

Link copied to clipboard
abstract suspend fun fetchContentRects(locator: SimpleLocatorData? = null, options: VisibleContentRectsOptions = VisibleContentRectsOptions()): ColibrioResult<VisibleContentRectsResultData>
abstract fun fetchContentRects(locator: SimpleLocatorData? = null, options: VisibleContentRectsOptions = VisibleContentRectsOptions(), onSuccess: (VisibleContentRectsResultData) -> Unit, onError: (ColibrioException) -> Unit)

Fetch rectangles and locators for line boxes and replaced elements such as <img> elements from this visible page. If a locator is specified, it will be used to filter the result.

Link copied to clipboard
abstract suspend fun fetchRectsForVisibleContent(locator: SimpleLocatorData? = null, options: VisibleContentRectsOptions = VisibleContentRectsOptions()): ColibrioResult<VisibleContentRectsResultData>
abstract fun fetchRectsForVisibleContent(locator: SimpleLocatorData? = null, options: VisibleContentRectsOptions = VisibleContentRectsOptions(), onSuccess: (VisibleContentRectsResultData) -> Unit, onError: (ColibrioException) -> Unit)

Fetch rectangles and locators for line boxes and replaced elements such as <img> elements from this visible page. If a locator is specified, it will be used to filter the result.

Link copied to clipboard
abstract suspend fun setContentSelection(locator: SimpleLocatorData): ColibrioResult<Unit>
abstract fun setContentSelection(locator: SimpleLocatorData, onSuccess: () -> Unit, onError: (ColibrioException) -> Unit)

Sets the current content selection in this VisiblePage to the range most closely matching the specified locator.