public final class

SignaturePickerFragment

extends Fragment
java.lang.Object
   ↳ androidx.fragment.app.Fragment
     ↳ com.pspdfkit.ui.signatures.SignaturePickerFragment

Class Overview

The `SignaturePickerFragment` can be used to create ink signatures to add to a document. The dialog provides a list of stored signatures, and a user interface for adding new signatures. Additionally, each signature can be associated with an existing Signer which allows digital signing of the document. To show the dialog, use show(FragmentManager, OnSignaturePickedListener, SignatureOptions, SignatureStorage) providing the fragment manager of the current activity, and a callback for receiving the user's selection. This class constitutes PSPDFKit’s older signatures functionality from before the introduction of Electronic Signatures. As such, using this class requires that your license includes the Annotations feature and was originally purchased in October 2021 or earlier. If you purchased your license after this time, then you should use ElectronicSignatureFragment from Electronic Signatures instead. This older signatures functionality will continue to be maintained and supported. However, we recommend using Electronic Signatures for new PSPDFKit integrations. If you’re interested in upgrading, please see our migration guide: https://pspdfkit.com/guides/android/migration-guides/migrating-to-electronic-signatures/

Summary

[Expand]
Inherited Fields
From class androidx.fragment.app.Fragment
Public Constructors
SignaturePickerFragment()
Public Methods
static void dismiss(FragmentManager fragmentManager)
Dismisses any previously shown signature picker fragment.
void finish()
Dismiss fragment removing it from its owning activity.
void onCreate(Bundle savedInstanceState)
void onSaveInstanceState(Bundle outState)
static void restore(FragmentManager fragmentManager, OnSignaturePickedListener listener)
Restores any previously shown SignaturePickerFragment by re-attaching a OnSignaturePickedListener.
static void restore(FragmentManager fragmentManager, OnSignaturePickedListener listener, SignatureStorage signatureStorage)
Restores any previously shown SignaturePickerFragment by re-attaching a OnSignaturePickedListener.
void setOnSignaturePickedListener(OnSignaturePickedListener listener)
Sets listener for picked signatures.
static void show(FragmentManager fragmentManager, OnSignaturePickedListener listener)
Shows the SignaturePickerFragment.
static void show(FragmentManager fragmentManager, OnSignaturePickedListener listener, SignatureOptions signatureOptions, SignatureStorage signatureStorage)
Shows the SignaturePickerFragment.
[Expand]
Inherited Methods
From class androidx.fragment.app.Fragment
From class java.lang.Object
From interface android.content.ComponentCallbacks
From interface android.view.View.OnCreateContextMenuListener
From interface androidx.activity.result.ActivityResultCaller
From interface androidx.lifecycle.HasDefaultViewModelProviderFactory
From interface androidx.lifecycle.LifecycleOwner
From interface androidx.lifecycle.ViewModelStoreOwner
From interface androidx.savedstate.SavedStateRegistryOwner

Public Constructors

public SignaturePickerFragment ()

Public Methods

public static void dismiss (FragmentManager fragmentManager)

Dismisses any previously shown signature picker fragment.

Parameters
fragmentManager Fragment manager used to display this fragment in the first place.

public void finish ()

Dismiss fragment removing it from its owning activity.

public void onCreate (Bundle savedInstanceState)

public void onSaveInstanceState (Bundle outState)

public static void restore (FragmentManager fragmentManager, OnSignaturePickedListener listener)

Restores any previously shown SignaturePickerFragment by re-attaching a OnSignaturePickedListener. Use this inside your activity's onCreate(Bundle) method to reattach any listener if necessary (for example after a configuration change). If no fragment was shown, calling this method will be a no-op.

Parameters
fragmentManager The current activity's fragment manager.
listener A listener for receiving the user's selection.

public static void restore (FragmentManager fragmentManager, OnSignaturePickedListener listener, SignatureStorage signatureStorage)

Restores any previously shown SignaturePickerFragment by re-attaching a OnSignaturePickedListener. Use this inside your activity's onCreate(Bundle) method to reattach any listener and signature storage if necessary (for example after a configuration change). If no fragment was shown, calling this method will be a no-op.

Parameters
fragmentManager The current activity's fragment manager.
listener A listener for receiving the user's selection.
signatureStorage Signature storage to be used for saving selected signatures, or null to use the default one.

public void setOnSignaturePickedListener (OnSignaturePickedListener listener)

Sets listener for picked signatures. Calling this method will replace any previously set listener. You may provide null to clear the listener.

Parameters
listener OnSignaturePickedListener that should be notified, or null to clear the listener.

public static void show (FragmentManager fragmentManager, OnSignaturePickedListener listener)

Shows the SignaturePickerFragment. The fragment will be presented to the user as a dialog. The dialog will use AUTOMATIC.

Parameters
fragmentManager The current activity's fragment manager.
listener A listener for receiving the user's selection.

public static void show (FragmentManager fragmentManager, OnSignaturePickedListener listener, SignatureOptions signatureOptions, SignatureStorage signatureStorage)

Shows the SignaturePickerFragment. The fragment will be presented to the user as a dialog.

Parameters
fragmentManager The current activity's fragment manager.
listener A listener for receiving the user's selection.
signatureOptions UI options to use when displaying signatures.
signatureStorage Signature storage to be used for saving selected signatures.