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

NavigationIntentEngineEventData

class NavigationIntentEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.NAVIGATION_INTENT_ENGINE_EVENT, val type: EngineEventDataType, val internalNavigation: Boolean, val locator: SimpleLocatorData, val readerDocumentIndexInSpine: Int?, val relatedEvent: MouseEngineEventData?, val sourceReaderDocumentIndexInSpine: Int?) : ReaderViewEngineEventData

Constructors

NavigationIntentEngineEventData

fun NavigationIntentEngineEventData(objectType: EngineEventDataObjectType = EngineEventDataObjectType.NAVIGATION_INTENT_ENGINE_EVENT, type: EngineEventDataType, internalNavigation: Boolean, locator: SimpleLocatorData, readerDocumentIndexInSpine: Int?, relatedEvent: MouseEngineEventData?, sourceReaderDocumentIndexInSpine: Int?)

Types

object Companion

Functions

open override fun serialize(generator: JsonGenerator)

Properties

internalNavigation

val internalNavigation: Boolean

If the locator points to a ReaderDocument in the ReaderView.

val locator: SimpleLocatorData

The locator for the navigation.

val objectType: EngineEventDataObjectType

The type of engine event object this JSON structure represents.

readerDocumentIndexInSpine

val readerDocumentIndexInSpine: Int?

The reader document that was the target of the event if any.

val relatedEvent: MouseEngineEventData?

The MouseEngineEvent that triggered this navigation intent if available.

sourceReaderDocumentIndexInSpine

val sourceReaderDocumentIndexInSpine: Int?

The index in spine of the reader document in where the event was emitted.

val type: EngineEventDataType

The type of event.