pspdfkit/com.pspdfkit.configuration/PdfConfiguration/Builder

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
@NonNull
open fun allowMultipleBookmarksPerPage(allowed: Boolean): PdfConfiguration.Builder
Sets whether multiple bookmarks per page can be added or not.
Link copied to clipboard
@NonNull
open fun animateScrollOnEdgeTaps(enabled: Boolean): PdfConfiguration.Builder
Sets whether page changes triggered by tapping the page edge cause an animation.
Link copied to clipboard
open fun annotationReplyFeatures(@NonNull annotationReplyFeatures: AnnotationReplyFeatures): PdfConfiguration.Builder
Configures which part of the annotation replies UI is enabled.
Link copied to clipboard
@NonNull
open fun automaticallyGenerateLinks(automaticallyGenerateLinks: Boolean): PdfConfiguration.Builder
Enables or disables automatic link generation.
Link copied to clipboard
@NonNull
open fun autosaveEnabled(isAutosaveEnabled: Boolean): PdfConfiguration.Builder
Enables or disables auto-saving of PDF document changes.
Link copied to clipboard
@NonNull
open fun backgroundColor(@ColorInt backgroundColor: Int): PdfConfiguration.Builder
Sets color of PDF background.
Link copied to clipboard
@NonNull
open fun build(): PdfConfiguration
Creates a @{link PdfConfiguration} with the arguments supplied to this builder.
Link copied to clipboard
@NonNull
open fun disableAnnotationEditing(): PdfConfiguration.Builder
Disables annotation editing functionality.
Link copied to clipboard
@NonNull
open fun disableAnnotationLimitedToPageBounds(): PdfConfiguration.Builder
Disables the page bounds limit imposed when dragging annotations.
Link copied to clipboard
@NonNull
open fun disableAnnotationRotation(): PdfConfiguration.Builder
Disables annotation rotation functionality.
Link copied to clipboard
@NonNull
open fun disableAutoSelectNextFormElement(): PdfConfiguration.Builder
Disables functionality that automatically selects next form element.
Link copied to clipboard
@NonNull
open fun disableContentEditing(): PdfConfiguration.Builder
Disables content editing functionality.
Link copied to clipboard
@NonNull
open fun disableCopyPaste(): PdfConfiguration.Builder
Disables copy and paste of annotations.
Link copied to clipboard
@NonNull
open fun disableFormEditing(): PdfConfiguration.Builder
Disables form editing functionality.
Link copied to clipboard
@NonNull
open fun editableAnnotationTypes(@Nullable editableAnnotationTypes: List<AnnotationType>): PdfConfiguration.Builder
Sets a list of annotation types that can be selected on page and edited.
Link copied to clipboard
@NonNull
open fun enableAnnotationEditing(): PdfConfiguration.Builder
Enables annotation editing functionality.
Link copied to clipboard
@NonNull
open fun enableAnnotationRotation(): PdfConfiguration.Builder
Enables annotation rotation functionality.
Link copied to clipboard
@NonNull
open fun enableAutoSelectNextFormElement(): PdfConfiguration.Builder
Enables functionality that automatically selects next form element.
Link copied to clipboard
@NonNull
open fun enableContentEditing(): PdfConfiguration.Builder
Enables content editing functionality.
Link copied to clipboard
@NonNull
open fun enableCopyPaste(): PdfConfiguration.Builder
Enables copy and paste of annotations.
Link copied to clipboard
@NonNull
open fun enabledAnnotationTools(@Nullable enabledAnnotationTools: List<AnnotationTool>): PdfConfiguration.Builder
Sets a list of annotation tools that are enabled.
Link copied to clipboard
@NonNull
open fun enableFormEditing(): PdfConfiguration.Builder
Enables form editing functionality.
Link copied to clipboard
@NonNull
open fun enableMagnifier(enabled: Boolean): PdfConfiguration.Builder
Sets whether the magnifier is shown when text selection handles are touched.
Link copied to clipboard
@NonNull
open fun excludedAnnotationTypes(@NonNull excludedAnnotationTypes: List<AnnotationType>): PdfConfiguration.Builder
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
@NonNull
open fun fitMode(@NonNull mode: PageFitMode): PdfConfiguration.Builder
Sets the page fit mode, or how the screen should fit the document.
Link copied to clipboard
@NonNull
open fun invertColors(invertColors: Boolean): PdfConfiguration.Builder
Sets if the colors will be inverted in the document.
Link copied to clipboard
@NonNull
open fun layoutMode(@NonNull mode: PageLayoutMode): PdfConfiguration.Builder
Sets the page layout mode, or how the document will layout the pages (as single pages, double pages or automatically).
Link copied to clipboard
open fun loadingProgressDrawable(@Nullable @DrawableRes loadingProgressDrawable: Integer): PdfConfiguration.Builder
Sets a drawable for loading progress throbber while document is loaded.
Link copied to clipboard
@NonNull
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
@NonNull
open fun memoryCacheSize(memoryCacheSize: Int): PdfConfiguration.Builder
Sets the size of memory cache for rendered pages and bitmaps.
Link copied to clipboard
@NonNull
open fun pagePadding(pagePaddingDp: Int): PdfConfiguration.Builder
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
@NonNull
open fun redoEnabled(redoEnabled: Boolean): PdfConfiguration.Builder
Enables or disables redo support.
Link copied to clipboard
@NonNull
open fun restoreLastViewedPage(restoreLastViewedPage: Boolean): PdfConfiguration.Builder
Enables or disables restoration of the last viewed page when reopening a document.
Link copied to clipboard
@NonNull
open fun scrollbarsEnabled(scrollbarsEnabled: Boolean): PdfConfiguration.Builder
Sets the document scrollbars to be enabled or disabled.
Link copied to clipboard
@NonNull
open fun scrollDirection(@NonNull orientation: PageScrollDirection): PdfConfiguration.Builder
Sets scrolling direction for the document.
Link copied to clipboard
@NonNull
open fun scrollMode(@NonNull mode: PageScrollMode): PdfConfiguration.Builder
Sets the page scrolling mode - if the scrolling position will always snap to page or not.
Link copied to clipboard
@NonNull
open fun scrollOnEdgeTapEnabled(enabled: Boolean): PdfConfiguration.Builder
Sets whether taps on the edge of a page scroll to the next / previous page.
Link copied to clipboard
@NonNull
open fun scrollOnEdgeTapMargin(@IntRange(from = 1) marginDp: Int): PdfConfiguration.Builder
Margin in dp in which taps on the edge of the page will trigger the page navigation.
Link copied to clipboard
open fun setAnnotationInspectorEnabled(isEnabled: Boolean): PdfConfiguration.Builder
Sets whether the annotation inspector is enabled.
Link copied to clipboard
Link copied to clipboard
open fun setEnabledShareFeatures(@NonNull enabledShareFeatures: EnumSet<ShareFeatures>): PdfConfiguration.Builder
Configures which share features are enabled in the UI.
Link copied to clipboard
open fun setEnableNoteAnnotationNoZoomHandling(noZoomHandlingEnabled: Boolean): PdfConfiguration.Builder
Enables or disables handling for NOZOOM flag for note annotations.
Link copied to clipboard
@NonNull
open fun setFixedLowResRenderPixelCount(@Nullable fixedLowResRenderPixelCount: Integer): PdfConfiguration.Builder
Sets the number of pixels in low resolution renderings to a fixed size.
Link copied to clipboard
@NonNull
open fun setFormElementDateAndTimePickerEnabled(enabled: Boolean): PdfConfiguration.Builder
Enables/Disables date and time picker for form elements.
Link copied to clipboard
@NonNull
open fun setJavaScriptEnabled(isEnabled: Boolean): PdfConfiguration.Builder
Enables or disables JavaScript processing.
Link copied to clipboard
@NonNull
open fun setMeasurementToolsEnabled(measurementToolsEnabled: Boolean): PdfConfiguration.Builder
Enables or disables measurement tools functionality.
Link copied to clipboard
@NonNull
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
open fun setResizeGuideSnapAllowance(@FloatRange(from = 0.0) snapAllowance: Float): PdfConfiguration.Builder
Sets how aggressively the resize guides works.
open fun setSelectedAnnotationFontScalingOnResizeEnabled(enabled: Boolean): PdfConfiguration.Builder
Enables or disables font scaling for Freetext annotations when resizing with the bottom right resize handle.
Link copied to clipboard
@NonNull
open fun setSelectedAnnotationResizeEnabled(enabled: Boolean): PdfConfiguration.Builder
Enable or disable resizing of selected annotations.
Link copied to clipboard
open fun setSelectedAnnotationResizeGuidesEnabled(enabled: Boolean): PdfConfiguration.Builder
Enables or disables resize guides.
Link copied to clipboard
@NonNull
open fun setSignaturePickerOrientation(@NonNull orientation: SignaturePickerOrientation): PdfConfiguration.Builder
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
@NonNull
open fun showSignHereOverlay(showOverlay: Boolean): PdfConfiguration.Builder
Sets whether the sign here overlay is shown inside of signature form fields.
Link copied to clipboard
@NonNull
open fun signatureAppearance(@Nullable signatureAppearance: SignatureAppearance): PdfConfiguration.Builder
Defines the appearance of the digital signature that is added after digitally signing a document.
Link copied to clipboard
@NonNull
open fun signatureCertificateSelectionMode(@NonNull signatureCertificateSelectionMode: SignatureCertificateSelectionMode): PdfConfiguration.Builder
Defines if the user should be able to select certificates for digitally signing a document, when creating a new signature.
Link copied to clipboard
@NonNull
open fun signatureColorOptions(@NonNull signatureColorOptions: SignatureColorOptions): PdfConfiguration.Builder
Defines the 3 signature color options available when using the Electronic Signatures "Draw" or "Type" signing UI.
Link copied to clipboard
@NonNull
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
@NonNull
open fun signatureSavingStrategy(@NonNull signatureSavingStrategy: SignatureSavingStrategy): PdfConfiguration.Builder
Defines if a signature should be saved after creation.
Link copied to clipboard
@NonNull
open fun startZoomScale(startZoomScale: Float): PdfConfiguration.Builder
Sets the start scale at which the document will be displayed.
Link copied to clipboard
@NonNull
open fun textSelectionEnabled(isTextSelectionEnabled: Boolean): PdfConfiguration.Builder
Enables or disables text selection (both programmatically and via long-press gesture).
Link copied to clipboard
@NonNull
open fun textSelectionPopupToolbarEnabled(enabled: Boolean): PdfConfiguration.Builder
Sets whether the text selection popup toolbar is enabled or not.
Link copied to clipboard
@NonNull
open fun themeMode(@NonNull mode: ThemeMode): PdfConfiguration.Builder
Sets the app theme mode.
Link copied to clipboard
@NonNull
open fun toGrayscale(toGrayscale: Boolean): PdfConfiguration.Builder
Sets if the colors will be converted to grayscale.
Link copied to clipboard
@NonNull
open fun undoEnabled(undoEnabled: Boolean): PdfConfiguration.Builder
Enables or disables undo support.
Link copied to clipboard
@NonNull
open fun videoPlaybackEnabled(videoPlaybackEnabled: Boolean): PdfConfiguration.Builder
Enables or disables video playback.
Link copied to clipboard
@NonNull
open fun zoomOutBounce(zoomOutBounce: Boolean): PdfConfiguration.Builder
Should the zoom out below the minimum zoom have a bounce-back effect on a page.