com.lowagie.text.pdf

Class PdfSignatureAppDataDict

java.lang.Object

com.lowagie.text.pdf.PdfObject

com.lowagie.text.pdf.PdfDictionary

com.lowagie.text.pdf.PdfSignatureAppDataDict

public class PdfSignatureAppDataDict
extends PdfDictionary

The optional App dictionary which is part of the Build Properties Dictionary.

Author:

Lonzak

Field Summary

Fields inherited from class com.lowagie.text.pdf.PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class com.lowagie.text.pdf.PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor and Description
PdfSignatureAppDataDict()

Method Summary

Modifier and Type	Method and Description
PdfString	getDate() The software module build date.
PdfName	getName() The name of the software module used to create the signature.
PdfBoolean	getNonEFontNoWarn() If there is a Legal dictionary in the catalog of the PDF file, and the NonEmbeddedFonts attribute (which specifies the number of fonts not embedded) in that dictionary has a non-zero value, and the viewing application has a preference set to suppress the display of the warning about fonts not being embedded, then the value of this attribute will be set to true (meaning that no warning need be displayed).
PdfArray	getOs() Indicates the operating system, such as Windows.
PdfBoolean	getPreRelease() A flag that can be used by the signature handler or software module to indicate that this signature was created with unreleased software.
PdfNumber	getR() The software module revision number.
PdfString	getrEx() A text string indicating the version of the application implementation, as described by the Name attribute in this dictionary.
PdfBoolean	getTrustedMode() If the value is true, the application was in trusted mode when signing took place.
void	setDate(String date) The software module build date.
void	setName(String name) The name of the software module used to create the signature.
void	setNonEFontNoWarn(boolean nonEFontNoWarn) If there is a Legal dictionary in the catalog of the PDF file, and the NonEmbeddedFonts attribute (which specifies the number of fonts not embedded) in that dictionary has a non-zero value, and the viewing application has a preference set to suppress the display of the warning about fonts not being embedded, then the value of this attribute will be set to true (meaning that no warning need be displayed).
void	setOs(String os) Indicates the operating system, such as Windows.
void	setPreRelease(boolean preRelease) A flag that can be used by the signature handler or software module to indicate that this signature was created with unreleased software.
void	setR(int r) The software module revision number.
void	setrEx(String rEx) A text string indicating the version of the application implementation, as described by the Name attribute in this dictionary.
void	setTrustedMode(boolean trustedMode) If the value is true, the application was in trusted mode when signing took place.

Methods inherited from class com.lowagie.text.pdf.PdfDictionary

clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, getKeysAndValues, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString

Methods inherited from class com.lowagie.text.pdf.PdfObject

canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PdfSignatureAppDataDict

public PdfSignatureAppDataDict()

Method Detail

getName

public PdfName getName()

The name of the software module used to create the signature.

Returns:

the name of the software module used to create the signature.

setName

public void setName(String name)

The name of the software module used to create the signature.

Parameters:

name - sets the name of the software module used to create the signature.

getDate

public PdfString getDate()

The software module build date. This string is normally produced by the compiler that is used to compile the software, for example using the Date and Time preprocessor flags.

Returns:

The software module build date or null.

setDate

public void setDate(String date)

The software module build date. This string is normally produced by the compiler that is used to compile the software, for example using the Date and Time preprocessor flags.

Parameters:

date - Sets the software module build date

getR

public PdfNumber getR()

The software module revision number. It is important that signature handlers and other software modules specify a unique value for R for every publicly available build of the software. If the module or handler is ever found to have been defective, for signatures where the value of PreRelease is false, the value of this attribute is likely to be the only way to detect that the signature was created with the defective release. A sample value might be 0x00020014, for software module version 2, sub-build 0x14. Various software modules may use this entry differently.

Returns:

The software module revision number or null.

setR

public void setR(int r)

The software module revision number. It is important that signature handlers and other software modules specify a unique value for R for every publicly available build of the software. If the module or handler is ever found to have been defective, for signatures where the value of PreRelease is false, the value of this attribute is likely to be the only way to detect that the signature was created with the defective release. A sample value might be 0x00020014, for software module version 2, sub-build 0x14. Various software modules may use this entry differently.

Parameters:

r - sets the software module revision number

getPreRelease

public PdfBoolean getPreRelease()

A flag that can be used by the signature handler or software module to indicate that this signature was created with unreleased software. If true, this signature was created with pre-release or otherwise unreleased software. The default value is false

Returns:

true when an unreleased software was used to create the signature otherwise false or null;

setPreRelease

public void setPreRelease(boolean preRelease)

A flag that can be used by the signature handler or software module to indicate that this signature was created with unreleased software. If true, this signature was created with pre-release or otherwise unreleased software. The default value is false

Parameters:

preRelease - sets the unreleased flag indicating whether the signature was created using an unreleased software

getOs

public PdfArray getOs()

Indicates the operating system, such as Windows. Currently there is no specific string format defined for the value of this attribute.

Returns:

the operating system or null.

setOs

public void setOs(String os)

Indicates the operating system, such as Windows. Currently there is no specific string format defined for the value of this attribute.

Parameters:

os - sets the operating system

getNonEFontNoWarn

public PdfBoolean getNonEFontNoWarn()

If there is a Legal dictionary in the catalog of the PDF file, and the NonEmbeddedFonts attribute (which specifies the number of fonts not embedded) in that dictionary has a non-zero value, and the viewing application has a preference set to suppress the display of the warning about fonts not being embedded, then the value of this attribute will be set to true (meaning that no warning need be displayed).

Returns:

true when no warning should be displayed otherwise false / null;

setNonEFontNoWarn

public void setNonEFontNoWarn(boolean nonEFontNoWarn)

If there is a Legal dictionary in the catalog of the PDF file, and the NonEmbeddedFonts attribute (which specifies the number of fonts not embedded) in that dictionary has a non-zero value, and the viewing application has a preference set to suppress the display of the warning about fonts not being embedded, then the value of this attribute will be set to true (meaning that no warning need be displayed).

Parameters:

nonEFontNoWarn - sets whether no warning should be displayed otherwise false;

getTrustedMode

public PdfBoolean getTrustedMode()

If the value is true, the application was in trusted mode when signing took place. The default value is false. A viewing application is in trusted mode when only reviewed code is executing, where reviewed code is code that does not affect the rendering of PDF files in ways that are not covered by the PDF Reference.

Returns:

if the application was in trusted mode when signing took place. Might also be null if not existent.

setTrustedMode

public void setTrustedMode(boolean trustedMode)

If the value is true, the application was in trusted mode when signing took place. The default value is false. A viewing application is in trusted mode when only reviewed code is executing, where reviewed code is code that does not affect the rendering of PDF files in ways that are not covered by the PDF Reference.

Parameters:

trustedMode - sets whether the application was in trusted mode when signing took place

getrEx

public PdfString getrEx()

A text string indicating the version of the application implementation, as described by the Name attribute in this dictionary. When set by Adobe Acrobat, this entry is in the format: major.minor.micro (for example 7.0.7).

Returns:

a text string indicating the version of the application implementation or null.

setrEx

public void setrEx(String rEx)

A text string indicating the version of the application implementation, as described by the Name attribute in this dictionary. When set by Adobe Acrobat, this entry is in the format: major.minor.micro (for example 7.0.7).

Parameters:

rEx - sets a text string indicating the version of the application implementation