com.datalogics.PDFL

Class PDFXConvertParams

java.lang.Object

com.datalogics.PDFL.PDFXConvertParams

public class PDFXConvertParams
extends java.lang.Object

Parameters for converting a document to PDF/X compliance. These parameters control how a Document is converted to the PDF/X standard.

• RemoveAllAnnotations if true, will remove all Annotations and Actions from the output

• AbortIfXFAIsPresent if true, will convert even if XFA form entry is detected

PDF/X is a subset of the PDF ISO standard. The purpose of PDF/X is to facilitate graphics exchange, and it therefore has a series of printing related requirements. For example, in PDF/X-1a all fonts need to be embedded and all images need to be CMYK or spot colors. PDF/X-3 accepts calibrated RGB and CIELAB colors, while retaining most of the other restrictions of PDF/X-1a.

Constructor Summary

Constructors

Constructor and Description
PDFXConvertParams() Parameters for converting to PDF/X.
PDFXConvertParams(boolean RemoveAllAnnotations, boolean AbortIfXFAIsPresent) Parameters for converting to PDF/X.

Method Summary

Modifier and Type	Method and Description
void	delete()
boolean	getAbortIfXFAIsPresent() Presence of XFA can result in some loss of data in output PDF/X file as PDFProcessor do not support XFA.
java.lang.String	getProfileDesc() The Output Intent of a PDF/X document may be any valid CMYK Profile For PDF/X-1a or any valid CMYK or RGB Profile for PDF/X-3.
boolean	getRemoveAllAnnotations() Some of the standards like PDF/X prohibit the presence of some types of Annotations and Actions in order to comply with those standards.
void	setAbortIfXFAIsPresent(boolean theSetting) Presence of XFA can result in some loss of data in output PDF/X file as PDFProcessor do not support XFA.
void	setProfileDesc(java.lang.String profile) The Output Intent of a PDF/X document may be any valid CMYK Profile For PDF/X-1a or any valid CMYK or RGB Profile for PDF/X-3.
void	setRemoveAllAnnotations(boolean theSetting) Some of the standards like PDF/X prohibit the presence of some types of Annotations and Actions in order to comply with those standards.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFXConvertParams

public PDFXConvertParams()

Parameters for converting to PDF/X.

• RemoveAllAnnotations - Remove all annotations whether legal or illegal. Default is false.

• AbortIfXFAIsPresent - Abort when XFA is present. Default is false.

PDFXConvertParams

public PDFXConvertParams(boolean RemoveAllAnnotations,
                         boolean AbortIfXFAIsPresent)

Parameters for converting to PDF/X.

Parameters:

RemoveAllAnnotations - Remove all annotations whether legal or illegal.

AbortIfXFAIsPresent - Abort when XFA is present.

Method Detail

delete

public void delete()

getRemoveAllAnnotations

public boolean getRemoveAllAnnotations()

Some of the standards like PDF/X prohibit the presence of some types of Annotations and Actions in order to comply with those standards.

By default we will filter all illegal Annotations and Actions.

If false we will filter out all illegal Annotations and Actions (according to the standard being used) while retaining the legal ones. If true this will remove all the Annotations and Actions from the output PDF/X compliant file.

setRemoveAllAnnotations

public void setRemoveAllAnnotations(boolean theSetting)

Some of the standards like PDF/X prohibit the presence of some types of Annotations and Actions in order to comply with those standards.

By default we will filter all illegal Annotations and Actions.

If false we will filter out all illegal Annotations and Actions (according to the standard being used) while retaining the legal ones. If true this will remove all the Annotations and Actions from the output PDF/X compliant file.

getAbortIfXFAIsPresent

public boolean getAbortIfXFAIsPresent()

Presence of XFA can result in some loss of data in output PDF/X file as PDFProcessor do not support XFA. However client can choose to abort the conversion in case XFA is present by setting this parameter to true.

By default we will not abort if XFA is present.

If false we will convert even if we detect the XFA form entry in PDDoc If true we will abort the process.

setAbortIfXFAIsPresent

public void setAbortIfXFAIsPresent(boolean theSetting)

Presence of XFA can result in some loss of data in output PDF/X file as PDFProcessor do not support XFA. However client can choose to abort the conversion in case XFA is present by setting this parameter to true.

By default we will not abort if XFA is present.

If false we will convert even if we detect the XFA form entry in PDDoc If true we will abort the process.

setProfileDesc

public void setProfileDesc(java.lang.String profile)

The Output Intent of a PDF/X document may be any valid CMYK Profile For PDF/X-1a or any valid CMYK or RGB Profile for PDF/X-3. This parameter allows the user to specify a particular profile for this conversion by description. When this parameter is not present, the profile "U.S. Web Coated (SWOP) v2" will be used for both.

If this description is present, and specifies a profile of the wrong color family, or specifies a profile which cannot be located in resources, an exception will be raised.

getProfileDesc

public java.lang.String getProfileDesc()

The Output Intent of a PDF/X document may be any valid CMYK Profile For PDF/X-1a or any valid CMYK or RGB Profile for PDF/X-3. This parameter allows the user to specify a particular profile for this conversion by description. When this parameter is not present, the profile "U.S. Web Coated (SWOP) v2" will be used for both.

If this description is present, and specifies a profile of the wrong color family, or specifies a profile which cannot be located in resources, an exception will be raised.