| java.lang.Object | ||
| ↳ | com.pspdfkit.forms.FormField | |
| ↳ | com.pspdfkit.forms.SignatureFormField | |
Class Overview
Represents a signature field in a form. This is usually used to place a signature onto a page using an InkAnnotation
or it holds a digital signature which can be retrieved using getSignatureInfo().
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| List<? extends SignatureFormElement> |
getFormElements()
Retrieve list of form elements that represents this field visually.
| ||||||||||
| DigitalSignatureInfo |
getSignatureInfo()
Returns the digital signing information attached to this form element.
| ||||||||||
| void |
removeSignature()
Removes the digital signing information attached to this form field.
| ||||||||||
| Completable |
removeSignatureAsync()
Asynchronously removes the digital signing information attached to this form field.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.pspdfkit.forms.FormField
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Methods
public List<? extends SignatureFormElement> getFormElements ()
Retrieve list of form elements that represents this field visually. Each FormElement
can be part of a single field and each field can contain multiple form elements.
Returns
- List of child form elements.
public DigitalSignatureInfo getSignatureInfo ()
Returns the digital signing information attached to this form element. If this element has no signature,
isSigned() of the returned signing information will be false.
Returns
DigitalSignatureInfoof this form field.
public void removeSignature ()
Removes the digital signing information attached to this form field. If this element has no signature this is a no-op.
public Completable removeSignatureAsync ()
Asynchronously removes the digital signing information attached to this form field.
Returns
- A completable completing once the signature was removed.