colibrio-reader-framework/com.colibrio.readingsystem.formatadapter.pdf/PdfReaderPublicationOptions

PdfReaderPublicationOptions

data class PdfReaderPublicationOptions(val highResScaleThreshold: Double = 1.1, val includeContentLocationInPointerMoveEvents: Boolean = false, val maxCanvasPixels: Int = 8388608, 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 PDF publications.

Constructors

constructor(highResScaleThreshold: Double = 1.1, includeContentLocationInPointerMoveEvents: Boolean = false, maxCanvasPixels: Int = 8388608, additionalLocatorUrls: List<String> = emptyList(), clipboardOptions: ReaderPublicationClipboardOptions = ReaderPublicationClipboardOptions(), defaultLocatorUrl: String? = null, preventDefaultContextMenu: Boolean = false, preventDragAndDropActions: Boolean = true)

Types

Companion

object Companion

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()

clipboardOptions

val clipboardOptions: ReaderPublicationClipboardOptions

Options controlling clipboard actions.

defaultLocatorUrl

val defaultLocatorUrl: String? = null

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

highResScaleThreshold

val highResScaleThreshold: Double = 1.1

The minimum amount of scaling before re-rendering the visible pages at a higher resolution.

includeContentLocationInPointerMoveEvents

val includeContentLocationInPointerMoveEvents: Boolean = false

If "pointermove" PointerEngineEvents should include the contentLocation property.

maxCanvasPixels

val maxCanvasPixels: Int = 8388608

Determines the maximum number of pixels of the canvas we render the pdf to.

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.

preventDragAndDropActions

val preventDragAndDropActions: Boolean = true

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

Functions

serialize

fun serialize(generator: JsonGenerator)