PDFAConvertParams Class Documentation
classPDFAConvertParamsNamespace:com::datalogics::PDFL
Detailed Description
Parameters for converting a document to PDF/A compliance. These parameters control how a Document is converted to the PDF/A standard.
RemoveAllAnnotations if true, will remove all Annotations and Actions from the output
IgnoreFontErrors if true, will try to rasterize the page when fonts cannot be embedded
AbortIfXFAIsPresent if true, will abort conversion process if XFA form entry is detected
NoValidationErrors if true, will ignore validation errors
RasterizationResolution rasterization resolution; if 0, use 72 DPI
ValidateImplementationLimitsOfDocument Validate PDF Implementation Limits of the Document. PDF/A is an ISO-standard version the PDF format. It is designed to be used with PDF files that need to be archived and stored for long periods. For example, the fonts in a PDF/A file are embedded in the file itself, rather than accessed through a link to a font directory on a local server.
Referenced by
Constructor & Destructor Documentation
PDFAConvertParams
PDFAConvertParams()PDFAConvertParams
PDFAConvertParams(booleanRemoveAllAnnotations, booleanIgnoreFontErrors, booleanAbortIfXFAIsPresent)Parameters
RemoveAllAnnotations: booleanRemove all annotations whether legal or illegal.
IgnoreFontErrors: booleanRasterize a page when fonts cannot be embedded.
AbortIfXFAIsPresent: booleanAbort when XFA is present for PDF/A-1.
Parameters for converting to PDF/A.
PDFAConvertParams
PDFAConvertParams(booleanremoveAllAnnotations, booleanignoreFontErrors, booleanabortIfXFAIsPresent, booleannoValidationErrors, intrasterizationResolution)Parameters
removeAllAnnotations: booleanRemove all annotations whether legal or illegal.
ignoreFontErrors: booleanRasterize a page when fonts cannot be embedded.
abortIfXFAIsPresent: booleanAbort when XFA is present for PDF/A-1.
noValidationErrors: booleanIgnore validation errors.
rasterizationResolution: intRasterization resolution.
Parameters for converting to PDF/A.
PDFAConvertParams
PDFAConvertParams(booleanremoveAllAnnotations, booleanignoreFontErrors, booleanabortIfXFAIsPresent, booleannoValidationErrors, intrasterizationResolution, booleanvalidateImplementationLimitsOfDocument)Parameters
removeAllAnnotations: booleanRemove all annotations whether legal or illegal.
ignoreFontErrors: booleanRasterize a page when fonts cannot be embedded.
abortIfXFAIsPresent: booleanAbort when XFA is present for PDF/A-1.
noValidationErrors: booleanIgnore validation errors.
rasterizationResolution: intRasterization resolution.
validateImplementationLimitsOfDocument: booleanValidate PDF Implementation Limits of the Document.
Parameters for converting to PDF/A.
Member Function Documentation
DisposeChildren
voidDisposeChildren()Returns:
void[static initializer]
static void[static initializer]()delete
synchronized voiddelete(Booleandisposing)Parameters
disposing: Boolean
Returns:
synchronized voiddelete
synchronized voiddelete()Returns:
synchronized voidfinalize
voidfinalize()Returns:
voidgetAbortIfXFAIsPresent
booleangetAbortIfXFAIsPresent()Returns:
booleanThe presence of XFA can result in some loss of data in output PDF/A-1 file as the PDFProcessor does not support XFA. However you can choose to abort the conversion if XFA is present by setting this parameter to true. By default we will not abort if XFA is present for PDF/A-1.
By default we will not abort if XFA is present for PDF/A-1.
If false we will convert even if XFA is found. If true we will abort the process if XFA is found.
getIgnoreFontErrors
booleangetIgnoreFontErrors()Returns:
booleanIf we encounter any errors like unembeddable fonts etc. while conversion then we try to rasterize the current page on which the error occured. However the client can modify this behavior by setting the value of this parameter to false in which case we will throw an error if we encounter any problems while conversion.
By default we will rasterize the page on error.
If true we will try to rasterize the current page if any error occured. If false we will abort and throw an exception if any error occured.
getNoValidationErrors
booleangetNoValidationErrors()Returns:
booleanPermit validation errors to be ignored
When true, PDF Implementation Limits (as defined in the PDF Specification of the PDF/A target) of the page are ignored. When false, PDF Implementation Limits of the Page are checked and if violated will cause the Page to be rasterized as a fallback mechanism when IgnoreFontErrors is true or simply raise an error if IgnoreFontErrors is false.
getProfileDesc
StringgetProfileDesc()Returns:
StringThe Output Intent of a PDF/A document may be any valid CMYK Profile for CMYK Conversion, and any valid RGB profile for RGB conversion. 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 CMYK Conversions, and "sRGB IEC61966-2.1" for RGB conversions.
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.
getRasterizationResolution
intgetRasterizationResolution()Returns:
intPermit user to select rasterization resolution When this value is zero, we will rasterize at 72 DPI (Legacy Behaviour). Otherwise, we will interpret the value as the desired resolution.
getRemoveAllAnnotations
booleangetRemoveAllAnnotations()Returns:
booleanSome of the standards like PDF/A 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/A compliant file.
getValidateImplementationLimitsOfDocument
booleangetValidateImplementationLimitsOfDocument()Returns:
booleanValidate PDF Implementation Limits (as defined in the PDF Specification of the PDF/A target) of the Document. When true. PDF Implementation Limits are checked and if violated raise an error. When false, PDF Implementation Limits are not checked. Note this option applies to the Whole document versus only Pages in the NoValidationErrors option. NOTE: It's recommended NoValidationErrors be set to false, IgnoreFontErrors be set to false, and ValidateImplementationLimitsOfDocument be set to true for getting the best quality output that adheres to the specification.
setAbortIfXFAIsPresent
voidsetAbortIfXFAIsPresent(booleantheSetting)Parameters
theSetting: boolean
Returns:
voidThe presence of XFA can result in some loss of data in output PDF/A-1 file as the PDFProcessor does not support XFA. However you can choose to abort the conversion if XFA is present by setting this parameter to true. By default we will not abort if XFA is present for PDF/A-1.
By default we will not abort if XFA is present for PDF/A-1.
If false we will convert even if XFA is found. If true we will abort the process if XFA is found.
setIgnoreFontErrors
voidsetIgnoreFontErrors(booleantheSetting)Parameters
theSetting: boolean
Returns:
voidIf we encounter any errors like unembeddable fonts etc. while conversion then we try to rasterize the current page on which the error occured. However the client can modify this behavior by setting the value of this parameter to false in which case we will throw an error if we encounter any problems while conversion.
By default we will rasterize the page on error.
If true we will try to rasterize the current page if any error occured. If false we will abort and throw an exception if any error occured.
setNoValidationErrors
voidsetNoValidationErrors(booleantheSetting)Parameters
theSetting: boolean
Returns:
voidPermit validation errors to be ignored
When true, PDF Implementation Limits (as defined in the PDF Specification of the PDF/A target) of the page are ignored. When false, PDF Implementation Limits of the Page are checked and if violated will cause the Page to be rasterized as a fallback mechanism when IgnoreFontErrors is true or simply raise an error if IgnoreFontErrors is false.
setProfileDesc
voidsetProfileDesc(Stringprofile)Parameters
profile: String
Returns:
voidThe Output Intent of a PDF/A document may be any valid CMYK Profile for CMYK Conversion, and any valid RGB profile for RGB conversion. 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 CMYK Conversions, and "sRGB IEC61966-2.1" for RGB conversions.
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.
setRasterizationResolution
voidsetRasterizationResolution(inttheSetting)Parameters
theSetting: int
Returns:
voidPermit user to select rasterization resolution When this value is zero, we will rasterize at 72 DPI (Legacy Behaviour). Otherwise, we will interpret the value as the desired resolution.
setRemoveAllAnnotations
voidsetRemoveAllAnnotations(booleantheSetting)Parameters
theSetting: boolean
Returns:
voidSome of the standards like PDF/A 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/A compliant file.
setValidateImplementationLimitsOfDocument
voidsetValidateImplementationLimitsOfDocument(booleanvalidateImplementationLimitsOfDocument)Parameters
validateImplementationLimitsOfDocument: boolean
Returns:
voidValidate PDF Implementation Limits (as defined in the PDF Specification of the PDF/A target) of the Document. When true. PDF Implementation Limits are checked and if violated raise an error. When false, PDF Implementation Limits are not checked. Note this option applies to the Whole document versus only Pages in the NoValidationErrors option. NOTE: It's recommended NoValidationErrors be set to false, IgnoreFontErrors be set to false, and ValidateImplementationLimitsOfDocument be set to true for getting the best quality output that adheres to the specification.