pspdfkit/com.pspdfkit.configuration/PdfConfiguration

PdfConfiguration

abstract class PdfConfiguration : Parcelable

Configuration for the core of PSPDFKit rendering engine. To create the configuration use the Builder.

Types

Link copied to clipboard
class Builder
Builder used to construct PdfConfiguration instance.

Properties

Link copied to clipboard
val DEFAULT_LOADING_PROGRESS_DRAWABLE: Integer
Default ID for progress drawable

Functions

Link copied to clipboard
abstract fun allowMultipleBookmarksPerPage(): Boolean
Indicates whether multiple bookmarks per page can be added or not, defaults to false.
Link copied to clipboard
abstract fun animateScrollOnEdgeTaps(): Boolean
Indicates whether page changes triggered by tapping the page edge cause an animation.
Link copied to clipboard
@NonNull
abstract fun getAnnotationReplyFeatures(): AnnotationReplyFeatures
Which parts of the annotation replies UI are enabled.
Link copied to clipboard
@ColorInt
abstract fun getBackgroundColor(): Int
Document paper color (white is default).
Link copied to clipboard
@Nullable
abstract fun getDefaultSigner(): String
Default signer used when signing a documents.
Link copied to clipboard
@NonNull
abstract fun getEditableAnnotationTypes(): List<AnnotationType>
Returns a list of annotation types that should be editable.
Link copied to clipboard
abstract fun getEnabledAnnotationTools(): List<AnnotationTool>
Returns a list of annotation tools that should be enabled.
Link copied to clipboard
Link copied to clipboard
@NonNull
abstract fun getEnabledShareFeatures(): EnumSet<ShareFeatures>
Indicates which supported share features are enabled in the UI.
Link copied to clipboard
@NonNull
abstract fun getExcludedAnnotationTypes(): ArrayList<AnnotationType>
Returns a list of annotation types that will be excluded from rendering.
Link copied to clipboard
abstract fun getFitMode(): PageFitMode
Fit mode of the document (fit-to-screen is default).
Link copied to clipboard
@Nullable
abstract fun getFixedLowResRenderPixelCount(): Integer
Returns fixed low resolution render pixel count or null.
Link copied to clipboard
@Size(min = 2, multiple = 2)
abstract fun getGuideLineIntervals(): List<Float>
Defines guide line on/off intervals sizes.
Link copied to clipboard
abstract fun getLayoutMode(): PageLayoutMode
Layout mode of the document (AUTO is default).
Link copied to clipboard
@DrawableRes
@Nullable
abstract fun getLoadingProgressDrawable(): Integer
Returns drawable for the throbber displayed while loading the document.
Link copied to clipboard
abstract fun getMaxZoomScale(): Float
Maximum zoom scale in the document.
Link copied to clipboard
abstract fun getMemoryCacheSize(): Int
Size of the memory cache (defaults to 1/4 of the available heap size).
Link copied to clipboard
abstract fun getPagePadding(): Int
The padding between pages (defaults to 16dp).
Link copied to clipboard
@FloatRange(from = 0.0)
abstract fun getResizeGuideSnapAllowance(): Float
Defines aggressiveness of snapping to guide lines.
Link copied to clipboard
abstract fun getScrollDirection(): PageScrollDirection
Scroll direction of the document (horizontal is default).
Link copied to clipboard
abstract fun getScrollMode(): PageScrollMode
Scroll mode of the document (per-page is default).
abstract fun getSelectedAnnotationFontScalingOnResizeEnabled(): Boolean
Indicates whether the font scaling when resizing Freetext annotations with the bottom right handle is enabled.
Link copied to clipboard
abstract fun getSelectedAnnotationResizeEnabled(): Boolean
Indicates whether the selected annotation resizing is enabled or not.
Link copied to clipboard
abstract fun getSelectedAnnotationResizeGuidesEnabled(): Boolean
Indicates whether the annotation selection resize guide lines are enabled or not.
Link copied to clipboard
@Nullable
abstract fun getSignatureAppearance(): SignatureAppearance
Defines the appearance of the digital signature that is added after digitally signing a document.
Link copied to clipboard
@NonNull
abstract fun getSignatureCertificateSelectionMode(): SignatureCertificateSelectionMode
Defines if the user should be able to select certificates for digitally signing a document, when creating a new signature.
Link copied to clipboard
@NonNull
abstract fun getSignatureColorOptions(): SignatureColorOptions
Defines the signature color options available when using the "Draw" or "Type" signing UI.
Link copied to clipboard
@NonNull
@Size(min = 1, max = 3)
abstract fun getSignatureCreationModes(): List<SignatureCreationMode>
The ways in which the user can choose to add their signature.
Link copied to clipboard
@NonNull
abstract fun getSignaturePickerOrientation(): SignaturePickerOrientation
The orientation to use for the signature picker, defaults to AUTOMATIC.
Link copied to clipboard
@NonNull
abstract fun getSignatureSavingStrategy(): SignatureSavingStrategy
The saving strategy used when adding signatures.
Link copied to clipboard
abstract fun getStartZoomScale(): Float
The scale at which the document should start.
Link copied to clipboard
abstract fun getThemeMode(): ThemeMode
Theme mode of the whole app (DEFAULT is default).
Link copied to clipboard
abstract fun isAnnotationEditingEnabled(): Boolean
Indicates whether the annotation editing is enabled or not.
Link copied to clipboard
abstract fun isAnnotationInspectorEnabled(): Boolean
Indicates whether the annotation creation and editing inspectors are enabled.
Link copied to clipboard
abstract fun isAnnotationLimitedToPageBounds(): Boolean
Indicates whether the annotations are limited to the page bounds.
Link copied to clipboard
abstract fun isAnnotationRotationEnabled(): Boolean
Indicates whether the annotation rotation is enabled or not.
Link copied to clipboard
abstract fun isAutomaticLinkGenerationEnabled(): Boolean
Whether we automatically generating link annotations for links in the document text is enabled or not.
Link copied to clipboard
abstract fun isAutosaveEnabled(): Boolean
Whether document autosave is enabled.
Link copied to clipboard
abstract fun isAutoSelectNextFormElementEnabled(): Boolean
Indicates whether the auto select next form element functionality is enabled or not (defaults to false).
Link copied to clipboard
abstract fun isContentEditingEnabled(): Boolean
Indicates whether the content editing is enabled or not.
Link copied to clipboard
abstract fun isCopyPasteEnabled(): Boolean
Whether copy and paste operations are enabled for annotations.
Link copied to clipboard
abstract fun isFirstPageAlwaysSingle(): Boolean
Whether the first page should always be displayed as a single or not, false by default.
Link copied to clipboard
abstract fun isFormEditingEnabled(): Boolean
Indicates whether the form editing is enabled or not.
Link copied to clipboard
abstract fun isFormElementDateAndTimePickerEnabled(): Boolean
Indicates whether the date and time pickers should be enabled for according form elements (defaults to true)
Link copied to clipboard
abstract fun isInvertColors(): Boolean
If the page colors should be inverted (defaults to false).
Link copied to clipboard
abstract fun isJavaScriptEnabled(): Boolean
Controls whether JavaScript processing is enabled.
Link copied to clipboard
abstract fun isLastViewedPageRestorationEnabled(): Boolean
Whether restoration of the last viewed page when reopening a document is enabled or not.
Link copied to clipboard
abstract fun isMagnifierEnabled(): Boolean
Indicates whether the magnifier is shown when: - The text selection handles are touched.
Link copied to clipboard
abstract fun isMeasurementsEnabled(): Boolean
Indicates whether the measurement tools are enabled or not.
Link copied to clipboard
abstract fun isMultithreadedRenderingEnabled(): Boolean
Controls whether multithreaded rendering is enabled, defaults to true.
Link copied to clipboard
abstract fun isNoteAnnotationNoZoomHandlingEnabled(): Boolean
Whether handling for NOZOOM flag for note annotations is enabled.
Link copied to clipboard
abstract fun isPlayingMultipleMediaInstancesEnabled(): Boolean
Whether playing multiple media instances is enabled or not.
Link copied to clipboard
abstract fun isRedoEnabled(): Boolean
Whether redoing undone edits is enabled.
Link copied to clipboard
abstract fun isScrollbarsEnabled(): Boolean
If the default document scrollbars should be enabled (defaults to true).
Link copied to clipboard
abstract fun isTextSelectionEnabled(): Boolean
If text selection (programmatically and via long-press) is enabled (defaults to true).
Link copied to clipboard
abstract fun isTextSelectionPopupToolbarEnabled(): Boolean
Whether the text selection popup toolbar is enabled or not.
Link copied to clipboard
abstract fun isToGrayscale(): Boolean
Should the page colors be converted to grayscale (defaults to false).
Link copied to clipboard
abstract fun isUndoEnabled(): Boolean
Whether undoing edits is enabled.
Link copied to clipboard
abstract fun isVideoPlaybackEnabled(): Boolean
Whether video playback is enabled in document.
Link copied to clipboard
abstract fun scrollOnEdgeTapEnabled(): Boolean
Indicates whether tapping on the page edge causes the page to scroll.
Link copied to clipboard
abstract fun scrollOnEdgeTapMargin(): Int
The margin in DP in which taps on the page edge trigger page navigation.
Link copied to clipboard
abstract fun shouldZoomOutBounce(): Boolean
Should the zoom out below the minimum zoom have a bounce-back effect on a page.
Link copied to clipboard
abstract fun showGapBetweenPages(): Boolean
Whether to show gap between pages in double page mode or not.
Link copied to clipboard
abstract fun showNoteEditorForNewNoteAnnotations(): Boolean
Indicates whether the NoteEditor should be shown automatically when creating new note.
Link copied to clipboard
abstract fun showSignHereOverlay(): Boolean
Indicates whether the sign here overlay is shown on signature form fields.