public abstract class

SignatureAppearance

extends Object
implements Parcelable
java.lang.Object
   ↳ com.pspdfkit.signatures.SignatureAppearance

Class Overview

Configures the appearance of digital signatures that are added to the document.

Use SignatureAppearance.Builder to create an instance of this.

Summary

Nested Classes
class SignatureAppearance.Builder A helper class used for building the SignatureAppearance. 
enum SignatureAppearance.SignatureAppearanceMode Controls how the digital signature will appear after signing. 
class SignatureAppearance.SignatureGraphic Contains the graphic that will be used as the signature. 
[Expand]
Inherited Constants
From interface android.os.Parcelable
Public Constructors
SignatureAppearance()
Public Methods
abstract SignatureAppearance.SignatureAppearanceMode getSignatureAppearanceMode()
The SignatureAppearance.SignatureAppearanceMode controls how the signature will be displayed.
abstract SignatureAppearance.SignatureGraphic getSignatureGraphic()
The SignatureAppearance.SignatureGraphic can be displayed instead of the signer name.
abstract boolean reuseExistingSignatureAppearanceStream()
Controls whether or not an existing appearance stream for the signature should be used.
abstract boolean showSignDate()
Indicates whether the date of the signature will be shown or not.
abstract boolean showSignatureLocation()
Indicates whether or not the location where the signature was created will be shown.
abstract boolean showSignatureReason()
Indicates whether or not the reason for the signature will be shown.
abstract boolean showSignerName()
Indicates whether the name of the signer will be shown or not.
abstract boolean showWatermark()
Indicates whether the PSPDFKit watermark will be shown.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Public Constructors

public SignatureAppearance ()

Public Methods

public abstract SignatureAppearance.SignatureAppearanceMode getSignatureAppearanceMode ()

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

Returns

public abstract SignatureAppearance.SignatureGraphic getSignatureGraphic ()

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).

Returns

public abstract boolean reuseExistingSignatureAppearanceStream ()

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

Returns
  • true if an existing appearance stream should be reused, false otherwise.

public abstract boolean showSignDate ()

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

Returns
  • true if the date should be shown, false otherwise.

public abstract boolean showSignatureLocation ()

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

Returns
  • true if the location should be shown, false otherwise.

public abstract boolean showSignatureReason ()

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

Returns
  • true if the reason should be shown, false otherwise.

public abstract boolean showSignerName ()

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

Returns
  • true if the name of the signer should be shown, false otherwise.

public abstract boolean showWatermark ()

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

Returns
  • true if the PSPDFKit watermark should be shown, false otherwise.