java.lang.Object | ||
↳ | com.pspdfkit.forms.FormElement | |
↳ | com.pspdfkit.forms.SignatureFormElement |
Form element representing a signature field. Can be tapped in the user interface to show the signing dialog.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
SignatureFormField |
getFormField()
Returns the parent
SignatureFormField . | ||||||||||
InkAnnotation |
getOverlappingInkSignature()
Searches the document for an ink signature that overlaps this form element.
| ||||||||||
Maybe<InkAnnotation> |
getOverlappingInkSignatureAsync()
Searches the document for an ink signature that overlaps this form element, asynchronously.
| ||||||||||
DigitalSignatureInfo |
getSignatureInfo()
Returns information of signature attached to this form element.
| ||||||||||
FormType |
getType()
Gets form type for
SignatureFormElement . | ||||||||||
boolean |
isSigned()
Returns if this form element is digitally signed.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Returns the parent SignatureFormField
.
SignatureFormField
of this element. This will always be non-null
.
Searches the document for an ink signature that overlaps this form element.
Note: this call may block for a while and should not be invoked on the main thread.
InkAnnotation
that overlaps this form element or null
if no such annotation exists.
Searches the document for an ink signature that overlaps this form element, asynchronously.
Maybe
that either emits the overlapping InkAnnotation
in `onSuccess()` or terminates with `onCompleted()` or
`onError()`.
Returns information of signature attached to this form element. If this element has no signature, calling isSigned()
on the
returned DigitalSignatureInfo
will return false
.
DigitalSignatureInfo
of this element. This will always be non-null
.
Gets form type for SignatureFormElement
. See FormType
.
SignatureFormElement
.
Returns if this form element is digitally signed. Note that this DOES NOT check if the signature is actually valid. Signature validity must be checked
separately by calling validate()
on the signature info returned by getSignatureInfo()
.
Note: If you want to check if there is an ink signature for this SignatureFormElement
use getOverlappingInkSignature()
instead since this method only deals with digital signatures.
true
if this signature field is digitally signed, otherwise false
.