nutrient/com.pspdfkit.ui.signatures/SignaturePlacementRequest

SignaturePlacementRequest

class SignaturePlacementRequest

A pending request to add a created signature to the document. Resolve it with proceed or cancel.

Properties

boundingBox

val boundingBox: RectF

Proposed bounding box in PDF coordinates of that page.

formElement

val formElement: SignatureFormElement?

The signature form field being signed, or null for a free-standing signature. A form field has a fixed location, so you will usually proceed in that case.

pageIndex

val pageIndex: Int

Page the signature is proposed to be placed on.

signature

val signature: Signature

The signature the user created or picked.

Functions

cancel

@UiThread

fun cancel()

Does not add the signature to the document, leaving that to you. Only the first resolution counts.

proceed

@UiThread

@JvmOverloads

fun proceed(pageIndex: Int = this.pageIndex, boundingBox: RectF = this.boundingBox)

Adds the signature. Without arguments it goes to the proposed pageIndex and boundingBox; pass another page or bounding box, in PDF coordinates of that page, to place it elsewhere. The signature is scaled to fit the box, so keep its aspect ratio close to boundingBox's. Only the first resolution counts.