Builder

class Builder

Builder used to construct PdfConfiguration instance.

Constructors

Link copied to clipboard
constructor()
Creates a new PdfConfiguration builder.
constructor(@NonNull configuration: PdfConfiguration)
Create a new builder from existing configuration.

Functions

Link copied to clipboard
Sets whether multiple bookmarks per page can be added or not.
Link copied to clipboard
Sets whether page changes triggered by tapping the page edge cause an animation.
Link copied to clipboard
Sets whether the annotation popup toolbar is enabled or not.
Link copied to clipboard
Configures which part of the annotation replies UI is enabled.
Link copied to clipboard
Enables or disables automatic link generation.
Link copied to clipboard
Enables or disables auto-saving of PDF document changes.
Link copied to clipboard
Sets color of PDF background.
Link copied to clipboard
Creates a @{link PdfConfiguration} with the arguments supplied to this builder.
Link copied to clipboard
Disables annotation editing functionality.
Link copied to clipboard
Disables the page bounds limit imposed when dragging annotations.
Link copied to clipboard
Disables annotation rotation functionality.
Link copied to clipboard
Disables functionality that automatically selects next form element.
Link copied to clipboard
Disables content editing functionality.
Link copied to clipboard
Disables copy and paste of annotations.
Link copied to clipboard
Disables form editing functionality.
Link copied to clipboard
Sets a list of annotation types that can be selected on page and edited.
Link copied to clipboard
Enables annotation editing functionality.
Link copied to clipboard
Enables annotation rotation functionality.
Link copied to clipboard
Enables functionality that automatically selects next form element.
Link copied to clipboard
Enables content editing functionality.
Link copied to clipboard
Enables copy and paste of annotations.
Link copied to clipboard
Sets a list of annotation tools that are enabled.
Link copied to clipboard
Enables form editing functionality.
Link copied to clipboard
Sets whether the magnifier is shown when text selection handles are touched.
Link copied to clipboard
open fun enableStylusOnDetection(enableStylusOnDetection: Boolean): PdfConfiguration.Builder
Indicates whether we should automatically detect the stylus.
Link copied to clipboard
Sets a list of annotation types that will be excluded from rendering.
Link copied to clipboard
open fun firstPageAlwaysSingle(firstPageAlwaysSingle: Boolean): PdfConfiguration.Builder
Sets whether the first page should always be displayed as a single or not.
Link copied to clipboard
Sets the page fit mode, or how the screen should fit the document.
Link copied to clipboard
Sets if the colors will be inverted in the document.
Link copied to clipboard
Sets the page layout mode, or how the document will layout the pages (as single pages, double pages or automatically).
Link copied to clipboard
Sets a drawable for loading progress throbber while document is loaded.
Link copied to clipboard
open fun maxZoomScale(@FloatRange(from = 1.0, to = 20.0) scale: Float): PdfConfiguration.Builder
Sets the maximum zoom scale at which the document should be displayed.
Link copied to clipboard
Sets the size of memory cache for rendered pages and bitmaps.
Link copied to clipboard
Sets the padding between pages.
Link copied to clipboard
open fun playingMultipleMediaInstancesEnabled(playingMultipleMediaInstancesEnabled: Boolean): PdfConfiguration.Builder
Sets whether playing multiple media instances is enabled or not.
Link copied to clipboard
Enables or disables redo support.
Link copied to clipboard
Enables or disables restoration of the last viewed page when reopening a document.
Link copied to clipboard
Sets the document scrollbars to be enabled or disabled.
Link copied to clipboard
Sets scrolling direction for the document.
Link copied to clipboard
Sets the page scrolling mode - if the scrolling position will always snap to page or not.
Link copied to clipboard
Sets whether taps on the edge of a page scroll to the next / previous page.
Link copied to clipboard
Margin in dp in which taps on the edge of the page will trigger the page navigation.
Link copied to clipboard
Sets whether the annotation inspector is enabled.
Link copied to clipboard
Link copied to clipboard
Configures which share features are enabled in the UI.
Link copied to clipboard
Enables or disables handling for NOZOOM flag for note annotations.
Link copied to clipboard
Sets the number of pixels in low resolution renderings to a fixed size.
Link copied to clipboard
Enables/Disables date and time picker for form elements.
Link copied to clipboard
Enables or disables JavaScript processing.
Link copied to clipboard
Enables or disables measurement tools functionality.
Link copied to clipboard
open fun setMultithreadedRenderingEnabled(isMultithreadedRenderingEnabled: Boolean): PdfConfiguration.Builder
Sets whether the multithreaded rendering should be enabled.
Link copied to clipboard
open fun setResizeGuideLineIntervals(@NonNull @Size(min = 2, multiple = 2) intervals: List<Float>): PdfConfiguration.Builder
Sets guide line on/off intervals sizes.
Link copied to clipboard
Sets how aggressively the resize guides works.
Enables or disables font scaling for Freetext annotations when resizing with the bottom right resize handle.
Link copied to clipboard
Enable or disable resizing of selected annotations.
Link copied to clipboard
Enables or disables resize guides.
Link copied to clipboard
Sets the orientation to use for the signature picker.
Link copied to clipboard
open fun showGapBetweenPages(showGapBetweenPages: Boolean): PdfConfiguration.Builder
Sets whether to show gao between pages in double page mode or not.
Link copied to clipboard
open fun showNoteEditorForNewNoteAnnotations(showNoteEditorForNewNoteAnnotations: Boolean): PdfConfiguration.Builder
Sets whether the note editor should be started automatically for newly created note annotations.
Link copied to clipboard
Sets whether the sign here overlay is shown inside of signature form fields.
Link copied to clipboard
Defines the appearance of the digital signature that is added after digitally signing a document.
Link copied to clipboard
Defines if the user should be able to select certificates for digitally signing a document, when creating a new signature.
Link copied to clipboard
Defines the 3 signature color options available when using the Electronic Signatures "Draw" or "Type" signing UI.
Link copied to clipboard
open fun signatureCreationModes(@NonNull @Size(min = 1, max = 3) signatureCreationModes: List<SignatureCreationMode>): PdfConfiguration.Builder
The ways in which the user can choose to add their signature.
Link copied to clipboard
Defines if a signature should be saved after creation.
Link copied to clipboard
Sets the start scale at which the document will be displayed.
Link copied to clipboard
Enables or disables text selection (both programmatically and via long-press gesture).
Link copied to clipboard
Sets whether the text selection popup toolbar is enabled or not.
Link copied to clipboard
Sets the app theme mode.
Link copied to clipboard
Sets if the colors will be converted to grayscale.
Link copied to clipboard
Enables or disables undo support.
Link copied to clipboard
Enables or disables video playback.
Link copied to clipboard
Should the zoom out below the minimum zoom have a bounce-back effect on a page.