public static class

SignatureAppearance.Builder

extends Object
java.lang.Object
   ↳ com.pspdfkit.signatures.SignatureAppearance.Builder

Class Overview

A helper class used for building the SignatureAppearance.

Summary

Public Constructors
Builder()
Public Methods
SignatureAppearance build()
Build the SignatureAppearance object from the provided properties.
SignatureAppearance.Builder setReuseExistingSignatureAppearanceStream(boolean reuseExistingSignatureAppearanceStream)
Controls whether or not an existing appearance stream for the signature should be used.
SignatureAppearance.Builder setShowSignDate(boolean showSignDate)
Indicates whether the date of the signature will be shown or not.
SignatureAppearance.Builder setShowSignatureLocation(boolean showSignatureLocation)
Indicates whether or not the location where the signature was created will be shown.
SignatureAppearance.Builder setShowSignatureReason(boolean showSignatureReason)
Indicates whether or not the reason for the signature will be shown.
SignatureAppearance.Builder setShowSignerName(boolean showSignerName)
Indicates whether the name of the signer will be shown or not.
SignatureAppearance.Builder setShowWatermark(boolean showWatermark)
Indicates whether the PSPDFKit watermark with be shown.
SignatureAppearance.Builder setSignatureAppearanceMode(SignatureAppearance.SignatureAppearanceMode signatureAppearanceMode)
The SignatureAppearance.SignatureAppearanceMode controls how the signature will be displayed.
SignatureAppearance.Builder setSignatureGraphic(SignatureAppearance.SignatureGraphic signatureGraphic)
The SignatureAppearance.SignatureGraphic can be displayed instead of the signer name.
SignatureAppearance.Builder setSignatureWatermark(SignatureAppearance.SignatureGraphic signatureWatermark)
The SignatureAppearance.SignatureGraphic to be displayed as the watermark.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Builder ()

Public Methods

public SignatureAppearance build ()

Build the SignatureAppearance object from the provided properties.

Returns

public SignatureAppearance.Builder setReuseExistingSignatureAppearanceStream (boolean reuseExistingSignatureAppearanceStream)

Controls whether or not an existing appearance stream for the signature should be used. Defaults to true.

Parameters
reuseExistingSignatureAppearanceStream true if an existing appearance stream should be reused, false otherwise.

public SignatureAppearance.Builder setShowSignDate (boolean showSignDate)

Indicates whether the date of the signature will be shown or not. Defaults to true.

Parameters
showSignDate true if the date should be shown, false otherwise.

public SignatureAppearance.Builder setShowSignatureLocation (boolean showSignatureLocation)

Indicates whether or not the location where the signature was created will be shown. Defaults to false.

Parameters
showSignatureLocation true if the location should be shown, false otherwise.

public SignatureAppearance.Builder setShowSignatureReason (boolean showSignatureReason)

Indicates whether or not the reason for the signature will be shown. Defaults to false.

Parameters
showSignatureReason true if the reason should be shown, false otherwise.

public SignatureAppearance.Builder setShowSignerName (boolean showSignerName)

Indicates whether the name of the signer will be shown or not. Defaults to true.

Parameters
showSignerName true if the name of the signer should be shown, false otherwise.

public SignatureAppearance.Builder setShowWatermark (boolean showWatermark)

Indicates whether the PSPDFKit watermark with be shown. Defaults to true.

Parameters
showWatermark true if the PSPDFKit watermark should be shown, false otherwise.

public SignatureAppearance.Builder setSignatureAppearanceMode (SignatureAppearance.SignatureAppearanceMode signatureAppearanceMode)

The SignatureAppearance.SignatureAppearanceMode controls how the signature will be displayed. Defaults to SIGNATURE_AND_DESCRIPTION.

Parameters
signatureAppearanceMode The SignatureAppearance.SignatureAppearanceMode to use.

public SignatureAppearance.Builder setSignatureGraphic (SignatureAppearance.SignatureGraphic signatureGraphic)

The SignatureAppearance.SignatureGraphic can be displayed instead of the signer name. If no SignatureAppearance.SignatureGraphic is set the signer name will be displayed. If you want to disable the default PSPDFKit watermark that is shown use setShowWatermark(boolean).

Parameters
signatureGraphic The SignatureAppearance.SignatureGraphic to use.

public SignatureAppearance.Builder setSignatureWatermark (SignatureAppearance.SignatureGraphic signatureWatermark)

The SignatureAppearance.SignatureGraphic to be displayed as the watermark. If no SignatureAppearance.SignatureGraphic is set the PSPDFKit logo will be shown unless setShowWatermark(boolean) is false.

Parameters
signatureWatermark The SignatureAppearance.SignatureGraphic to use.