com.qoppa.pdf.form
Interface SignatureField

All Superinterfaces:

FormField

public interface SignatureField

extends FormField

SignatureField holds a signature field.

Author:

Qoppa Software

Method Summary

boolean	clearSignature() Clears this signature, if the field has been signed.
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	setSignDateTime(Date signDateTime) Sets the signature date and time from a Java date object.
void	setSignLocation(String signLocation) Sets the signature location.
void	setSignName(String signName) Sets the signature name.
void	setSignReason(String signReason) Sets the signature reason.

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

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

Method Detail

getSignDateTime

public Date getSignDateTime()

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

Returns:

signature date and time

getSignLocation

public String getSignLocation()

Returns the signature location.

Returns:

signature location

getSignName

public String getSignName()

Returns the signature name.

Returns:

signature name

getSignReason

public String getSignReason()

Returns the signature reason.

Returns:

signature reason

setSignDateTime

public void setSignDateTime(Date signDateTime)
                     throws PDFException

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

Throws:

PDFException

setSignLocation

public void setSignLocation(String signLocation)
                     throws PDFException

Sets the signature location.

Throws:

PDFException

setSignName

public void setSignName(String signName)
                 throws PDFException

Sets the signature name.

Throws:

PDFException

setSignReason

public void setSignReason(String signReason)
                   throws PDFException

Sets the signature reason.

Throws:

PDFException

getSignatureValidity

public SignatureValidity getSignatureValidity()

Returns the validity information for this signature.

Returns:

An object describing the validity state of this signature.

hasBeenSigned

public 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

public 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

public 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 succesful.