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

Publication

interface Publication

Describes the source publication that was loaded into a ReadingSystemEngine.

Properties

Link copied to clipboard
abstract val defaultLayout: ContentDocumentLayout

The default layout for content documents in this publication.

Link copied to clipboard
abstract val hashSignature: String

A generated hash signature of the publication, intended to uniquely identify this publication. The hash signature is not the same as the publication id as the hash signature always changes when the publication data changes in any way. The uniqueness of the signature depends on how the publication was loaded. Please refer the implementation responsible for loading this instance. For example, for EPUB see OcfResourceProvider.

Link copied to clipboard
abstract val metadata: PublicationMetadata

Metadata about the publication.

Link copied to clipboard
abstract val pageProgressionDirection: PageProgressionDirection

Get the global direction in which the Publication content flows.

Link copied to clipboard
abstract val preferredFlowMode: ContentDocumentFlowMode

Get the default preferred flow mode for content documents in the publication.

Link copied to clipboard
abstract val preferredOrientation: PublicationOrientation

Get the intended orientation for the publication.

Link copied to clipboard
abstract val preferredSyntheticSpreadBehavior: SyntheticSpreadBehavior

Get the default preferred synthetic spread behavior for content documents in this publication.

Link copied to clipboard
abstract val spine: List<ContentDocumentData>

The source content documents in reading order.