Class PdfConfiguration

  • All Implemented Interfaces:

    public abstract class PdfConfiguration
     implements Parcelable

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

    • Constructor Detail

    • Method Detail

      • isFirstPageAlwaysSingle

         abstract boolean isFirstPageAlwaysSingle()

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

      • showGapBetweenPages

         abstract boolean showGapBetweenPages()

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

      • isScrollbarsEnabled

         abstract boolean isScrollbarsEnabled()

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

      • getMemoryCacheSize

         abstract int getMemoryCacheSize()

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

      • isInvertColors

         abstract boolean isInvertColors()

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

      • isToGrayscale

         abstract boolean isToGrayscale()

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

      • getStartZoomScale

         abstract float getStartZoomScale()

        The scale at which the document should start.

      • getMaxZoomScale

         abstract float getMaxZoomScale()

        Maximum zoom scale in the document.

      • shouldZoomOutBounce

         abstract boolean shouldZoomOutBounce()

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

      • isTextSelectionEnabled

         abstract boolean isTextSelectionEnabled()

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

      • isFormEditingEnabled

         abstract boolean isFormEditingEnabled()

        Indicates whether the form editing is enabled or not.

      • isAutoSelectNextFormElementEnabled

         abstract boolean isAutoSelectNextFormElementEnabled()

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

      • isFormElementDateAndTimePickerEnabled

         abstract boolean isFormElementDateAndTimePickerEnabled()

        Indicates whether the date and time pickers should be enabled for according form elements (defaults to true)

      • isAnnotationEditingEnabled

         abstract boolean isAnnotationEditingEnabled()

        Indicates whether the annotation editing is enabled or not.

      • isAnnotationRotationEnabled

         abstract boolean isAnnotationRotationEnabled()

        Indicates whether the annotation rotation is enabled or not.

      • isContentEditingEnabled

         abstract boolean isContentEditingEnabled()

        Indicates whether the content editing is enabled or not.

      • isMeasurementsEnabled

         abstract boolean isMeasurementsEnabled()

        Indicates whether the measurement tools are enabled or not.

      • getSelectedAnnotationResizeGuidesEnabled

         abstract boolean getSelectedAnnotationResizeGuidesEnabled()

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

      • getSelectedAnnotationFontScalingOnResizeEnabled

         abstract boolean getSelectedAnnotationFontScalingOnResizeEnabled()

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

      • getGuideLineIntervals

        @Size(min = 2, multiple = 2) 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.

      • isAnnotationInspectorEnabled

         abstract boolean isAnnotationInspectorEnabled()

        Indicates whether the annotation creation and editing inspectors are enabled.

      • isAutosaveEnabled

         abstract boolean isAutosaveEnabled()

        Whether document autosave is enabled.

      • getPagePadding

         abstract int getPagePadding()

        The padding between pages (defaults to 16dp).

      • isVideoPlaybackEnabled

         abstract boolean isVideoPlaybackEnabled()

        Whether video playback is enabled in document.

      • isLastViewedPageRestorationEnabled

         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.

      • isAutomaticLinkGenerationEnabled

         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.

      • isCopyPasteEnabled

         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.

      • isUndoEnabled

         abstract boolean isUndoEnabled()

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

      • isRedoEnabled

         abstract boolean isRedoEnabled()

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

      • isMultithreadedRenderingEnabled

         abstract boolean isMultithreadedRenderingEnabled()

        Controls whether multithreaded rendering is enabled, defaults to true.

      • getSignatureCreationModes

        @NonNull()@Size(min = 1, max = 3) 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.

      • getSignatureAppearance

        @Nullable() 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.

      • isNoteAnnotationNoZoomHandlingEnabled

         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.

      • isJavaScriptEnabled

         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.

      • allowMultipleBookmarksPerPage

         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.

      • scrollOnEdgeTapEnabled

         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.

      • animateScrollOnEdgeTaps

         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.

      • scrollOnEdgeTapMargin

         abstract int scrollOnEdgeTapMargin()

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

      • isMagnifierEnabled

         abstract boolean isMagnifierEnabled()

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

      • showSignHereOverlay

         abstract boolean showSignHereOverlay()

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

      • showNoteEditorForNewNoteAnnotations

         abstract boolean showNoteEditorForNewNoteAnnotations()

        Indicates whether the NoteEditor should be shown automatically when creating new note. Defaults to true.