com.adobe.livecycle.signatures.client.types
Class PDFSignatureField

java.lang.Object
  com.adobe.livecycle.signatures.client.types.PDFSignatureField

All Implemented Interfaces:

java.io.Serializable

public class PDFSignatureField
extends java.lang.Object
implements java.io.Serializable

Provides information about signature fields located within a PDF document. You can use this object to perform tasks such determining whether the signature field is visible. For information about using this class, see the Retrieving Signature Field Names in Programming with LiveCycle ES4.

See Also:

Serialized Form

Constructor Summary

PDFSignatureField()
A default constructer that creates a PDFSignatureField object

PDFSignatureField(java.lang.String name, boolean isSigned, boolean isVisible, PDFSignatureType type)
A PDFSignatureField constructor.

PDFSignatureField(java.lang.String name, boolean isSigned, boolean isVisible, PDFSignatureType type, PDFSignatureFieldProperties pdfSignatureFieldProperties)
A constructor that creates a PDFSignatureField object.

Method Summary

java.lang.String	getName() Specifies the name of the signature field.
PDFSignatureFieldProperties	getProperties() Gets a PDFSignatureFieldProperties object that specifies the PDF signature field properties of the signature field.
PDFSignatureType	getType() Returns a PDFSignatureType object that specifies the type of signature field.
boolean	isSigned() Specifies whether the signature field is signed or certified.
boolean	isVisible() Specifies whether the signature field is visible.
void	setName(java.lang.String name) Sets the name of the signature field.
void	setProperties(PDFSignatureFieldProperties pdfSignatureFieldProperties) Sets the PDFSignatureFieldProperties object that specifies the PDF signature field properties of the signature field.
void	setSigned(boolean isSigned) Sets whether the signature field is signed.
void	setType(PDFSignatureType type) Sets the type of signature field.
void	setVisible(boolean isVisible) Sets whether the signature field is visible.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PDFSignatureField

public PDFSignatureField(java.lang.String name,
                         boolean isSigned,
                         boolean isVisible,
                         PDFSignatureType type,
                         PDFSignatureFieldProperties pdfSignatureFieldProperties)

A constructor that creates a PDFSignatureField object.

Parameters:

name - The name of the signature field. The fully qualified name of the signature field should be specified. If you are signing a PDF document that is based on an XFA form, then the partial name of the signature field can also be used. For example, form1[0].#subform[1].SignatureField3[3] can be specified as SignatureField3[3].

isSigned - A Boolean value that specifies whether the signature field is signed.

isVisible - A Boolean value that specifies whether the signature field is visible.

type - A PDFSignatureType object that specifies the type of signature field.

PDFSignatureField

public PDFSignatureField()

A default constructer that creates a PDFSignatureField object

PDFSignatureField

public PDFSignatureField(java.lang.String name,
                         boolean isSigned,
                         boolean isVisible,
                         PDFSignatureType type)

A PDFSignatureField constructor.

Parameters:

name - The name of the signature field. The fully qualified name of the signature field should be specified. If you are signing a PDF document that is based on an XFA form, then the partial name of the signature field can also be used. For example, form1[0].#subform[1].SignatureField3[3] can be specified as SignatureField3[3].

isSigned - A Boolean value that specifies whether the signature field is signed.

isVisible - A Boolean value that specifies whether the signature field is visible.

type - A PDFSignatureType object that specifies the type of signature field.

Method Detail

isSigned

public boolean isSigned()

Specifies whether the signature field is signed or certified.

Returns:

A Boolean value that specifies whether the signature field is signed.

setSigned

public void setSigned(boolean isSigned)

Sets whether the signature field is signed.

Parameters:

isSigned - A Boolean value that specifies whether the signature field is signed.

isVisible

public boolean isVisible()

Specifies whether the signature field is visible.

Returns:

A Boolean value that specifies whether the signature field is visible.

setVisible

public void setVisible(boolean isVisible)

Sets whether the signature field is visible.

Parameters:

isVisible - A Booelan value that specifies whether the signature field is visible.

getName

public java.lang.String getName()

Specifies the name of the signature field.

Returns:

The name of the signature field.

setName

public void setName(java.lang.String name)

Sets the name of the signature field.

Parameters:

name - The name of the signature field.

getType

public PDFSignatureType getType()

Returns a PDFSignatureType object that specifies the type of signature field.

Returns:

A PDFSignatureType object that specifies the type of signature field.

setType

public void setType(PDFSignatureType type)

Sets the type of signature field.

Parameters:

type - A PDFSignatureType object that specifies the type of signature field.

getProperties

public PDFSignatureFieldProperties getProperties()

Gets a PDFSignatureFieldProperties object that specifies the PDF signature field properties of the signature field. returns A PDFSignatureFieldProperties object that specifies the PDF signature field properties of the signature field.

setProperties

public void setProperties(PDFSignatureFieldProperties pdfSignatureFieldProperties)

Sets the PDFSignatureFieldProperties object that specifies the PDF signature field properties of the signature field.