public abstract class

PdfConfiguration

extends Object
implements Parcelable
java.lang.Object
   ↳ com.pspdfkit.configuration.PdfConfiguration

Class Overview

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

Summary

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

Public Methods

public abstract boolean allowMultipleBookmarksPerPage ()

Indicates whether multiple bookmarks per page can be added or not, defaults to false. If disabled only one bookmark will be allowed to be added per page, otherwise multiple bookmarks can be added.

public abstract boolean animateScrollOnEdgeTaps ()

Indicates whether page changes triggered by tapping the page edge cause an animation. Defaults to false disabling page change animations when changing the page by tapping the page edge.

public abstract AnnotationReplyFeatures getAnnotationReplyFeatures ()

Which parts of the annotation replies UI are enabled.

Returns

public abstract int getBackgroundColor ()

Document paper color (white is default).

Returns
  • Default paper color for the document.

public abstract String getDefaultSigner ()

Default signer used when signing a documents.

Returns
  • Default signer identification string, or null if there's no default signer.

public abstract List<AnnotationType> getEditableAnnotationTypes ()

Returns a list of annotation types that should be editable.

Returns
  • List of annotation types that should be editable. Note that empty list here means "All annotations are editable."

public abstract List<AnnotationTool> getEnabledAnnotationTools ()

Returns a list of annotation tools that should be enabled.

Returns
  • List of enabled annotation tools. Note that empty list here means that all annotation tools are enabled.

public abstract EnumSet<CopyPasteFeatures> getEnabledCopyPasteFeatures ()

The enabled CopyPasteFeatures. Defaults to all features being enabled.

public abstract EnumSet<ShareFeatures> getEnabledShareFeatures ()

Indicates which supported share features are enabled in the UI.

Returns

public abstract ArrayList<AnnotationType> getExcludedAnnotationTypes ()

Returns a list of annotation types that will be excluded from rendering.

Returns
  • List of annotation types that will be excluded from rendering. Empty list means "All annotations are rendered."

public abstract PageFitMode getFitMode ()

Fit mode of the document (fit-to-screen is default).

Returns

public abstract Integer getFixedLowResRenderPixelCount ()

Returns fixed low resolution render pixel count or null.

Returns
  • fixed low resolution render pixel count.

public abstract List<Float> getGuideLineIntervals ()

Defines guide line on/off intervals sizes. Must have an even number of entries (>=2). Even indices are specifying the "on" intervals, the odd indices specifying the "off" intervals. "On" intervals specify length of the line dashes, "Off" specify length of the line gaps.

Returns
  • List of ON and OFF distances.

public abstract PageLayoutMode getLayoutMode ()

Layout mode of the document (AUTO is default).

Returns

public abstract Integer getLoadingProgressDrawable ()

Returns drawable for the throbber displayed while loading the document.

Returns
  • Drawable resource for the throbber displayed when loading a document.

public abstract float getMaxZoomScale ()

Maximum zoom scale in the document.

Returns
  • Maximum zoom scale at which the document can be zoomed.

public abstract int getMemoryCacheSize ()

Size of the memory cache (defaults to 1/4 of the available heap size).

Returns
  • Memory cache size.

public Size getMinimumAnnotationSize (Class<? extends ResizableAnnotation> annotationType)

Returns the configured minimum annotation size for the provided ResizableAnnotation type.

Parameters
annotationType The annotation type whose minimum size is required.
Returns
  • Minimum Annotation size in PDF points.

public abstract int getPagePadding ()

The padding between pages (defaults to 16dp).

Returns
  • Padding between pages in dp.

public abstract float getResizeGuideSnapAllowance ()

Defines aggressiveness of snapping to guide lines.

Returns
  • How many pixels around guide will snap to guide when resizing. Defaults to 30f.

public abstract PageScrollDirection getScrollDirection ()

Scroll direction of the document (horizontal is default).

Returns

public abstract PageScrollMode getScrollMode ()

Scroll mode of the document (per-page is default).

Returns

public abstract boolean getSelectedAnnotationFontScalingOnResizeEnabled ()

Indicates whether the font scaling when resizing Freetext annotations with the bottom right handle is enabled. Defaults to true.

Returns
  • true if resize guide lines are enabled, otherwise false

public abstract boolean getSelectedAnnotationResizeEnabled ()

Indicates whether the selected annotation resizing is enabled or not.

Returns
  • true if resizing of selected annotations is enabled, otherwise false.

public abstract boolean getSelectedAnnotationResizeGuidesEnabled ()

Indicates whether the annotation selection resize guide lines are enabled or not. Defaults to true.

Returns
  • true if resize guide lines are enabled, otherwise false

public abstract SignatureAppearance getSignatureAppearance ()

Defines the appearance of the digital signature that is added after digitally signing a document. The signature appearance to use or null to use the default appearance.

public abstract SignatureCertificateSelectionMode getSignatureCertificateSelectionMode ()

Defines if the user should be able to select certificates for digitally signing a document, when creating a new signature.

public abstract SignatureColorOptions getSignatureColorOptions ()

Defines the signature color options available when using the "Draw" or "Type" signing UI. Defaults to black, purple, and blue.

Returns

public abstract List<SignatureCreationMode> getSignatureCreationModes ()

The ways in which the user can choose to add their signature. These are shown in the order specified as tabs across the top of the signatures UI. The first entry will be selected initially. If this array contains a single entry then the tabs will be hidden. This array must not be empty and must not contain duplicates.

Returns
  • Returns the configured signature creation modes.

public abstract SignaturePickerOrientation getSignaturePickerOrientation ()

The orientation to use for the signature picker, defaults to AUTOMATIC.

Returns
  • Orientation to use for the signature picker.

public abstract SignatureSavingStrategy getSignatureSavingStrategy ()

The saving strategy used when adding signatures. When the Electronic Signature component is available, saving defaults to NEVER_SAVE. Meanwhile, if the license used is still on legacy signatures, the property will default to SAVE_IF_SELECTED.

Returns
  • The currently used signature saving strategy.

public abstract float getStartZoomScale ()

The scale at which the document should start.

Returns
  • Initial zoom scale of the document.

public abstract ThemeMode getThemeMode ()

Theme mode of the whole app (DEFAULT is default).

Returns

public abstract boolean isAnnotationEditingEnabled ()

Indicates whether the annotation editing is enabled or not.

Returns
  • true if annotation editing functionality should be enabled.

public abstract boolean isAnnotationInspectorEnabled ()

Indicates whether the annotation creation and editing inspectors are enabled.

Returns
  • true when annotation property inspector is enabled.

public abstract boolean isAnnotationLimitedToPageBounds ()

Indicates whether the annotations are limited to the page bounds.

Returns
  • true if annotations cannot be moved outside the page.

public abstract boolean isAnnotationRotationEnabled ()

Indicates whether the annotation rotation is enabled or not.

Returns
  • true if annotation rotation functionality should be enabled.

public abstract boolean isAutoSelectNextFormElementEnabled ()

Indicates whether the auto select next form element functionality is enabled or not (defaults to false).

Returns
  • true if auto select next form element functionality should be enabled.

public abstract boolean isAutomaticLinkGenerationEnabled ()

Whether we automatically generating link annotations for links in the document text is enabled or not. If true we will automatically parse the text and generate clickable links for all URLs and eMail addresses in the document text. Defaults to false.

public abstract boolean isAutosaveEnabled ()

Whether document autosave is enabled.

Returns
  • true if autosave is enabled, false otherwise.

public abstract boolean isContentEditingEnabled ()

Indicates whether the content editing is enabled or not.

Returns
  • true if content editing functionality should be enabled.

public abstract boolean isCopyPasteEnabled ()

Whether copy and paste operations are enabled for annotations. If true we will show copy and cut actions in the editing annotation toolbar. Defaults to true.

Returns
  • true if copy/paste is enabled, false otherwise.

public abstract boolean isFirstPageAlwaysSingle ()

Whether the first page should always be displayed as a single or not, false by default.

Returns
  • true to always display the first page as a single (standalone) even in double page mode, false otherwise.

public abstract boolean isFormEditingEnabled ()

Indicates whether the form editing is enabled or not.

Returns
  • true if form editing functionality should be enabled.

public abstract boolean isInvertColors ()

If the page colors should be inverted (defaults to false).

Returns
  • true is page color will be inverted, false otherwise.

public abstract boolean isJavaScriptEnabled ()

Controls whether JavaScript processing is enabled. Defaults to true.

Note: Processing JavaScript can be slow for documents with a large number of document providers or scripts. Disabling in most cases will not have any negative effects.

Returns
  • true if JavaScript is processing is enabled.

public abstract boolean isLastViewedPageRestorationEnabled ()

Whether restoration of the last viewed page when reopening a document is enabled or not. If true, the last viewed page will be restored when opening the document a second time. If false, the document will be opened at page index 0. Defaults to true.

public abstract boolean isMagnifierEnabled ()

Indicates whether the magnifier is shown when: - The text selection handles are touched. - The measurement annotations are created. Defaults to true.

public abstract boolean isMeasurementsEnabled ()

Indicates whether the measurement tools are enabled or not.

Returns
  • true if measurement tools should be enabled.

public abstract boolean isMultithreadedRenderingEnabled ()

Controls whether multithreaded rendering is enabled, defaults to true.

Returns
  • true when multithreaded rendering is enabled, false otherwise.

public abstract boolean isNoteAnnotationNoZoomHandlingEnabled ()

Whether handling for NOZOOM flag for note annotations is enabled.

Note: Note annotations are always displayed as if NOZOOM flag was set by default - i.e. they won't scale with page.

Returns
  • true if note annotations should respect missing NOZOOM flag and should scale with page when it's not set. false to prevent note annotations scaling with page.

public abstract boolean isPlayingMultipleMediaInstancesEnabled ()

Whether playing multiple media instances is enabled or not.

Returns
  • true to enable multiple media instances, false to always use a single one.

public abstract boolean isRedoEnabled ()

Whether redoing undone edits is enabled. If true we will show redo actions in the toolbar. Defaults to true,

Returns
  • true if redo is enabled, false otherwise.

public abstract boolean isScrollbarsEnabled ()

If the default document scrollbars should be enabled (defaults to true).

Returns
  • true if the scrollbars are enabled, otherwise false.

public abstract boolean isTextSelectionEnabled ()

If text selection (programmatically and via long-press) is enabled (defaults to true).

Returns
  • true if text selection on the document is enabled, false otherwise.

public abstract boolean isTextSelectionPopupToolbarEnabled ()

Whether the text selection popup toolbar is enabled or not. If disabled and used by some PdfActivity, the activity will fall back to using the old text selection toolbar.

Returns
  • true is text selection popup toolbar is enabled, false otherwise.

public abstract boolean isToGrayscale ()

Should the page colors be converted to grayscale (defaults to false).

Returns
  • true is page color will be converted to grayscale, false otherwise.

public abstract boolean isUndoEnabled ()

Whether undoing edits is enabled. If true we will show undo actions in the toolbar. Defaults to true.

Returns
  • true if undo is enabled, false otherwise.

public abstract boolean isVideoPlaybackEnabled ()

Whether video playback is enabled in document.

Returns
  • true if video playback is enabled false otherwise (defaults to false).

public abstract boolean scrollOnEdgeTapEnabled ()

Indicates whether tapping on the page edge causes the page to scroll. Defaults to true enabling navigating the document by tapping the page edges.

public abstract int scrollOnEdgeTapMargin ()

The margin in DP in which taps on the page edge trigger page navigation. Defaults to 24dp.

public abstract boolean shouldZoomOutBounce ()

Should the zoom out below the minimum zoom have a bounce-back effect on a page.

Returns
  • true if the document should bounce when zooming out below the minimum zoom, false otherwise.

public abstract boolean showGapBetweenPages ()

Whether to show gap between pages in double page mode or not. Defaults to false.

Returns
  • true to show the gap between pages, false to join them together.

public abstract boolean showSignHereOverlay ()

Indicates whether the sign here overlay is shown on signature form fields. Defaults to true.

Protected Methods

protected abstract Map<String, Size> getMinimumAnnotationSizeMap ()

Returns a Map of annotation sizes mapped to their type class names.

Returns
  • Map of annotation types to minimum size.