Builder

open class Builder

Builder used to construct a PdfActivityConfiguration instance.

Constructors

Link copied to clipboard
constructor(@NonNull context: Context)
Creates a new com.pspdfkit.ui.PdfActivity configuration builder.
constructor(@NonNull configuration: PdfActivityConfiguration)
Create a new builder from existing configuration.
constructor(@NonNull configuration: PdfActivityConfiguration, @StyleRes themeRes: Int)
Create a new builder from existing configuration.
constructor(@NonNull configuration: PdfActivityConfiguration, @StyleRes themeRes: Int, @StyleRes themeDarkRes: Int)
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
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 autosaving of modified PDF documents.
Link copied to clipboard
Sets color of PDF background.
Link copied to clipboard
Link copied to clipboard
Replaces all properties from the PdfConfiguration
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 the list of annotations.
Link copied to clipboard
Disables annotation rotation functionality.
Link copied to clipboard
Disabled editing controls on the bookmarks list.
Link copied to clipboard
Disables the display of bookmarks.
Link copied to clipboard
Disables content editing functionality.
Link copied to clipboard
Disables copy and paste of annotations.
Link copied to clipboard
Disables document editing functionality in the page grid.
Link copied to clipboard
Disables the document info view.
Link copied to clipboard
Disables form editing functionality.
Link copied to clipboard
Disables outline menu in the activity.
Link copied to clipboard
Hides printing option in the sharing menu even if printing can be done on the device.
Link copied to clipboard
Disables document search 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 the list of annotations.
Link copied to clipboard
Enables annotation rotation functionality.
Link copied to clipboard
Enables editing controls on the bookmarks list.
Link copied to clipboard
Enables the display of bookmarks.
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 document editing functionality in the page grid.
Link copied to clipboard
Enables the document info view.
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
Enables outline menu in the activity.
Link copied to clipboard
Enables printing option in the menu if applicable for the document and the device.
Link copied to clipboard
Sets whether we enable the reader view in the activity or not.
Link copied to clipboard
Enables document search functionality.
Link copied to clipboard
Sets a list of annotation types that will be excluded from rendering.
Link copied to clipboard
Sets whether the first page should always be displayed as a single or not.
Link copied to clipboard
Sets the page fit mode.
Forces the signature button to show up in the main toolbar.
Link copied to clipboard
Hides the overlay displaying the document title.
Link copied to clipboard
Hides the navigation buttons.
Link copied to clipboard
Hides page labels (if any).
Link copied to clipboard
Hides the overlay displaying currently selected page.
Link copied to clipboard
Hides the settings menu icon.
Link copied to clipboard
Hides the actionbar icon to show grid of thumbnail pages.
Link copied to clipboard
Sets to automatically hide user interface controls when annotation creation toolbar position is in vertical position (left/right).
Link copied to clipboard
Sets if the colors will be inverted in the document.
Link copied to clipboard
Sets a layoutRes used by the launched activity.
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 the annotation types that should be displayed in the annotation list.
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): PdfActivityConfiguration.Builder
Sets the maximum zoom scale at which the document should be displayed.
Link copied to clipboard
Sets size of memory cache for rendered pages and bitmaps.
Link copied to clipboard
open fun page(@IntRange(from = 0) pageIndex: Int): PdfActivityConfiguration.Builder
Sets the page to start the document at.
Link copied to clipboard
Sets the padding between pages.
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 the scrolling direction (i.e.
Link copied to clipboard
Sets the scrolling mode.
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 configuration used for searching, applied to search views.
Link copied to clipboard
Sets whether the annotation inspector is enabled.
Link copied to clipboard
Sets whether reordering annotations in the annotation list is enabled.
Link copied to clipboard
Enables or disables visual indicator shown for annotations that have annotation notes.
Link copied to clipboard
The documeninfo view is now by default in a separate window and no longer in the outlineview.
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
Enables or disables JavaScript processing.
Link copied to clipboard
Enables or disables measurement tools functionality.
Link copied to clipboard
Sets whether the multithreaded rendering should be enabled.
Link copied to clipboard
Sets whether we show the UI to apply redactions when there are in the document or not.
Link copied to clipboard
open fun setResizeGuideLineIntervals(@NonNull @Size(min = 2, multiple = 2) intervals: List<Float>): PdfActivityConfiguration.Builder
Sets guide line on/off intervals sizes.
Link copied to clipboard
Sets how aggressively the resize guides works.
Link copied to clipboard
Sets the search type (if search is enabled).
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 items to show in the settings menu.
Link copied to clipboard
Sets the orientation to use for the signature picker.
Link copied to clipboard
Configures the tab bar hiding mode.
Link copied to clipboard
Sets the thumbnail bar mode.
Link copied to clipboard
Sets the user interface view mode.
Link copied to clipboard
Enables or disables volume buttons navigation.
Link copied to clipboard
Shows overlay displaying the document title.
Link copied to clipboard
Sets whether to show gao between pages in double page mode or not.
Link copied to clipboard
Shows the navigation buttons.
Link copied to clipboard
Sets whether the note editor should be started automatically for newly created note annotations.
Link copied to clipboard
Enables display of the page labels (if any).
Link copied to clipboard
Shows overlay displaying current page number over document.
Link copied to clipboard
Shows the settings menu icon.
Link copied to clipboard
Sets whether the sign here overlay is shown inside of signature form fields.
Link copied to clipboard
Displays an actionbar icon to show grid of thumbnail pages.
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
The ways in which the user can choose to add their signature.
Link copied to clipboard
Signature saving strategy used within the dialog when adding signatures.
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 a themeRes used to override default activity theme.
Link copied to clipboard
Sets a themeDarkRes used to override dark activity theme.
Link copied to clipboard
Sets the app theme mode.
Link copied to clipboard
Sets the actionbar activity title.
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
Enabled immersive fullscreen mode in the activity.
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.