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()
This method is deprecated.
Please use
getOverlappingSignature() instead, which
replaces this method. This method will be removed with an update in March 2022. If you
depend on the availability of this method, you can reach out to us at
https://support.pspdfkit.com/hc/en-us/requests/new.
| ||||||||||
Maybe<InkAnnotation> |
getOverlappingInkSignatureAsync()
This method is deprecated.
Please use
getOverlappingSignature() instead.
| ||||||||||
Annotation |
getOverlappingSignature()
Searches the document for an ink or stamp signature that overlaps this form element.
| ||||||||||
Maybe<Annotation> |
getOverlappingSignatureAsync()
Searches the document for an ink or stamp 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
.
This method is deprecated.
Please use getOverlappingSignature()
instead, which
replaces this method. This method will be removed with an update in March 2022. If you
depend on the availability of this method, you can reach out to us at
https://support.pspdfkit.com/hc/en-us/requests/new.
Searches the document for an ink or stamp signature that overlaps this form element.
Note: this call may block for a while and should not be invoked on the main thread.
Annotation
that overlaps this form element or null
if no such
annotation exists. The Annotation
can be an InkAnnotation
or StampAnnotation
.
This method is deprecated.
Please use getOverlappingSignature()
instead.
Searches the document for an ink or stamp signature that overlaps this form element, asynchronously.
Maybe
that either emits the overlapping Annotation
in
`onSuccess()` or terminates with `onCompleted()` or `onError()`. The Annotation
can be an InkAnnotation
or StampAnnotation
.Searches the document for an ink or stamp signature that overlaps this form element.
Note: this call may block for a while and should not be invoked on the main thread.
Annotation
that overlaps this form element or null
if no such
annotation exists. The Annotation
can be an InkAnnotation
or StampAnnotation
.
Searches the document for an ink or stamp signature that overlaps this form element, asynchronously.
Maybe
that either emits the overlapping Annotation
in
`onSuccess()` or terminates with `onCompleted()` or `onError()`. The Annotation
can be an InkAnnotation
or StampAnnotation
.
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
.