| java.lang.Object | |
| ↳ | com.pspdfkit.ui.signatures.ElectronicSignatureOptions |
Class Overview
Options for configuring the ElectronicSignatureFragment. An instance of this can be
passed to show(FragmentManager, OnSignaturePickedListener, ElectronicSignatureOptions, SignatureStorage).
Use ElectronicSignatureOptions.Builder to create instances of this class.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| class | ElectronicSignatureOptions.Builder | A helper class used for building the ElectronicSignatureOptions. |
|||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
android.os.Parcelable
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ElectronicSignatureOptions() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static Set<Font> |
getAvailableFonts(Context context)
Gets a set of the available fonts to pick from when typing a signature.
| ||||||||||
| abstract SignatureColorOptions |
getSignatureColorOptions()
Defines the signature color options available when using the "Draw" or "Type" signing UI.
| ||||||||||
| abstract List<SignatureCreationMode> |
getSignatureCreationModes()
The ways in which the user can choose to add their signature.
| ||||||||||
| abstract SignatureSavingStrategy |
getSignatureSavingStrategy()
The saving strategy used when adding signatures.
| ||||||||||
| static void |
setAvailableFonts(LinkedHashSet<Font> fonts)
Sets a custom
LinkedHashSet of fonts to pick from when typing a signature. | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
android.os.Parcelable
| |||||||||||
Public Constructors
public ElectronicSignatureOptions ()
Public Methods
public static Set<Font> getAvailableFonts (Context context)
Gets a set of the available fonts to pick from when typing a signature. By default, a predefined set of four fonts (Caveat, Pacifico, Marck Script, Meddon) is returned.
Parameters
| context | Context to use. |
|---|
Returns
- a set of the available fonts to pick from when typing a signature.
public abstract SignatureColorOptions getSignatureColorOptions ()
Defines the signature color options available when using the "Draw" or "Type" signing UI. Defaults to black, purple, and blue.
Returns
- Returns the
SignatureColorOptions.
public abstract List<SignatureCreationMode> getSignatureCreationModes ()
The ways in which the user can choose to add their signature. Shown as tabs across the top of the signing UI, or no tabs if there is only one mode.
Returns
- A list of the available signature creation modes. There should be at least one and no duplicates.
public abstract SignatureSavingStrategy getSignatureSavingStrategy ()
The saving strategy used when adding signatures. Defaults to SAVE_IF_SELECTED.
This will only work if a SignatureStorage has been created and set via
setSignatureStorage(SignatureStorage), otherwise
NEVER_SAVE will be used.
Returns
- The currently used signature saving strategy.
public static void setAvailableFonts (LinkedHashSet<Font> fonts)
Sets a custom LinkedHashSet of fonts to pick from when typing a signature. If empty
or null, getAvailableFonts(Context) will return a predefined set of four
fonts.
Parameters
| fonts | a custom LinkedHashSet of fonts to pick from when typing a signature.
|
|---|