pspdfkit/com.pspdfkit.configuration.rendering/PageRenderConfiguration/Builder

Builder

open class Builder

Builder to create a PageRenderConfiguration instance

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
open fun build(): PageRenderConfiguration
Creates the configuration for page rendering.
Link copied to clipboard
@NonNull
open fun cache(useCache: Boolean): PageRenderConfiguration.Builder
Use PSPDFKits disk and memory cache to render subsequent bitmaps faster.
Link copied to clipboard
@NonNull
open fun excludedAnnotations(excludedAnnotations: List<Integer>): PageRenderConfiguration.Builder
Sets the list of annotations (by object numbers) to be excluded from rendering.
Link copied to clipboard
@NonNull
open fun excludedAnnotationTypes(excludedAnnotationTypes: List<AnnotationType>): PageRenderConfiguration.Builder
Sets the list of annotations (by type) to be excluded from rendering.
Link copied to clipboard
@NonNull
open fun formHighlightColor(@ColorInt color: Int): PageRenderConfiguration.Builder
Sets color used for highlighting editable form fields.
Link copied to clipboard
@NonNull
open fun formItemHighlightColor(@ColorInt color: Int): PageRenderConfiguration.Builder
Sets color used for highlighting selected items inside lists, combo boxes and similar.
Link copied to clipboard
@NonNull
open fun formRequiredFieldBorderColor(@ColorInt color: Int): PageRenderConfiguration.Builder
Sets color of the border around required form fields.
Link copied to clipboard
@NonNull
open fun invertColors(invertColors: Boolean): PageRenderConfiguration.Builder
Sets if the colors will be inverted in the document.
Link copied to clipboard
@NonNull
open fun paperColor(@ColorInt color: Int): PageRenderConfiguration.Builder
Background paper color for contents.
Link copied to clipboard
@NonNull
open fun redactionAnnotationPreviewEnabled(enable: Boolean): PageRenderConfiguration.Builder
Sets redaction annotation preview enabled, false by default.
Link copied to clipboard
@NonNull
open fun region(x: Int, y: Int, fullPageWidth: Int, fullPageHeight: Int): PageRenderConfiguration.Builder
Render a sub-region of the page.
Link copied to clipboard
Link copied to clipboard
@NonNull
open fun reuseBitmap(@Nullable bitmap: Bitmap): PageRenderConfiguration.Builder
Reuse bitmap as the rendering target and prevent allocation of new one.
Link copied to clipboard
@NonNull
open fun showSignHereOverlay(showOverlay: Boolean): PageRenderConfiguration.Builder
Sets whether or not the sign here overlay in signature form fields should be shown.
Link copied to clipboard
@NonNull
open fun signHereOverlayBackgroundColor(@ColorInt @Nullable color: Integer): PageRenderConfiguration.Builder
Sets color of the background of the sign here arrow.
Link copied to clipboard
@NonNull
open fun toGrayscale(toGrayscale: Boolean): PageRenderConfiguration.Builder
Sets if the colors will be converted to grayscale.