|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.livecycle.signatures.client.types.PDFSignatureAppearanceOptionSpec
public class PDFSignatureAppearanceOptionSpec
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 ES4.
Constructor Summary | |
---|---|
PDFSignatureAppearanceOptionSpec()
Creates a PDFSignatureAppearanceOptionSpec object. |
Method Summary | |
---|---|
boolean |
equals(java.lang.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. |
java.lang.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 |
---|
public PDFSignatureAppearanceOptionSpec()
PDFSignatureAppearanceOptionSpec
object.
Method Detail |
---|
public PDFSignatureAppearanceType getAppearanceType()
PDFSignatureAppearanceType
object that represents the
appearance type of the signature. The default value is PDFSignatureAppearanceType.NAME
.
PDFSignatureAppearanceType
object that represents the
appearance type of the signature.public void setAppearanceType(PDFSignatureAppearanceType appearanceType)
appearanceType
- A PDFSignatureAppearanceType
object that represents the
appearance type of the signature.public boolean isShowDate()
public void setShowDate(boolean showDate)
showDate
- A Boolean value that specifies if the date is shown in the signature.public boolean isShowDN()
public void setShowDN(boolean showDN)
showDN
- A Boolean value that controls if DN information is shown in the signature.
If true
, then DN information is displayed within the signature.public boolean isShowLabels()
public void setShowLabels(boolean showLabels)
showLabels
- A Boolean value that controls if labels for various fields are displayed within the signature.public boolean isShowLocation()
public void setShowLocation(boolean showLocation)
showLocation
- A Boolean value that controls if location information is displayed within the signature.public boolean isShowName()
public void setShowName(boolean showName)
showName
- A Boolean value that controls if the name of the signer is displayed.public boolean isShowReason()
public void setShowReason(boolean showReason)
showReason
- A Boolean value that controls if the reason for signing the PDF document is displayed.public boolean isShowDefaultLogo()
public void setShowDefaultLogo(boolean showDefaultLogo)
showDefaultLogo
- A Boolean value that controls if the default Adobe logo is displayed within the signature.public TextDirection getTextDirection()
TextDirection
object that specifies the direction of the text displayed within the signature.
TextDirection
object.public void setTextDirection(TextDirection textDirection)
textDirection
- A TextDirection
object that specifies the direction of the text displayed within the signature.public double getLogoOpacity()
public void setLogoOpacity(double logoOpacity)
logoOpacity
- A value that represents the opacity of the logo.public Document getLogoPDF()
com.adobe.ipd.Document
object that represents the logo that is displayed within the signature.
com.adobe.ipd.Document
object that represents the logo that is displayed within the signature.public void setLogoPDF(Document logoPDF)
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.public Document getGraphicPDF()
com.adobe.ipd.Document
object that represents the graphic that is displayed within the signature.
com.adobe.ipd.Document
object that represents the graphic that is displayed within the signature.public void setGraphicPDF(Document pdfDoc)
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.public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- An object with which to compare.
obj
argument; false otherwise.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |