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

Package-level declarations

Types

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.

ContentDocumentFlowMode

enum ContentDocumentFlowMode : Enum<ContentDocumentFlowMode>

Specifies how the publication content should be presented by the reading system.

ContentDocumentLayout

enum ContentDocumentLayout : Enum<ContentDocumentLayout>

Specifies if a content document has been designed as a fixed-layout document, or if it can be reflowed/paginated.

PageProgressionDirection

enum PageProgressionDirection : Enum<PageProgressionDirection>

The global direction in which the Publication content flows. Please note that this is not same as the writing direction. A publication's pages can be ordered from right-to-left, but its text written left-to-right.

PageSpreadSlot

enum PageSpreadSlot : Enum<PageSpreadSlot>

When a publication is presented as a spread of two pages. This enum defines in which slot the page is intended to rendered into.

PublicationMetadataData

open class PublicationMetadataData(val all: List<PublicationMetadataItem>, val identifierIndexes: List<Int>, val languageIndexes: List<Int>, val titleIndexes: List<Int>, val type: PublicationMetadataType)

Contains all metadata items extracted from a publication.

PublicationMetadataItem

data class PublicationMetadataItem(val content: LocalizableString, val contentScheme: RdfaProperty?, val property: RdfaProperty, val refinedBy: List<PublicationMetadataItem>)

Represents a metadata item entry in a publication such as a title or author.

PublicationMetadataType

enum PublicationMetadataType : Enum<PublicationMetadataType>

Describes the type of an IPublicationMetadataData instance.

PublicationOrientation

enum PublicationOrientation : Enum<PublicationOrientation>

Describes which orientation the author intends the Publication to be rendered in.

PublicationType

enum PublicationType : Enum<PublicationType>

Describes the type of an IPublication instance.

RdfaProperty

data class RdfaProperty(val name: String, val namespace: String?)

Represents an RDFa property.

SyntheticSpreadBehavior

enum SyntheticSpreadBehavior : Enum<SyntheticSpreadBehavior>

Describes in which orientations the reading system should present the publication in spread mode. Can be overridden per content document.