public class

SignatureFormElement

extends FormElement
java.lang.Object
   ↳ com.pspdfkit.forms.FormElement
     ↳ com.pspdfkit.forms.SignatureFormElement

Class Overview

Form element representing a signature field. Can be tapped in the user interface to show the signing dialog.

Summary

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
From class com.pspdfkit.forms.FormElement
From class java.lang.Object

Public Methods

public SignatureFormField getFormField ()

Returns the parent SignatureFormField.

Returns

public 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.

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.

Returns

public Maybe<InkAnnotation> getOverlappingInkSignatureAsync ()

This method is deprecated.
Please use getOverlappingSignature() instead.

Searches the document for an ink or stamp signature that overlaps this form element, asynchronously.

Scheduler:
This method operates on background Scheduler.

Returns

public Annotation getOverlappingSignature ()

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.

Returns

public Maybe<Annotation> getOverlappingSignatureAsync ()

Searches the document for an ink or stamp signature that overlaps this form element, asynchronously.

Scheduler:
This method operates on background Scheduler.

Returns

public DigitalSignatureInfo getSignatureInfo ()

Returns information of signature attached to this form element. If this element has no signature, calling isSigned() on the returned DigitalSignatureInfo will return false.

Returns

public FormType getType ()

Gets form type for SignatureFormElement. See FormType.

Returns

public boolean isSigned ()

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.

Returns
  • true if this signature field is digitally signed, otherwise false.