java.lang.Object | |
↳ | com.pspdfkit.signatures.Signature |
Represents a single signature (or signature item). To create an InkAnnotation
from this signature use
toInkAnnotation(PdfDocument, int, PointF)
. 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()
.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
long | ID_NOT_SET | Indicates that the id has not been set. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Signature() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
static Signature |
fromJson(long id, JSONObject signatureJson)
Creates a signature object by parsing the provided JSON object.
| ||||||||||
static Signature |
fromJson(JSONObject signatureJson)
Creates a signature object by parsing the provided JSON object.
| ||||||||||
abstract BiometricSignatureData |
getBiometricData()
Gets the biometric data that was collected with this signature.
| ||||||||||
RectF |
getBoundingBox()
Returns bounding box of the signature data in pdf coordinates.
| ||||||||||
abstract long |
getId()
Signature id number used in signature database.
| ||||||||||
abstract int |
getInkColor()
Gets color used for signature ink.
| ||||||||||
abstract float |
getLineWidth()
Gets signature line width.
| ||||||||||
abstract List<List<PointF>> |
getLines()
Access list of signature lines.
| ||||||||||
abstract String |
getSignerIdentifier()
Gets the unique identifier of an associated
Signer . | ||||||||||
InkAnnotation |
toInkAnnotation(PdfDocument document, int pageIndex, RectF targetRect)
Builds signature annotation from signature data.
| ||||||||||
InkAnnotation |
toInkAnnotation(int pageIndex)
Builds ink annotation from signature data.
| ||||||||||
InkAnnotation |
toInkAnnotation(PdfDocument document, int pageIndex, PointF touchPoint)
Builds signature annotation from signature data.
| ||||||||||
JSONObject |
toJson()
Converts a signature into a JSON object.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Indicates that the id has not been set.
Creates a signature object by parsing the provided JSON object. The JSON object you provide should be
initially obtained via toJson()
. This method also allows you to specify an id which will be
assigned to the signature created from the given JSON. This id will also be assigned by the framework when
retrieving the signatures from the default storage.
id | Id to be assigned to the signature. |
---|---|
signatureJson | JSON object to parse. |
JSONException |
---|
Creates a signature object by parsing the provided JSON object. The JSON object you provide should be
initially obtained via toJson()
.
signatureJson | JSON object to parse. |
---|
JSONException |
---|
Gets the biometric data that was collected with this signature. May return null
if no biometric data was created.
BiometricSignatureData
that was collected with this signature, or null
if no biometric data was collected.
Returns bounding box of the signature data in pdf coordinates. The bounding box will always have its left
and bottom
values
equal 0
.
Signature id number used in signature database. If not set, the default value is ID_NOT_SET
.
Gets color used for signature ink.
Gets signature line width.
Access list of signature lines.
Gets the unique identifier of an associated Signer
. When a non-null
identifier is returned it will be used to retrieve a signer
from getSigners()
.
Signer
, or null
if no signer is associated with this signature.
Builds signature annotation from signature data.
document | Target document where the annotation will be added to. |
---|---|
pageIndex | Target page index in document where the annotation will be added to. |
targetRect | Rect on the page into which the annotation should be fitted. |
Builds ink annotation from signature data. This method does not set annotation's bounding box. If you want to create ink annotation
with bounding box around certain touch point, use toInkAnnotation(PdfDocument, int, PointF)
instead.
pageIndex | Target page index where the annotation will be added to. |
---|
Builds signature annotation from signature data.
document | Target document where the annotation will be added to. |
---|---|
pageIndex | Target page index in document where the annotation will be added to. |
touchPoint | Point where the annotation should be created. |
Converts a signature into a JSON object. You can use that JSON object to recreate the signature later on
via fromJson(JSONObject)
.
JSONException |
---|