colibrio-reader-framework/com.colibrio.readingsystem.formatadapter.epub

Package-level declarations

Types

data class CustomCssValuePenalizerNumericCondition(val comparator: CustomCssValuePenalizerNumericConditionComparator, val value: Double)

CustomCssValuePenalizerNumericConditionComparator

enum CustomCssValuePenalizerNumericConditionComparator : Enum<CustomCssValuePenalizerNumericConditionComparator>

Possible values for CustomCssValuePenalizerNumericCondition.comparator

CustomCssValuePenalizerOptions

data class CustomCssValuePenalizerOptions(val fragmentation: List<CustomCssValuePenalizerRule> = emptyList(), val orphans: List<CustomCssValuePenalizerRule> = emptyList(), val widows: List<CustomCssValuePenalizerRule> = emptyList())

CustomCssValuePenalizerRule

data class CustomCssValuePenalizerRule(val numericValueCondition: CustomCssValuePenalizerNumericCondition? = null, val penalty: Int, val properties: List<CustomCssValuePenalizerRuleProperties>, val values: List<String>? = null)

CustomCssValuePenalizerRuleProperties

enum CustomCssValuePenalizerRuleProperties : Enum<CustomCssValuePenalizerRuleProperties>

Possible values for CustomCssValuePenalizerRule.properties

CustomElementPenalizerOptions

data class CustomElementPenalizerOptions(val fragmentation: List<CustomElementPenalizerRule> = emptyList(), val orphans: List<CustomElementPenalizerRule> = emptyList(), val widows: List<CustomElementPenalizerRule> = emptyList())

CustomElementPenalizerOverrideRule

data class CustomElementPenalizerOverrideRule(val penalty: Int, val selector: String)

CustomElementPenalizerRule

data class CustomElementPenalizerRule(val overrides: List<CustomElementPenalizerOverrideRule>? = null, val penalty: Int, val selector: String, val skipIfFragmented: Boolean? = null)

CustomForcedPageBreakOptions

data class CustomForcedPageBreakOptions(val breakAfterRules: List<CustomForcedPageBreakOptionsRuleDef> = emptyList(), val breakBeforeRules: List<CustomForcedPageBreakOptionsRuleDef> = emptyList(), val breakMarkersRules: List<CustomForcedPageBreakOptionsRuleDef> = emptyList())

Options for the plugin ForcedBreakSelectorPlugin

CustomForcedPageBreakOptionsRuleDef

data class CustomForcedPageBreakOptionsRuleDef(val breakMode: ForcedBreakMode, val selector: String)

EpubAudioPublication

interface EpubAudioPublication : AudioPublication

Represents the Media Overlay from an EPUB publication, specifically for handling audio content.

EpubCharacterPageCountEstimationOptions

data class EpubCharacterPageCountEstimationOptions(val audioElementWeight: Int = 50, val iframeElementWeight: Int = 50, val imageElementWeight: Int = 50, val videoElementWeight: Int = 50)

EpubCharactersContentPositionTimelineMappingOptions

data class EpubCharactersContentPositionTimelineMappingOptions(val audioElementWeight: Int = 50, val iframeElementWeight: Int = 50, val imageElementWeight: Int = 50, val videoElementWeight: Int = 50, val whitespaceBehaviour: EpubContentPositionTimelineWhitespaceBehavior = EpubContentPositionTimelineWhitespaceBehavior.COLLAPSE)

Options used when creating EPUB ContentPositionTimeline objects with CHARACTERS as unit of measurement.

EpubContentBlockOptions

data class EpubContentBlockOptions(val attributeNamesThatCreateContentBlocks: List<String>? = null, val disableDefaultAttributeFiltering: Boolean = false, val includeMathMlContentBlocks: Boolean = false, val includePreContentBlocks: Boolean = false)

Options used for configuring ContentBlocks in EpubReaderPublications.

EpubContentOverflowStrategy

enum EpubContentOverflowStrategy : Enum<EpubContentOverflowStrategy>

Describes which strategy that should be applied when publication content is overflowing.

EpubContentPositionTimelineOptions

sealed class EpubContentPositionTimelineOptions

Base interface for all options types that can be used when creating ContentPositionTimeline for EPUB Publications.

EpubContentPositionTimelineWhitespaceBehavior

enum EpubContentPositionTimelineWhitespaceBehavior : Enum<EpubContentPositionTimelineWhitespaceBehavior>

Defines how whitespace characters should be handled in EPUB ContentPositionTimelines.

EpubContentProcessingOptions

data class EpubContentProcessingOptions(val horizontalOverflowMathMLStrategy: EpubContentOverflowStrategy = EpubContentOverflowStrategy.SCROLL, val horizontalOverflowMitigationMinFontSize: Double = 16.0, val horizontalOverflowTableStrategy: EpubContentOverflowStrategy = EpubContentOverflowStrategy.SCROLL, val skipUnusedImagesInScriptedPublicationCss: Boolean = false, val verticalOverflowMitigationStrategy: EpubContentOverflowStrategy = EpubContentOverflowStrategy.SCROLL)

EpubDocumentSectioningAlgorithm

sealed class EpubDocumentSectioningAlgorithm

The base type for all algorithms that can be used with EPUB document sectioning.

EpubDocumentSectioningAlgorithmType

enum EpubDocumentSectioningAlgorithmType : Enum<EpubDocumentSectioningAlgorithmType>

Possible values for EpubDocumentSectioningAlgorithm.type

EpubDocumentSectioningOptions

data class EpubDocumentSectioningOptions(val algorithm: EpubDocumentSectioningAlgorithm = EpubDocumentSectioningAlgorithm.Selector(), val enabled: Boolean = false)

Options controlling how reflowable documents can be split into sections prior to reflowing. This can greatly increase performance for publications with very long content documents. The downside is that each split will look like a page break in the rendered content. To mitigate the impact of these page breaks on the reading experience, you can control where and how often these breaks will occur by using these options.

EpubDocumentSectioningSelector

data class EpubDocumentSectioningSelector(val breakPosition: SectionBreakPosition, val selector: String)

EpubElementWhitelistOptions

data class EpubElementWhitelistOptions(val attributeNames: List<String> = emptyList(), val tagNames: List<String> = emptyList())

EpubFixedLayoutStyleOptions

data class EpubFixedLayoutStyleOptions(val allowFontSetCustomization: Boolean = false, val allowPaletteCustomization: Boolean = false)

By default, publicationStyleOptions set by calling ReaderView.setOptions() only applies to reflowable documents and are ignored by fixed-layout documents.

EpubMediaOverlayLoadConfig

data class EpubMediaOverlayLoadConfig(val epubReaderPublication: EpubReaderPublication, val timeline: SyncMediaTimeline)

Used with AudioReadingSystemEngine.loadEpubMediaOverlayAudioPublication to load the Media Overlay from an EPUB publication.

EpubMediaOverlayOptions

data class EpubMediaOverlayOptions(val activeElementAncestorClass: String? = null, val fallbackActiveElementClass: String = "-epub-media-overlay-active", val fallbackPlaybackActiveClass: String = "-epub-media-overlay-playing")

EpubPageCountEstimationAlgorithm

sealed class EpubPageCountEstimationAlgorithm

Base type used for all algorithms that handle page count estimation of reflowable content documents. See IEpubReaderPublicationOptions.pageCountEstimationAlgorithm for more information.

EpubPageCountEstimationAlgorithmType

enum EpubPageCountEstimationAlgorithmType : Enum<EpubPageCountEstimationAlgorithmType>

Available algorithms when estimating the number of pages in reflowable content-documents. Number of pages estimation is used by the PageProgressionTimeline when the ReaderView option pageProgressionTimelineOptions.forceCompleteRendition is set to false.

EpubReaderPublicationCustomCssOptions

data class EpubReaderPublicationCustomCssOptions(val enableNormalizeCss: Boolean = true, val injectionPointEnd: List<String> = emptyList(), val injectionPointStart: List<String> = emptyList())

EpubReaderPublicationOptions

data class EpubReaderPublicationOptions(val allowDocumentScripting: Boolean = true, val contentBlockOptions: EpubContentBlockOptions = EpubContentBlockOptions(), val contentProcessingOptions: EpubContentProcessingOptions = EpubContentProcessingOptions(), val customPublicationCss: EpubReaderPublicationCustomCssOptions = EpubReaderPublicationCustomCssOptions(), val documentSectioningOptions: EpubDocumentSectioningOptions = EpubDocumentSectioningOptions(), val elementWhitelistOptions: EpubElementWhitelistOptions = EpubElementWhitelistOptions(), val enableMediaStreaming: Boolean = false, val fixedLayoutStyleOptions: EpubFixedLayoutStyleOptions = EpubFixedLayoutStyleOptions(), val includeContentLocationInPointerMoveEvents: Boolean = false, val mediaOverlayOptions: EpubMediaOverlayOptions = EpubMediaOverlayOptions(), val pageCountEstimationAlgorithm: EpubPageCountEstimationAlgorithm = EpubPageCountEstimationAlgorithm.FileSize(), val preventDefaultContextMenuOnMediaElements: Boolean = false, val reflowOptions: EpubReflowOptions = EpubReflowOptions(), val remoteResourcesNonScriptedDocumentsOptions: EpubRemoteResourceOptions = EpubRemoteResourceOptions(), val remoteResourcesScriptedDocumentsOptions: EpubRemoteResourceOptions = EpubRemoteResourceOptions(), val textSplitOptions: EpubTextNodeSplitOptions = EpubTextNodeSplitOptions(), val additionalLocatorUrls: List<String> = emptyList(), val clipboardOptions: ReaderPublicationClipboardOptions = ReaderPublicationClipboardOptions(), val defaultLocatorUrl: String? = null, val preventDefaultContextMenu: Boolean = false, val preventDragAndDropActions: Boolean = true)

Options related to processing and presentation of EPUB publications.

EpubReflowOptions

data class EpubReflowOptions(val plugins: EpubReflowPluginOptions = EpubReflowPluginOptions(), val removeBottomMarginsOnFragmentedElements: Boolean = true, val removeTopMarginsOnFragmentedElements: Boolean = true)

Options configuring how the reflow engine divide content documents into pages. These options will be further documented in a future version of the framework.

EpubReflowPluginOptions

data class EpubReflowPluginOptions(val cssForcedPageBreak: Boolean = true, val customCssValuePenalizer: CustomCssValuePenalizerOptions? = null, val customElementPenalizer: CustomElementPenalizerOptions? = null, val customForcedPageBreak: CustomForcedPageBreakOptions? = null, val floatingOrphanPenalizer: FloatingOrphanPenalizerOptions? = null, val fragmentableElements: FragmentableElementsOptions? = null, val listBreak: ListBreakOptions? = null, val mediaShrink: MediaShrinkReflowPluginOptions? = null, val orphanTextPattern: OrphanTextPatternOptions? = null, val unforcedTextBreak: UnforcedTextBreakOptions? = null, val verticalWhitespacePenalizer: VerticalWhitespacePenalizerOptions? = null)

EpubRemoteResourceOptions

data class EpubRemoteResourceOptions(val policyType: EpubRemoteResourcePolicyType = EpubRemoteResourcePolicyType.DENY_ALL, val whitelistDirectives: List<EpubRemoteResourceWhitelistDirective> = emptyList())

Options that defines if content-documents can load remote resources. What type of remote resources they can load, and from where these can be loaded.

EpubRemoteResourcePolicyType

enum EpubRemoteResourcePolicyType : Enum<EpubRemoteResourcePolicyType>

Defines what access policy to use for remote resources. Used in IEpubRemoteResourceOptions.

EpubRemoteResourceWhitelistDirective

data class EpubRemoteResourceWhitelistDirective(val directive: EpubRemoteResourceWhitelistDirectiveDirective, val sources: List<String>)

EpubRemoteResourceWhitelistDirectiveDirective

enum EpubRemoteResourceWhitelistDirectiveDirective : Enum<EpubRemoteResourceWhitelistDirectiveDirective>

Possible values for EpubRemoteResourceWhitelistDirective.directive

EpubSyncMediaTextRef

class EpubSyncMediaTextRef(val moContainerPath: List<Int>, val moNodeIndex: Int, val objectIndex: Int, val selector: String) : SyncMediaObjectRef

A reference to a element in a Media Overlay (MO) SMIL file.

EpubTextNodeSplitOptions

data class EpubTextNodeSplitOptions(val enableTextSplit: Boolean = false, val maxTextNodeLength: Int = 5000)

Options related to the splitting of very long text nodes.

EpubWordsContentPositionTimelineMappingOptions

data class EpubWordsContentPositionTimelineMappingOptions(val audioElementWeight: Int = 10, val iframeElementWeight: Int = 10, val imageElementWeight: Int = 10, val videoElementWeight: Int = 10)

Options used when creating EPUB ContentPositionTimeline objects with WORDS as unit of measurement.

FloatingOrphanPenalizerOptions

data class FloatingOrphanPenalizerOptions(val penalty: Int)

ForcedBreakMode

enum ForcedBreakMode : Enum<ForcedBreakMode>

Describes how the next page after the forced page break should be formatted.

FragmentableElementsOptions

data class FragmentableElementsOptions(val allowByDefault: Boolean, val blacklistSelectors: List<String> = emptyList(), val blacklistStyles: List<FragmentableElementsOptionStyleRule> = emptyList(), val whitelistSelectors: List<String> = emptyList())

FragmentableElementsOptionStyleRule

data class FragmentableElementsOptionStyleRule(val property: FragmentableElementsOptionStyleRuleProperty, val values: List<String>)

FragmentableElementsOptionStyleRuleProperty

enum FragmentableElementsOptionStyleRuleProperty : Enum<FragmentableElementsOptionStyleRuleProperty>

Possible values for FragmentableElementsOptionStyleRule.property

ListBreakOptions

data class ListBreakOptions(val orphans: ListBreakOptionsPenaltyRule? = null, val widows: ListBreakOptionsPenaltyRule? = null)

ListBreakOptionsPenaltyRule

data class ListBreakOptionsPenaltyRule(val minItems: Int, val penalty: Int)

MediaShrinkReflowPluginOptions

data class MediaShrinkReflowPluginOptions(val activationThreshold: Double = 0.15, val maxShrinkFactor: Double = 0.7, val penaltyAtMaxShrinkage: Int = 10)

OrphanTextPatternOptions

data class OrphanTextPatternOptions(val rules: List<OrphanTextPatternOptionsRule>)

OrphanTextPatternOptionsRule

data class OrphanTextPatternOptionsRule(val flags: String? = null, val pattern: String, val penalty: Int)

SectionBreakPosition

enum SectionBreakPosition : Enum<SectionBreakPosition>

UnforcedTextBreakOptions

data class UnforcedTextBreakOptions(val loneWidowNotFragmented: UnforcedTextBreakOptionsRule? = null, val orphans: UnforcedTextBreakOptionsRule? = null, val textFragmentationPenalty: Int? = null, val widows: UnforcedTextBreakOptionsRule? = null)

UnforcedTextBreakOptionsRule

data class UnforcedTextBreakOptionsRule(val minLines: Int? = null, val minLinesFromCss: Boolean? = null, val penalty: Int? = null)

VerticalWhitespacePenalizerOptions

data class VerticalWhitespacePenalizerOptions(val stops: List<VerticalWhiteSpacePenaltyStop> = emptyList())

VerticalWhiteSpacePenaltyStop

data class VerticalWhiteSpacePenaltyStop(val penalty: Int, val whitespaceRatio: Double)