colibrio-reader-framework/com.colibrio.core.publication.base/ContentDocumentData

ContentDocumentData

data class ContentDocumentData(val hasRemoteResources: Boolean, val inLinearContent: Boolean, val indexInSpine: Int, val layout: ContentDocumentLayout, val mediaType: String?, val pageSpreadSlot: PageSpreadSlot, val scripted: Boolean, val syntheticSpreadBehavior: SyntheticSpreadBehavior)

Represents a source content document in a Publication.

Constructors

ContentDocumentData

fun ContentDocumentData(hasRemoteResources: Boolean, inLinearContent: Boolean, indexInSpine: Int, layout: ContentDocumentLayout, mediaType: String?, pageSpreadSlot: PageSpreadSlot, scripted: Boolean, syntheticSpreadBehavior: SyntheticSpreadBehavior)

Types

Companion

object Companion

Functions

serialize

fun serialize(generator: JsonGenerator)

Properties

hasRemoteResources

val hasRemoteResources: Boolean

If the publication metadata indicates that this resource internally contains references to other resources outside of this publication.

indexInSpine

val indexInSpine: Int

The index of the content document within the parent publication spine.

inLinearContent

val inLinearContent: Boolean

Indicates whether the content contributes to the primary reading order and has to be read sequentially, or auxiliary content that enhances or augments the primary content and can be accessed out of sequence. Examples of auxiliary content include: notes, descriptions and answer keys.

layout

val layout: ContentDocumentLayout

If this ContentDocument has been designed as a fixed-layout document, or if it can be reflowed/paginated.

mediaType

val mediaType: String?

The media type of this content document.

pageSpreadSlot

val pageSpreadSlot: PageSpreadSlot

If the content document should be rendered in the left-hand slot, the right-hand slot or if synthetic spread mode should be overridden and a single viewport rendered and positioned at the center of the screen.

scripted

val scripted: Boolean

If the publication metadata indicates that this resource contains scripted content or forms.

syntheticSpreadBehavior

val syntheticSpreadBehavior: SyntheticSpreadBehavior

Get in which orientations the reading system should present this content document in spread mode. If not defined by the content document, it defaults to publication.preferredSyntheticSpreadBehavior.