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

ReaderDocumentData

data class ReaderDocumentData(val availableSyncMediaFormats: List<SyncMediaFormat>, val indexInSpine: Int, val locator: SimpleLocatorData, val reflowable: Boolean, val renderable: Boolean, val sourceContentDocumentIndexInSpine: Int)

Describes a serializable version of IReaderDocument

Constructors

ReaderDocumentData

fun ReaderDocumentData(availableSyncMediaFormats: List<SyncMediaFormat>, indexInSpine: Int, locator: SimpleLocatorData, reflowable: Boolean, renderable: Boolean, sourceContentDocumentIndexInSpine: Int)

Types

object Companion

Functions

fun serialize(generator: JsonGenerator)

Properties

availableSyncMediaFormats

val availableSyncMediaFormats: List<SyncMediaFormat>

The sync media formats available in this ReaderDocument.

val indexInSpine: Int

The index of this reader document within the parent IReaderPublication spine.

val locator: SimpleLocatorData

The locator for the start of the reader document

val reflowable: Boolean

If this reader document can be reflowed into multiple pages.

val renderable: Boolean

If the document can be rendered using a ReaderView.

sourceContentDocumentIndexInSpine

val sourceContentDocumentIndexInSpine: Int

The index of the source IContentDocument within the IPublication spine.