Class SignatureAppearance
-
- All Implemented Interfaces:
-
android.os.Parcelable
public abstract class SignatureAppearance implements Parcelable
Configures the appearance of digital signatures that are added to the document.
Use SignatureAppearance.Builder to create an instance of this.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
SignatureAppearance.SignatureAppearanceMode
Controls how the digital signature will appear after signing.
public final class
SignatureAppearance.SignatureGraphic
Contains the graphic that will be used as the signature.
public class
SignatureAppearance.Builder
A helper class used for building the SignatureAppearance.
-
Constructor Summary
Constructors Constructor Description SignatureAppearance()
-
Method Summary
Modifier and Type Method Description abstract SignatureAppearance.SignatureAppearanceMode
getSignatureAppearanceMode()
The SignatureAppearanceMode controls how the signature will be displayed. abstract boolean
showSignerName()
Indicates whether the name of the signer will be shown or not. abstract boolean
showSignDate()
Indicates whether the date of the signature will be shown or not. abstract boolean
showSignatureReason()
Indicates whether or not the reason for the signature will be shown. abstract boolean
showSignatureLocation()
Indicates whether or not the location where the signature was created will be shown. abstract SignatureAppearance.SignatureGraphic
getSignatureGraphic()
The SignatureGraphic can be displayed instead of the signer name. abstract SignatureAppearance.SignatureGraphic
getSignatureWatermark()
Gets the signature watermark that will be shown unless setShowWatermark is false. abstract boolean
reuseExistingSignatureAppearanceStream()
Controls whether or not an existing appearance stream for the signature should be used. abstract boolean
showWatermark()
Indicates whether the PSPDFKit watermark will be shown. abstract boolean
showDateTimezone()
Indicates whether the date will include the timezone, if showSignDate
istrue
.-
-
Method Detail
-
getSignatureAppearanceMode
@NonNull() abstract SignatureAppearance.SignatureAppearanceMode getSignatureAppearanceMode()
The SignatureAppearanceMode controls how the signature will be displayed. Defaults to SIGNATURE_AND_DESCRIPTION.
- Returns:
The SignatureAppearanceMode to use.
-
showSignerName
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.
-
showSignDate
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.
-
showSignatureReason
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.
-
showSignatureLocation
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.
-
getSignatureGraphic
@Nullable() abstract SignatureAppearance.SignatureGraphic getSignatureGraphic()
The SignatureGraphic can be displayed instead of the signer name. If no is set the signer name will be displayed. If you want to disable the default PSPDFKit watermark that is shown use setShowWatermark.
- Returns:
The SignatureGraphic to use.
-
getSignatureWatermark
@Nullable() abstract SignatureAppearance.SignatureGraphic getSignatureWatermark()
Gets the signature watermark that will be shown unless setShowWatermark is false.
- Returns:
The SignatureGraphic to use.
-
reuseExistingSignatureAppearanceStream
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.
-
showWatermark
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.
-
showDateTimezone
abstract boolean showDateTimezone()
Indicates whether the date will include the timezone, if
showSignDate
istrue
. Defaults tofalse
.- Returns:
true
if the signature date should include the timezone,false
otherwise.
-
-
-
-