pspdfkit/com.pspdfkit.signatures/Signature

Signature

abstract class Signature : Parcelable

Represents a single signature (or signature item). To create an InkAnnotation or from this signature use the toInkAnnotation and toStampAnnotation methods. You can check the signature annotation type through getAnnotationType. Additionally, the signature can be associated with a Signer for digitally signing a PDF. You can retrieve the getSignerIdentifier which can be used to retrieve the signer instance using getSigners.

Constructors

constructor()

Properties

val BITMAP_NOT_SET: Int = -1

Indicates that the bitmap has not been set.

val ID_NOT_SET: Long = -1

Indicates that the id has not been set.

Functions

open fun create(@NonNull bitmap: Bitmap, @NonNull rect: RectF, @Nullable signerIdentifier: String, @Nullable biometricSignatureData: BiometricSignatureData, drawWidthRatio: Float): Signature

open fun create(@ColorInt inkColor: Int, lineWidthPdf: Float, @NonNull lines: List<List<PointF>>, @Nullable signerIdentifier: String, @Nullable biometricSignatureData: BiometricSignatureData, drawWidthRatio: Float): Signature

Creates the Signature.

open fun fromJson(@NonNull signatureJson: JSONObject): Signature

open fun fromJson(id: Long, @NonNull signatureJson: JSONObject): Signature

Creates a signature object by parsing the provided JSON object.

getAnnotationType

abstract fun getAnnotationType(): AnnotationType

Gets the annotation type of the signature, which can either be InkAnnotation or StampAnnotation.

getBiometricData

abstract fun getBiometricData(): BiometricSignatureData

Gets the biometric data that was collected with this signature.

open fun getBitmap(): Bitmap

Gets the bitmap used for rendering the image signature, or null if the signature is not an image signature.

getBitmapIdentifier

abstract fun getBitmapIdentifier(): Int

Gets the bitmap identifier used for rendering the image signature, or BITMAP_NOT_SET if the signature is not represented by a bitmap.

open fun getBoundingBox(): RectF

Returns bounding box of the signature data in pdf coordinates.

abstract fun getId(): Long

Signature id number used in signature database.

abstract fun getInkColor(): Int

Gets color used for signature ink.

abstract fun getLines(): List<List<PointF>>

Access list of signature lines.

abstract fun getLineWidth(): Float

Gets signature line width.

getSignatureDrawWidthRatio

abstract fun getSignatureDrawWidthRatio(): Float

Gets the ratio of signature width to width of the drawing view used when drawing the signature.

getSignerIdentifier

abstract fun getSignerIdentifier(): String

Gets the unique identifier of an associated Signer.

abstract fun getStampRect(): RectF

Bounding rectangle for this signature's bitmap.

open fun textToBitmap(@NonNull text: String, @NonNull font: Font, @ColorInt color: Int, @FloatRange(from = 0) scaleFactor: Float, @NonNull displayMetrics: DisplayMetrics): Bitmap

Creates a bitmap from text that the user typed and a font the user chose.

toInkAnnotation

open fun toInkAnnotation(@IntRange(from = 0) pageIndex: Int): InkAnnotation

open fun toInkAnnotation(@NonNull document: PdfDocument, @IntRange(from = 0) pageIndex: Int, @NonNull touchPoint: PointF): InkAnnotation

open fun toInkAnnotation(@NonNull document: PdfDocument, @IntRange(from = 0) pageIndex: Int, @NonNull targetRect: RectF): InkAnnotation

Builds ink annotation from signature data.

open fun toJson(): JSONObject

Converts a signature into a JSON object.

toStampAnnotation

open fun toStampAnnotation(@IntRange(from = 0) pageIndex: Int): StampAnnotation

open fun toStampAnnotation(@NonNull document: PdfDocument, @IntRange(from = 0) pageIndex: Int, @NonNull touchPoint: PointF): StampAnnotation

open fun toStampAnnotation(@NonNull document: PdfDocument, @IntRange(from = 0) pageIndex: Int, @NonNull targetRect: RectF): StampAnnotation

Builds stamp annotation from signature data.