Class PdfADocument

java.lang.Object

com.itextpdf.kernel.pdf.PdfDocument

com.itextpdf.pdfa.PdfADocument

All Implemented Interfaces:

Closeable, AutoCloseable

public class PdfADocument
extends PdfDocument

This class extends PdfDocument and is in charge of creating files that comply with the PDF/A standard.

Client code is still responsible for making sure the file is actually PDF/A compliant: multiple steps must be undertaken (depending on the PdfConformance) to ensure that the PDF/A standard is followed.

This class will throw exceptions, mostly PdfAConformanceException, and thus refuse to output a PDF/A file if at any point the document does not adhere to the PDF/A guidelines specified by the PdfConformance.

Field Summary

Fields inherited from class PdfDocument

catalog, closed, closeReader, closeWriter, defaultFontStrategy, documentInfoHelper, fingerPrint, flushUnusedObjects, isClosing, pdfConformance, pdfPageFactory, pdfVersion, properties, reader, serializeOptions, structParentIndex, structTreeRoot, tagStructureContext, trailer, writer

Constructor Summary

Constructors

Constructor	Description
PdfADocument(PdfReader reader, PdfWriter writer)	Opens a PDF/A document in the stamping mode.
PdfADocument(PdfReader reader, PdfWriter writer, StampingProperties properties)	Opens a PDF/A document in stamping mode.
PdfADocument(PdfWriter writer, PdfAConformance aConformance, PdfOutputIntent outputIntent)	Constructs a new PdfADocument for writing purposes, i.e.
PdfADocument(PdfWriter writer, PdfAConformance aConformance, PdfOutputIntent outputIntent, DocumentProperties properties)	Constructs a new PdfADocument for writing purposes, i.e.

Method Summary

Modifier and Type	Method	Description
private static PdfWriter	configureWriterProperties(PdfWriter writer, PdfAConformance aConformance)
static PdfAChecker	getCorrectCheckerFromConformance(PdfAConformance aConformance)	Gets correct PdfAChecker for specified PDF/A conformance.
private static PdfVersion	getPdfVersionAccordingToConformance(PdfAConformance aConformance)

Methods inherited from class PdfDocument

addAssociatedFile, addEventHandler, addFileAttachment, addFont, addNamedDestination, addNamedDestination, addNewPage, addNewPage, addNewPage, addNewPage, addOutputIntent, addPage, addPage, checkAndAddPage, checkAndAddPage, checkClosingStatus, checkIsoConformance, close, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, createNextIndirectReference, dispatchEvent, findFont, flushCopiedObjects, flushFonts, flushObject, getAssociatedFiles, getCatalog, getConformance, getDefaultFont, getDefaultPageSize, getDiContainer, getDocumentFonts, getDocumentId, getDocumentIdWrapper, getDocumentInfo, getEncryptedPayloadDocument, getFingerPrint, getFirstPage, getFont, getLastPage, getMemoryLimitsAwareHandler, getModifiedDocumentId, getNextStructParentIndex, getNumberOfPages, getNumberOfPdfObjects, getOriginalDocumentId, getOutlines, getPage, getPage, getPageFactory, getPageLabels, getPageNumber, getPageNumber, getPdfObject, getPdfVersion, getReader, getSerializeOptions, getStructTreeRoot, getTagStructureContext, getTrailer, getWriter, getXmpMetadata, getXmpMetadata, getXmpMetadataBytes, getXmpMetadataBytes, hasEventHandler, hasOutlines, initializeOutlines, initTagStructureContext, isAppendMode, isClosed, isCloseReader, isCloseWriter, isClosing, isFlushUnusedObjects, isTagged, listIndirectReferences, markStreamAsEmbeddedFile, movePage, movePage, open, registerProduct, removeAllHandlers, removeEventHandler, removePage, removePage, setCloseReader, setCloseWriter, setDefaultPageSize, setEncryptedPayload, setFlushUnusedObjects, setSerializeOptions, setTagged, setUserProperties, setXmpMetadata, setXmpMetadata, setXmpMetadata, storeDestinationToReaddress, tryInitTagStructure, updateDefaultXmpMetadata, updateXmpMetadata

Methods inherited from class Object

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

Constructor Details

PdfADocument

public PdfADocument(PdfWriter writer,
 PdfAConformance aConformance,
 PdfOutputIntent outputIntent)

Constructs a new PdfADocument for writing purposes, i.e. from scratch. A PDF/A file has a conformance, and must have an explicit output intent.

Parameters:

writer - the PdfWriter object to write to

aConformance - the generation and strictness level of the PDF/A that must be followed.

outputIntent - a PdfOutputIntent

PdfADocument

public PdfADocument(PdfWriter writer,
 PdfAConformance aConformance,
 PdfOutputIntent outputIntent,
 DocumentProperties properties)

Constructs a new PdfADocument for writing purposes, i.e. from scratch. A PDF/A file has a conformance, and must have an explicit output intent.

Parameters:

writer - the PdfWriter object to write to

aConformance - the generation and strictness level of the PDF/A that must be followed.

outputIntent - a PdfOutputIntent

properties - a DocumentProperties

PdfADocument

public PdfADocument(PdfReader reader,
 PdfWriter writer)

Opens a PDF/A document in the stamping mode.

Parameters:

reader - PDF reader.

writer - PDF writer.

PdfADocument

public PdfADocument(PdfReader reader,
 PdfWriter writer,
 StampingProperties properties)

Opens a PDF/A document in stamping mode.

Parameters:

reader - PDF reader.

writer - PDF writer.

properties - properties of the stamping process

Method Details

getCorrectCheckerFromConformance

public static PdfAChecker getCorrectCheckerFromConformance(PdfAConformance aConformance)

Gets correct PdfAChecker for specified PDF/A conformance.

Parameters:

aConformance - the conformance for which checker is needed

Returns:

the correct PDF/A checker

getPdfVersionAccordingToConformance

private static PdfVersion getPdfVersionAccordingToConformance(PdfAConformance aConformance)

configureWriterProperties

private static PdfWriter configureWriterProperties(PdfWriter writer,
 PdfAConformance aConformance)