PdfConfiguration.Builder

Creates a new PdfConfiguration builder.

Create a new builder from existing configuration.

Sets whether multiple bookmarks per page can be added or not. If disabled only one bookmark will be allowed per page. Defaults to false allowing only one bookmark per page.

Sets whether page changes triggered by tapping the page edge cause an animation. Defaults to false making the transition instant.

Configures which part of the annotation replies UI is enabled. If ENABLED, the replies can be added to note annotations and annotation notes. If READ_ONLY, the replies can be looked at but none can be added or modified. If DISABLED, the reply UI is disabled entirely. This feature is only UI specific, defining the replies availability in the PdfFragment's UI. The API for retrieving and adding replies still works even if this property is DISABLED.

Enables or disables automatic link generation. If true we will automatically parse the text and generate clickable links for all URLs and eMail addresses in the document text.

Enables or disables auto-saving of PDF document changes. This is enabled by default.

Sets color of PDF background. White by default.

Creates a @{link PdfConfiguration} with the arguments supplied to this builder.

Defines the default signer to be selected when signing a document.

Disables annotation editing functionality.

Disables the page bounds limit imposed when dragging annotations. By default this is enabled. Note: this is an experimental feature - we cannot guarantee flawless behaviour or that it won't change in future.

Disables annotation rotation functionality.

Disables functionality that automatically selects next form element. Disabled by default.

Disables copy and paste of annotations.

Disables form editing functionality.

Sets a list of annotation types that can be selected on page and edited.

Enables annotation editing functionality.

Enables annotation rotation functionality.

Enables functionality that automatically selects next form element. Disabled by default.

Enables copy and paste of annotations.

Enables form editing functionality.

Sets whether the magnifier is shown when text selection handles are touched. Defaults to true.

Sets a list of annotation tools that are enabled.

Note: AnnotationTool will be enabled only when its underlying annotation type (toAnnotationType()) is editable (see editableAnnotationTypes(List)) and annotation editing is enabled (see enableAnnotationEditing()).

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

Sets whether the first page should always be displayed as a single or not. This is notable only if double page mode is active.

Sets the page fit mode, or how the screen should fit the document. Default is fit-to-page.

Sets if the colors will be inverted in the document. This is disabled by default.

Sets the page layout mode, or how the document will layout the pages (as single pages, double pages or automatically).

Sets a drawable for loading progress throbber while document is loaded.

Sets the maximum zoom scale at which the document should be displayed. Make sure this value is higher than defaultZoomScale.

Default value: {@value PdfFragment#MAX_ZOOM}.

Allowed interval: [1.0, 20.0]

Sets the size of memory cache for rendered pages and bitmaps. It defaults to 1/4 of available heap size of the app. Note that disabling this might lead to severe performance problems.

Sets the padding between pages. Defaults to 16dp.

Sets whether playing multiple media instances is enabled or not. This is disabled by default.

Enables or disables redo support. If true we will allow the user to redo changes that were undone before. If false the user will not be able to redo edits. If undo is disabled setting this to true will not do anything.

Enables or disables restoration of the last viewed page when reopening a document. 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.

Sets scrolling direction for the document.

Sets the page scrolling mode - if the scrolling position will always snap to page or not.

Sets whether taps on the edge of a page scroll to the next / previous page. Defaults to true enabling scrolling by tapping the edge of pages.

Margin in dp in which taps on the edge of the page will trigger the page navigation. Defaults to 24dp.

Sets the document scrollbars to be enabled or disabled.

Sets whether the annotation inspector is enabled. This defaults to true.

Enables or disables handling for NOZOOM flag for note annotations. Note annotations are always displayed as if NOZOOM flag was set by default.

Sets the CopyPasteFeatures that are enabled. Defaults to all features being enabled.

Configures which share features are enabled in the UI. This feature is only UI specific, defining the available sharing features in the PdfFragment. The sharing API still works even if a specific share feature is disabled.

Sets the number of pixels in low resolution renderings to a fixed size. By default, the size (i.e. the resolution) of low-res page renderings inside the PdfFragment will be set to an optimized pixel count, based on the device specs and performance. Using this method, you can override the default and set it to a fixed value.

Enables or disables JavaScript processing. 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.

Enables or disables measurement tools functionality.

Sets the minimum annotation size for all annotations of the given type in PDF points.

Sets whether the multithreaded rendering should be enabled. Defaults to true.

Multithreaded rendering speeds up page rendering. Disabling it may speed things up if, for example, you know you only have to render single page of the document.

Sets 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. Defaults to [5f, 20f].

Sets how aggressively the resize guides works. Defaults to 30.0f.

Enables or disables font scaling for Freetext annotations when resizing with the bottom right resize handle. This defaults to true.

Enable or disable resizing of selected annotations. This defaults to true.

Enables or disables resize guides. This defaults to true.

Sets the orientation to use for the signature picker. Defaults to AUTOMATIC.

Sets whether to show gao between pages in double page mode or not.

Sets whether the sign here overlay is shown inside of signature form fields. Defaults to true.

Defines the appearance of the digital signature that is added after digitally signing a document. Things to configure include the graphic to use for the signature or whether the time of signing should be shown. For the full list of properties check SignatureAppearance.

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

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

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.

Defines if a signature should be saved after creation. When the Electronic Signature component is available, saving defaults to NEVER_SAVE. If the license used is on Legacy Signatures, the property will default to SAVE_IF_SELECTED. If not set to NEVER_SAVE then a storage database must be passed to setSignatureStorage(SignatureStorage).

Sets the start scale at which the document will be displayed.

Default value: {@value PdfFragment#DEFAULT_ZOOM}

Enables or disables text selection (both programmatically and via long-press gesture). This is enabled by default.

Sets whether the text selection popup toolbar is enabled or not. If disabled, and this configuration is used within your PdfActivity, the old text selection toolbar will be used.

Sets the app theme mode. Night mode automatically inverts colors.

Sets if the colors will be converted to grayscale. This is disabled by default.

Enables or disables undo support. If true we will keep track of edits to the document and allow the user to undo actions. If false the user will not be able to undo edits and redo will also be disabled.

Enables or disables video playback. By default, video playback would be disabled unless the device is deemed secure, meaning the device is running at least Android Marshmallow (API 23+) with security patch dating Feb 1st, 2016 or newer.

Feb 1st, 2016 patch fixes a Critical security vulnerability that could enable remote code execution on an affected device through multiple methods such as email, web browsing, and MMS when processing media files.

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