Class SignatureAppearance
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class SignatureAppearance implements Parcelable
Configures the appearance of digital signatures that are added to the document.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
SignatureAppearance.SignatureAppearanceMode
Controls how the digital signature will appear after signing.
-
Field Summary
Fields Modifier and Type Field Description private final SignatureAppearance.SignatureAppearanceMode
signatureAppearanceMode
private final Boolean
showSignerName
private final Boolean
showSignDate
private final Boolean
showSignatureReason
private final Boolean
showSignatureLocation
private final SignatureGraphic
signatureGraphic
private final SignatureGraphic
signatureWatermark
private final Boolean
reuseExistingSignatureAppearanceStream
private final Boolean
showWatermark
private final Boolean
showDateTimezone
-
Constructor Summary
Constructors Constructor Description SignatureAppearance(SignatureAppearance.SignatureAppearanceMode signatureAppearanceMode, Boolean showSignerName, Boolean showSignDate, Boolean showSignatureReason, Boolean showSignatureLocation, SignatureGraphic signatureGraphic, SignatureGraphic signatureWatermark, Boolean reuseExistingSignatureAppearanceStream, Boolean showWatermark, Boolean showDateTimezone)
-
Method Summary
Modifier and Type Method Description final SignatureAppearance.SignatureAppearanceMode
getSignatureAppearanceMode()
The SignatureAppearanceMode controls how the signature will be displayed. final Boolean
getShowSignerName()
Indicates whether the name of the signer will be shown or not. final Boolean
getShowSignDate()
Indicates whether the date of the signature will be shown or not. final Boolean
getShowSignatureReason()
Indicates whether or not the reason for the signature will be shown. final Boolean
getShowSignatureLocation()
Indicates whether or not the location where the signature was created will be shown. final SignatureGraphic
getSignatureGraphic()
The SignatureGraphic can be displayed instead of the signer name. final SignatureGraphic
getSignatureWatermark()
Gets the signature watermark that will be shown unless showWatermark is false. final Boolean
getReuseExistingSignatureAppearanceStream()
Controls whether or not an existing appearance stream for the signature should be used. final Boolean
getShowWatermark()
Indicates whether the PSPDFKit watermark will be shown. final Boolean
getShowDateTimezone()
Indicates whether the date will include the timezone, if showSignDate
istrue
.-
-
Constructor Detail
-
SignatureAppearance
SignatureAppearance(SignatureAppearance.SignatureAppearanceMode signatureAppearanceMode, Boolean showSignerName, Boolean showSignDate, Boolean showSignatureReason, Boolean showSignatureLocation, SignatureGraphic signatureGraphic, SignatureGraphic signatureWatermark, Boolean reuseExistingSignatureAppearanceStream, Boolean showWatermark, Boolean showDateTimezone)
-
-
Method Detail
-
getSignatureAppearanceMode
final SignatureAppearance.SignatureAppearanceMode getSignatureAppearanceMode()
The SignatureAppearanceMode controls how the signature will be displayed.
-
getShowSignerName
final Boolean getShowSignerName()
Indicates whether the name of the signer will be shown or not.
-
getShowSignDate
final Boolean getShowSignDate()
Indicates whether the date of the signature will be shown or not.
-
getShowSignatureReason
final Boolean getShowSignatureReason()
Indicates whether or not the reason for the signature will be shown.
-
getShowSignatureLocation
final Boolean getShowSignatureLocation()
Indicates whether or not the location where the signature was created will be shown.
-
getSignatureGraphic
final SignatureGraphic getSignatureGraphic()
The SignatureGraphic can be displayed instead of the signer name. If no SignatureGraphic is set the signer name will be displayed. If you want to disable the default PSPDFKit watermark that is shown use showWatermark.
-
getSignatureWatermark
final SignatureGraphic getSignatureWatermark()
Gets the signature watermark that will be shown unless showWatermark is false.
-
getReuseExistingSignatureAppearanceStream
final Boolean getReuseExistingSignatureAppearanceStream()
Controls whether or not an existing appearance stream for the signature should be used.
-
getShowWatermark
final Boolean getShowWatermark()
Indicates whether the PSPDFKit watermark will be shown.
-
getShowDateTimezone
final Boolean getShowDateTimezone()
Indicates whether the date will include the timezone, if
showSignDate
istrue
.
-
-
-
-