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

EngineEventTargetData

open class EngineEventTargetData(val frameworkComponent: EngineEventTargetFrameworkComponent, val locator: SimpleLocatorData?, val mediaType: String, val nodeData: EngineEventTargetXmlElementNodeData?, val objectType: EngineEventTargetObjectType = EngineEventTargetObjectType.ENGINE_EVENT_TARGET, val readerDocumentIndexInSpine: Int?)

Contains information about the publication content targeted by an EngineEvent.

Constructors

EngineEventTargetData

fun EngineEventTargetData(frameworkComponent: EngineEventTargetFrameworkComponent, locator: SimpleLocatorData?, mediaType: String, nodeData: EngineEventTargetXmlElementNodeData?, objectType: EngineEventTargetObjectType = EngineEventTargetObjectType.ENGINE_EVENT_TARGET, readerDocumentIndexInSpine: Int?)

Types

object Companion

Functions

open fun serialize(generator: JsonGenerator)

Properties

frameworkComponent

val frameworkComponent: EngineEventTargetFrameworkComponent

Describes the framework component that was the target of the event.

val locator: SimpleLocatorData?

A locator that points to the publication content related with the event.

val mediaType: String

Describes the media type of the document related with the event, and thereby what data types to expect in nodeData

val nodeData: EngineEventTargetXmlElementNodeData?

A JSON compatible data structure representing the underlying node that was the target of the event, like for example a HTML node in a HTML content-document.

val objectType: EngineEventTargetObjectType

The type of EngineEventTarget object this JSON structure represents.

readerDocumentIndexInSpine

val readerDocumentIndexInSpine: Int?

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

Inheritors

SyncMediaSegmentTargetData