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

ReaderViewStateData

data class ReaderViewStateData(val activeGestureType: ReaderViewGestureType?, val activeNavigationAction: NavigationAction?, val activeTransform: TransformData?, val allowedGestureTypes: List<ReaderViewGestureType>, val atEnd: Boolean, val atStart: Boolean, val canPerformGoTo: Boolean, val canPerformNext: Boolean, val canPerformPrevious: Boolean, val canTransform: Boolean, val contentSelectionEnabled: Boolean, val destroyed: Boolean, val offscreenContentRendering: Boolean, val pageProgressionDirection: ReaderViewPageProgressionDirection?, val readingPosition: SimpleLocatorData?, val responsiveRendererSelectionEnabled: Boolean, val scriptedContentDocumentEventHandlersEnabled: Boolean, val scrollState: ReaderViewScrollStateData?, val visibleContentRendering: Boolean, val visiblePages: List<VisiblePageData>, val visibleRange: SimpleLocatorData?)

The ReaderView state as a JSON serializable object.

Constructors

Link copied to clipboard
fun ReaderViewStateData(activeGestureType: ReaderViewGestureType?, activeNavigationAction: NavigationAction?, activeTransform: TransformData?, allowedGestureTypes: List<ReaderViewGestureType>, atEnd: Boolean, atStart: Boolean, canPerformGoTo: Boolean, canPerformNext: Boolean, canPerformPrevious: Boolean, canTransform: Boolean, contentSelectionEnabled: Boolean, destroyed: Boolean, offscreenContentRendering: Boolean, pageProgressionDirection: ReaderViewPageProgressionDirection?, readingPosition: SimpleLocatorData?, responsiveRendererSelectionEnabled: Boolean, scriptedContentDocumentEventHandlersEnabled: Boolean, scrollState: ReaderViewScrollStateData?, visibleContentRendering: Boolean, visiblePages: List<VisiblePageData>, visibleRange: SimpleLocatorData?)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun serialize(generator: JsonGenerator)

Properties

Link copied to clipboard
val activeGestureType: ReaderViewGestureType?

The current active user gesture if any.

Link copied to clipboard
val activeNavigationAction: NavigationAction?

The current navigation action being performed if any.

Link copied to clipboard
val activeTransform: TransformData?

The current active transform applied to the ReaderView, if any.

Link copied to clipboard
val allowedGestureTypes: List<ReaderViewGestureType>

The types of gestures that are allowed to be performed on this ReaderView.

Link copied to clipboard
val atEnd: Boolean

Check if this ReaderView is currently showing the last content in the last reader document added to the ReaderView.

Link copied to clipboard
val atStart: Boolean

If this ReaderView is currently showing the first content in the first reader document added to the ReaderView.

Link copied to clipboard
val canPerformGoTo: Boolean

If the goTo() or goToStart() action can be performed right now.

Link copied to clipboard
val canPerformNext: Boolean

If the next() action can be performed right now.

Link copied to clipboard
val canPerformPrevious: Boolean

If the previous() action can be performed right now.

Link copied to clipboard
val canTransform: Boolean

If the ReaderViewTransformManager can be used to apply transforms right now.

Link copied to clipboard
val contentSelectionEnabled: Boolean

If the user is able to select content in content documents.

Link copied to clipboard
val destroyed: Boolean

If this ReaderView has been destroyed.

Link copied to clipboard
val offscreenContentRendering: Boolean

If offscreen content is currently rendering.

Link copied to clipboard
val pageProgressionDirection: ReaderViewPageProgressionDirection?

The page progression direction used by the ReaderView.

Link copied to clipboard
val readingPosition: SimpleLocatorData?

The current reading position.

Link copied to clipboard
val responsiveRendererSelectionEnabled: Boolean

If the ReaderView will choose the activeRenderer based on the ResponsiveViewRules associated with each added renderer. See ReaderView.addRenderer() for more details.

val scriptedContentDocumentEventHandlersEnabled: Boolean

If the scripted content document event handlers are allowed to receive events. Note that regardless if it is true or false, you will still receive EngineEvents.

Link copied to clipboard
val scrollState: ReaderViewScrollStateData?

Information about a renderer's current scroll state. Note that the scrollTop value is not up-to-date while scrolling is true.

Link copied to clipboard
val visibleContentRendering: Boolean

If visible content is currently rendering.

Link copied to clipboard
val visiblePages: List<VisiblePageData>

Information about the current visible pages.

Link copied to clipboard
val visibleRange: SimpleLocatorData?

The locator describing the range of the visible content