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

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

All Implemented Interfaces:

Serializable

public class PDFSignatureAppearanceOptionSpec
extends Object
implements Serializable

Controls the appearance of the signature used to sign a PDF document. For example, using this class, you can set appearance options such as whether the name of the signer and date information is displayed within the signature that is used to sign a PDF document. An instance of this class is used when invoking the sign or certify methods.

To see an object of this type used in a code example, see the Digitally signing a PDF document using the Java API quick start in Programming with LiveCycle ES3.

See Also:

Serialized Form

Constructor Summary

PDFSignatureAppearanceOptionSpec()
Creates a PDFSignatureAppearanceOptionSpec object.

Method Summary

boolean	equals(Object obj) Indicates whether some other object is equal to this one.
PDFSignatureAppearanceType	getAppearanceType() Returns a PDFSignatureAppearanceType object that represents the appearance type of the signature.
Document	getGraphicPDF() Returns a com.adobe.ipd.Document object that represents the graphic that is displayed within the signature.
double	getLogoOpacity() Returns a value that represents the opacity of the logo that is displayed within the signature.
Document	getLogoPDF() Returns a com.adobe.ipd.Document object that represents the logo that is displayed within the signature.
TextDirection	getTextDirection() Returns a TextDirection object that specifies the direction of the text displayed within the signature.
boolean	isShowDate() Specifies whether the date is displayed within the signature.
boolean	isShowDefaultLogo() Specifies whether the default Adobe logo is displayed within the signature.
boolean	isShowDN() Specifies whether DN information is shown in the signature.
boolean	isShowLabels() Specifies whether labels for various fields are displayed within the signature.
boolean	isShowLocation() Specifies whether location information is displayed within the signature.
boolean	isShowName() Specifies whether the name of the signer is displayed within the signature.
boolean	isShowReason() Specifies whether the reason for signing the PDF document is displayed within the signature.
void	setAppearanceType(PDFSignatureAppearanceType appearanceType) Set the appearance type of the signature.
void	setGraphicPDF(Document pdfDoc) Sets the graphic that is displayed within the signature.
void	setLogoOpacity(double logoOpacity) Sets the opacity of the logo that is displayed within the signature.
void	setLogoPDF(Document logoPDF) Sets the logo that is displayed within the signature.
void	setShowDate(boolean showDate) Sets whether the date is displayed within the signature.
void	setShowDefaultLogo(boolean showDefaultLogo) Sets whether the default Adobe logo is displayed within the signature.
void	setShowDN(boolean showDN) Sets whether DN information is displayed within the signature.
void	setShowLabels(boolean showLabels) Sets whether labels for various fields are displayed within the signature.
void	setShowLocation(boolean showLocation) Sets whether location information is displayed within the signature.
void	setShowName(boolean showName) Sets whether the name of the signer is displayed within the signature.
void	setShowReason(boolean showReason) Sets whether the reason for signing the PDF document is displayed within the signature.
void	setTextDirection(TextDirection textDirection) Sets the direction of the text within the signature.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PDFSignatureAppearanceOptionSpec

public PDFSignatureAppearanceOptionSpec()

Creates a PDFSignatureAppearanceOptionSpec object.

Method Detail

getAppearanceType

public PDFSignatureAppearanceType getAppearanceType()

Returns a PDFSignatureAppearanceType object that represents the appearance type of the signature. The default value is PDFSignatureAppearanceType.NAME.

Returns:

A PDFSignatureAppearanceType object that represents the appearance type of the signature.

setAppearanceType

public void setAppearanceType(PDFSignatureAppearanceType appearanceType)

Set the appearance type of the signature.

Parameters:

appearanceType - A PDFSignatureAppearanceType object that represents the appearance type of the signature.

isShowDate

public boolean isShowDate()

Specifies whether the date is displayed within the signature. The default is true, which means that the date is shown.

Returns:

Returns A Boolean value that specifies whether the date is displayed within the signature.

setShowDate

public void setShowDate(boolean showDate)

Sets whether the date is displayed within the signature.

Parameters:

showDate - A Boolean value that specifies if the date is shown in the signature.

isShowDN

public boolean isShowDN()

Specifies whether DN information is shown in the signature. The default is true, which means that DN information is shown in the signature.

Returns:

A Boolean value that specifies whether DN information is shown in the signature.

setShowDN

public void setShowDN(boolean showDN)

Sets whether DN information is displayed within the signature.

Parameters:

showDN - A Boolean value that controls if DN information is shown in the signature. If true, then DN information is displayed within the signature.

isShowLabels

public boolean isShowLabels()

Specifies whether labels for various fields are displayed within the signature. The default is true, which means that labels for various fields are shown.

Returns:

Returns a Boolean value that specifies whether labels for various fields are displayed in the signature appearance.

setShowLabels

public void setShowLabels(boolean showLabels)

Sets whether labels for various fields are displayed within the signature.

Parameters:

showLabels - A Boolean value that controls if labels for various fields are displayed within the signature.

isShowLocation

public boolean isShowLocation()

Specifies whether location information is displayed within the signature. The default is true, which means that location information is displayed.

Returns:

A Boolean value that specifies whether location information is displayed.

setShowLocation

public void setShowLocation(boolean showLocation)

Sets whether location information is displayed within the signature.

Parameters:

showLocation - A Boolean value that controls if location information is displayed within the signature.

isShowName

public boolean isShowName()

Specifies whether the name of the signer is displayed within the signature. The default is true, which means that the name of the signer is displayed.

Returns:

A Boolean value that specifies whether the name of the signer is displayed.

setShowName

public void setShowName(boolean showName)

Sets whether the name of the signer is displayed within the signature.

Parameters:

showName - A Boolean value that controls if the name of the signer is displayed.

isShowReason

public boolean isShowReason()

Specifies whether the reason for signing the PDF document is displayed within the signature. The default is true, which means that the reason is displayed.

Returns:

A Boolean value that controls if the reason for signing the PDF document is displayed.

setShowReason

public void setShowReason(boolean showReason)

Sets whether the reason for signing the PDF document is displayed within the signature.

Parameters:

showReason - A Boolean value that controls if the reason for signing the PDF document is displayed.

isShowDefaultLogo

public boolean isShowDefaultLogo()

Specifies whether the default Adobe logo is displayed within the signature. The default is true, which means that the default Adobe Logo is displayed within the signature.

Returns:

A Boolean value that specifies whether the default Adobe logo is displayed within the signature.

setShowDefaultLogo

public void setShowDefaultLogo(boolean showDefaultLogo)

Sets whether the default Adobe logo is displayed within the signature.

Parameters:

showDefaultLogo - A Boolean value that controls if the default Adobe logo is displayed within the signature.

getTextDirection

public TextDirection getTextDirection()

Returns a TextDirection object that specifies the direction of the text displayed within the signature.

Returns:

A TextDirection object.

setTextDirection

public void setTextDirection(TextDirection textDirection)

Sets the direction of the text within the signature.

Parameters:

textDirection - A TextDirection object that specifies the direction of the text displayed within the signature.

getLogoOpacity

public double getLogoOpacity()

Returns a value that represents the opacity of the logo that is displayed within the signature. Valid values are between 0.0 (fully transparent) to 1.0 (fully opaque).

Returns:

A value that represents the opacity of the logo.

setLogoOpacity

public void setLogoOpacity(double logoOpacity)

Sets the opacity of the logo that is displayed within the signature. Valid values are between 0.0 (fully transparent) to 1.0 (fully opaque). If any value is outside [0 1], then the default value of 0.5 is used.

Parameters:

logoOpacity - A value that represents the opacity of the logo.

getLogoPDF

public Document getLogoPDF()

Returns a com.adobe.ipd.Document object that represents the logo that is displayed within the signature.

Returns:

A com.adobe.ipd.Document object that represents the logo that is displayed within the signature.

setLogoPDF

public void setLogoPDF(Document logoPDF)

Sets the logo that is displayed within the signature.

Parameters:

logoPDF - A com.adobe.ipd.Document object that represents the logo that is displayed within the signature. Only a PDF file can be used as no other file type is supported.

getGraphicPDF

public Document getGraphicPDF()

Returns a com.adobe.ipd.Document object that represents the graphic that is displayed within the signature.

Returns:

A com.adobe.ipd.Document object that represents the graphic that is displayed within the signature.

setGraphicPDF

public void setGraphicPDF(Document pdfDoc)

Sets the graphic that is displayed within the signature.

Parameters:

pdfDoc - A com.adobe.ipd.Document object that represents the graphic that is displayed within the signature. Only a PDF file can be used as no other file type is supported.

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

Returns:

A string representation of the object.

equals

public boolean equals(Object obj)

Indicates whether some other object is equal to this one.

Overrides:

equals in class Object

Parameters:

obj - An object with which to compare.

Returns:

The value true if this object is the same as the obj argument; false otherwise.