com.qoppa.pdf.form

Interface SignatureField

All Superinterfaces:

FormField

public interface SignatureField
extends FormField

SignatureField holds a signature field.

Author:

Qoppa Software

Field Summary

Fields inherited from interface com.qoppa.pdf.form.FormField

FF_NOEXPORT, FF_READONLY, FF_REQUIRED, TYPE_BUTTON, TYPE_CHECKBOX, TYPE_COMBOBOX, TYPE_LISTBOX, TYPE_RADIOBUTTON, TYPE_SIGNATURE, TYPE_TEXT

Method Summary

Modifier and Type	Method and Description
boolean	addVerificationInformation() Add verification information related to this signature.
boolean	clearSignature() Clears this signature, if the field has been signed.
String	getCustomProperty(String key) This method can be used to retrieve the values of custom properties in the signature field dictionary.
SignatureValidity	getSignatureValidity() Returns the validity information for this signature.
String	getSignContactInfo() Returns the contact information used in the signature.
String	getSignCustomProperty(String key) This method can be used to retrieve the values of custom properties in the signature dictionary.
Date	getSignDateTime() Returns the signature date and time as a java date object.
String	getSignLocation() Returns the signature location.
String	getSignName() Returns the signature name.
String	getSignReason() Returns the signature reason.
boolean	hasBeenSigned() Returns whether this signature has already been signed or if it is an empty signature.
boolean	isSignAuthor() Returns a flag indicating whether this is an author signature.
void	setCustomProperty(String key, String value) This method can be used to add additional custom properties to the signature field dictionary.

Methods inherited from interface com.qoppa.pdf.form.FormField

addFieldListener, addKeyListener, addMouseListener, flattenField, getAltFieldName, getFieldFlags, getFieldName, getFieldTypeDesc, getFullFieldName, getKids, getMapFieldName, getTriggerActions, getUserName, getWidgets, isEmpty, isNoExport, isReadOnly, isRequired, removeFieldListener, reset, setAltFieldName, setComponentVisible, setFieldFlags, setFieldName, setHidden, setMapFieldName, setNoExport, setPrintable, setReadOnly, setRequired, setTriggerActions, setUserName

Method Detail

getSignDateTime

Date getSignDateTime()

Returns the signature date and time as a java date object.

Returns:

signature date and time

getSignLocation

String getSignLocation()

Returns the signature location.

Returns:

signature location

getSignName

String getSignName()

Returns the signature name.

Returns:

signature name

getSignReason

String getSignReason()

Returns the signature reason.

Returns:

signature reason

getSignatureValidity

SignatureValidity getSignatureValidity()

Returns the validity information for this signature.

Returns:

An object describing the validity state of this signature.

hasBeenSigned

boolean hasBeenSigned()

Returns whether this signature has already been signed or if it is an empty signature.

Returns:

A flag indicating whether this field has been signed.

isSignAuthor

boolean isSignAuthor()

Returns a flag indicating whether this is an author signature. false indicates that this is a recipient signature.

Returns:

flag indicating if this is an author signature

clearSignature

boolean clearSignature()

Clears this signature, if the field has been signed.

Returns:

true if the field had been signed and the clearing of the signature was successful.

getCustomProperty

String getCustomProperty(String key)
                  throws PDFException

This method can be used to retrieve the values of custom properties in the signature field dictionary.

Parameters:

key - The key for the custom property in the signature field dictionary.

Returns:

The value of the custom property in the signature field dictionary.

Throws:

PDFException

See Also:

getSignCustomProperty(String)

setCustomProperty

void setCustomProperty(String key,
                       String value)
                throws PDFException

This method can be used to add additional custom properties to the signature field dictionary.

Parameters:

key - A unique key for the custom property

value - The vale of the custom property

Throws:

PDFException

getSignCustomProperty

String getSignCustomProperty(String key)
                      throws PDFException

This method can be used to retrieve the values of custom properties in the signature dictionary.

Parameters:

key - The key for the custom property in the signature dictionary.

Returns:

The value of the custom property in the signature dictionary.

Throws:

PDFException

See Also:

getCustomProperty(String)

getSignContactInfo

String getSignContactInfo()

Returns the contact information used in the signature.

Returns:

The contact information used in the signature.

addVerificationInformation

boolean addVerificationInformation()
                            throws PDFException,
                                   IOException

Add verification information related to this signature. This will store the certificates and OCSP responses in the DSS dictionary. To add verification information, the signature field must be signed and the signing certificate must be signed by a certificate authority. Returns true if verification information was successfully added.

Returns:

true if verification information was successfully added.

Throws:

PDFException

IOException