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

EpubReaderPublicationOptions

data class EpubReaderPublicationOptions(val allowDocumentScripting: Boolean = true, val customPublicationCss: EpubReaderPublicationCustomCssOptions = EpubReaderPublicationCustomCssOptions(), val elementWhitelistOptions: EpubElementWhitelistOptions = EpubElementWhitelistOptions(), val enableMediaStreaming: Boolean = false, val fixedLayoutStyleOptions: EpubFixedLayoutStyleOptions = EpubFixedLayoutStyleOptions(), 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.

Constructors

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

Types

Companion

object Companion

Functions

serialize

fun serialize(generator: JsonGenerator)

Properties

additionalLocatorUrls

val additionalLocatorUrls: List<String>

Additional locator URLs that should resolve to the ReaderPublication when calling methods with locator parameters, such as ReaderView.goTo(), ReaderViewAnnotationLayer.createAnnotation()

allowDocumentScripting

val allowDocumentScripting: Boolean = true

Sets if content document scripting should be allowed. Content documents with scripts executes inside a sandbox iframe.

clipboardOptions

val clipboardOptions: ReaderPublicationClipboardOptions

Options controlling clipboard actions.

customPublicationCss

val customPublicationCss: EpubReaderPublicationCustomCssOptions

Extra CSS to inject into all content documents of the publication. This can be used to fix publications with problematic CSS.

defaultLocatorUrl

val defaultLocatorUrl: String? = null

The base URL that should be used by the ReaderPublication when it creates new Locators.

elementWhitelistOptions

val elementWhitelistOptions: EpubElementWhitelistOptions

All Elements and Attributes in reflowable content-documents are processed through a whitelist filter to prevent unsafe scripting.

enableMediaStreaming

val enableMediaStreaming: Boolean = false

If streaming of audio and video using the Media Source Extensions API (MSE) should be used. See https://developer.mozilla.org/en-US/docs/Web/API/Media_Source_Extensions_API

fixedLayoutStyleOptions

val fixedLayoutStyleOptions: EpubFixedLayoutStyleOptions

Options controlling which publicationStyleOptions set by calling ReaderView.setOptions() that should apply to fixed-layout documents.

mediaOverlayOptions

val mediaOverlayOptions: EpubMediaOverlayOptions

Options related with EPUB media overlays

pageCountEstimationAlgorithm

val pageCountEstimationAlgorithm: EpubPageCountEstimationAlgorithm

The algorithm to use for estimating the number of pages in content documents. Note: This option is only checked when calling load publication.

preventDefaultContextMenu

val preventDefaultContextMenu: Boolean = false

If set to true, the reading system will prevent the default "right-click" and "long-press" context menus to be shown for publication content.

preventDefaultContextMenuOnMediaElements

val preventDefaultContextMenuOnMediaElements: Boolean = false

If the default context-menu should be prevented when right-clicking or long pressing: images, video or audio elements

preventDragAndDropActions

val preventDragAndDropActions: Boolean = true

Sets if users should be able to "drag-and-drop" content from the publication.

reflowOptions

val reflowOptions: EpubReflowOptions

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

remoteResourcesNonScriptedDocumentsOptions

val remoteResourcesNonScriptedDocumentsOptions: EpubRemoteResourceOptions

Options for controlling remote resources in the publication for non-scripted content-documents.

remoteResourcesScriptedDocumentsOptions

val remoteResourcesScriptedDocumentsOptions: EpubRemoteResourceOptions

Options for controlling remote resources in the publication for scripted content-documents.

textSplitOptions

val textSplitOptions: EpubTextNodeSplitOptions

Options related to splitting up text nodes in order to increase performance when reflowing an EPUB that has very long text nodes.