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

TYPE_BUTTON, TYPE_CHECKBOX, TYPE_COMBOBOX, TYPE_LISTBOX, TYPE_RADIOBUTTON, TYPE_SIGNATURE, TYPE_TEXT

Method Summary

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.
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.
void	setSignDateTime(Date signDateTime) Deprecated. This method has no effect. The signature date and time is set when a signature is applied to a document. This method will be removed in future versions.
void	setSignLocation(String signLocation) Deprecated. This method has no effect. The signature location can only be set at the time of signing a document, using the SigningInformation class. This method will be removed in future versions.
void	setSignName(String signName) Deprecated. This method has no effect. The signature name can only be set at the time of signing a document, using the SigningInformation class. This method will be removed in future versions.
void	setSignReason(String signReason) Deprecated. This method has no effect. The signature reason can only be set at the time of signing a document, using the SigningInformation class. This method will be removed in future versions.

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

addFieldListener, addKeyListener, addMouseListener, flattenField, getAltFieldName, 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

setSignDateTime

void setSignDateTime(Date signDateTime)
                     throws PDFException

Deprecated. This method has no effect. The signature date and time is set when a signature is applied to a document. This method will be removed in future versions.

Sets the signature date and time from a Java date object.

Throws:

PDFException

setSignLocation

void setSignLocation(String signLocation)
                     throws PDFException

Deprecated. This method has no effect. The signature location can only be set at the time of signing a document, using the SigningInformation class. This method will be removed in future versions.

Sets the signature location.

Throws:

PDFException

setSignName

void setSignName(String signName)
                 throws PDFException

Deprecated. This method has no effect. The signature name can only be set at the time of signing a document, using the SigningInformation class. This method will be removed in future versions.

Sets the signature name.

Throws:

PDFException

setSignReason

void setSignReason(String signReason)
                   throws PDFException

Deprecated. This method has no effect. The signature reason can only be set at the time of signing a document, using the SigningInformation class. This method will be removed in future versions.

Sets the signature reason.

Throws:

PDFException

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

Throws:

PDFException

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