| java.lang.Object | |
| ↳ | com.pspdfkit.ui.signatures.ElectronicSignatureOptions.Builder |
Class Overview
A helper class used for building the ElectronicSignatureOptions.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
Builder()
Default constructor to get the default options.
| |||||||||||
|
Builder(ElectronicSignatureOptions copyFrom)
Initialize
ElectronicSignatureOptions with a copy of an existing object. | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ElectronicSignatureOptions |
build()
Build the
ElectronicSignatureOptions object from the provided properties. | ||||||||||
| ElectronicSignatureOptions.Builder |
signatureColorOptions(SignatureColorOptions signatureColorOptions)
Defines the 3 signature color options available when using the Electronic Signatures
"Draw" or "Type" signing UI.
| ||||||||||
| ElectronicSignatureOptions.Builder |
signatureCreationModes(List<SignatureCreationMode> signatureCreationModes)
The ways in which the user can choose to add their signature.
| ||||||||||
| ElectronicSignatureOptions.Builder |
signatureSavingStrategy(SignatureSavingStrategy savingStrategy)
Defines if a signature should be saved after creation.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public Builder ()
Default constructor to get the default options.
public Builder (ElectronicSignatureOptions copyFrom)
Initialize ElectronicSignatureOptions with a copy of an existing object.
Parameters
| copyFrom | Original object to make a copy from. |
|---|
Public Methods
public ElectronicSignatureOptions build ()
Build the ElectronicSignatureOptions object from the provided properties.
Returns
ElectronicSignatureOptionsobject with values set in the builder.
public ElectronicSignatureOptions.Builder signatureColorOptions (SignatureColorOptions signatureColorOptions)
Defines the 3 signature color options available when using the Electronic Signatures "Draw" or "Type" signing UI. Defaults to black, purple, and blue.
Parameters
| signatureColorOptions | Can be created from @ColorRes or @ColorInt with
fromColorRes(int, int, int) and
fromColorInt(int, int, int) respectively.
Defaults can be created with fromDefaults()
|
|---|
public ElectronicSignatureOptions.Builder signatureCreationModes (List<SignatureCreationMode> signatureCreationModes)
The ways in which the user can choose to add their signature. These are shown in the order specified as tabs across the top of the signatures UI. The first entry will be selected initially. If this array contains a single entry then the tabs will be hidden. This array must not be empty and must not contain duplicates.
Parameters
| signatureCreationModes | An array of SignatureCreationMode. Must have at
least one mode and not contain duplicates.
|
|---|
public ElectronicSignatureOptions.Builder signatureSavingStrategy (SignatureSavingStrategy savingStrategy)
Defines if a signature should be saved after creation. Defaults to SAVE_IF_SELECTED.
Parameters
| savingStrategy | Signature strategy to apply to saving signatures. |
|---|