public static class

AnnotationRenderConfiguration.Builder

extends Object
java.lang.Object
   ↳ com.pspdfkit.configuration.rendering.AnnotationRenderConfiguration.Builder

Class Overview

Builder to create a AnnotationRenderConfiguration instance.

Summary

Public Constructors
Builder()
Public Methods
AnnotationRenderConfiguration build()
Creates the configuration for annotation rendering.
AnnotationRenderConfiguration.Builder formHighlightColor(Integer color)
Sets color used for highlighting editable form fields.
AnnotationRenderConfiguration.Builder formItemHighlightColor(Integer color)
Sets color used for highlighting selected items inside lists, combo boxes and similar.
AnnotationRenderConfiguration.Builder formRequiredFieldBorderColor(Integer color)
Sets color of the border around required form fields.
AnnotationRenderConfiguration.Builder invertColors(boolean invertColors)
Sets whether annotation colors will be inverted in the rendering.
AnnotationRenderConfiguration.Builder redactionAnnotationPreviewEnabled(boolean enable)
Sets redaction annotation preview enabled, false by default.
AnnotationRenderConfiguration.Builder showSignHereOverlay(boolean showOverlay)
Sets whether or not the sign here overlay in signature form fields should be shown.
AnnotationRenderConfiguration.Builder signHereOverlayBackgroundColor(Integer color)
Sets color of the background of the sign here arrow.
AnnotationRenderConfiguration.Builder toGrayscale(boolean toGrayscale)
Sets whether annotation colors will be converted to grayscale.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Builder ()

Public Methods

public AnnotationRenderConfiguration build ()

Creates the configuration for annotation rendering.

public AnnotationRenderConfiguration.Builder formHighlightColor (Integer color)

Sets color used for highlighting editable form fields. Each editable form field is overlaid with rectangle filled with this color.

Parameters
color ARGB color integer (can be Color#TRANSPARENT) or null to use default color (#330036FF).

public AnnotationRenderConfiguration.Builder formItemHighlightColor (Integer color)

Sets color used for highlighting selected items inside lists, combo boxes and similar.

Parameters
color ARGB color integer (can be Color#TRANSPARENT) or null to use default color (#339AC1D9).

public AnnotationRenderConfiguration.Builder formRequiredFieldBorderColor (Integer color)

Sets color of the border around required form fields.

Parameters
color ARGB color integer (can be Color#TRANSPARENT) or null to use default color (#FFFF0000).

public AnnotationRenderConfiguration.Builder invertColors (boolean invertColors)

Sets whether annotation colors will be inverted in the rendering.

Parameters
invertColors true to invert colors, false otherwise.

public AnnotationRenderConfiguration.Builder redactionAnnotationPreviewEnabled (boolean enable)

Sets redaction annotation preview enabled, false by default.

Parameters
enable true to enable redaction annotation preview.

public AnnotationRenderConfiguration.Builder showSignHereOverlay (boolean showOverlay)

Sets whether or not the sign here overlay in signature form fields should be shown. true by default.

Parameters
showOverlay true to show the sign here overlay, false to hide it.

public AnnotationRenderConfiguration.Builder signHereOverlayBackgroundColor (Integer color)

Sets color of the background of the sign here arrow.

Parameters
color ARGB color integer or Color#TRANSPARENT to not show the background.

public AnnotationRenderConfiguration.Builder toGrayscale (boolean toGrayscale)

Sets whether annotation colors will be converted to grayscale.

Parameters
toGrayscale true to covert to grayscale, false otherwise.