com.itextpdf.pdfa

Class PdfADocument

java.lang.Object

com.itextpdf.kernel.pdf.PdfDocument

com.itextpdf.pdfa.PdfADocument

All Implemented Interfaces:

IEventDispatcher, Closeable, AutoCloseable

Direct Known Subclasses:

PdfAAgnosticPdfDocument

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 PdfAConformanceLevel) 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 PdfAConformanceLevel.

Field Summary

Fields

Modifier and Type	Field and Description
protected PdfAChecker	checker

Fields inherited from class com.itextpdf.kernel.pdf.PdfDocument

catalog, closed, closeReader, closeWriter, eventDispatcher, fingerPrint, flushUnusedObjects, info, isClosing, pdfVersion, properties, reader, serializeOptions, structParentIndex, structTreeRoot, tagStructureContext, trailer, writer, xmpMetadata

Constructor Summary

Constructors

Constructor and 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, PdfAConformanceLevel conformanceLevel, PdfOutputIntent outputIntent) Constructs a new PdfADocument for writing purposes, i.e.
PdfADocument(PdfWriter writer, PdfAConformanceLevel conformanceLevel, PdfOutputIntent outputIntent, DocumentProperties properties) Constructs a new PdfADocument for writing purposes, i.e.

Method Summary

Modifier and Type	Method and Description
protected void	addCustomMetadataExtensions(XMPMeta xmpMeta)
void	addOutputIntent(PdfOutputIntent outputIntent)
protected void	checkIsoConformance()
void	checkIsoConformance(Object obj, IsoKey key, PdfResources resources, PdfStream contentStream, Object extra)
protected void	flushInfoDictionary(boolean appendMode)
protected void	flushObject(PdfObject pdfObject, boolean canBeInObjStm)
IConformanceLevel	getConformanceLevel()
PdfFont	getDefaultFont() No default font for PDF/A documents.
protected IPdfPageFactory	getPageFactory()
protected void	initTagStructureContext() Initializes tagStructureContext to track necessary information of document's tag structure.
protected void	setChecker(PdfAChecker checker)
protected void	setChecker(PdfAConformanceLevel conformanceLevel) Sets the checker that defines the requirements of the PDF/A standard depending on conformance level.
protected void	updateXmpMetadata()

Methods inherited from class com.itextpdf.kernel.pdf.PdfDocument

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

Methods inherited from class java.lang.Object

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

Field Detail

checker

protected PdfAChecker checker

Constructor Detail

PdfADocument

public PdfADocument(PdfWriter writer,
                    PdfAConformanceLevel conformanceLevel,
                    PdfOutputIntent outputIntent)

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

Parameters:

writer - the PdfWriter object to write to

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

outputIntent - a PdfOutputIntent

PdfADocument

public PdfADocument(PdfWriter writer,
                    PdfAConformanceLevel conformanceLevel,
                    PdfOutputIntent outputIntent,
                    DocumentProperties properties)

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

Parameters:

writer - the PdfWriter object to write to

conformanceLevel - 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 Detail

getDefaultFont

public PdfFont getDefaultFont()

No default font for PDF/A documents.

Overrides:

getDefaultFont in class PdfDocument

Returns:

null.

getConformanceLevel

public IConformanceLevel getConformanceLevel()

Overrides:

getConformanceLevel in class PdfDocument

addOutputIntent

public void addOutputIntent(PdfOutputIntent outputIntent)

Overrides:

addOutputIntent in class PdfDocument

Parameters:

outputIntent -

addCustomMetadataExtensions

protected void addCustomMetadataExtensions(XMPMeta xmpMeta)

Overrides:

addCustomMetadataExtensions in class PdfDocument

updateXmpMetadata

protected void updateXmpMetadata()

Overrides:

updateXmpMetadata in class PdfDocument

checkIsoConformance

protected void checkIsoConformance()

Overrides:

checkIsoConformance in class PdfDocument

checkIsoConformance

public void checkIsoConformance(Object obj,
                                IsoKey key,
                                PdfResources resources,
                                PdfStream contentStream,
                                Object extra)

Overrides:

checkIsoConformance in class PdfDocument

Parameters:

obj - an object to conform.

key - type of object to conform.

resources - PdfResources associated with an object to check.

contentStream - current content stream.

extra - extra data required for the check.

flushObject

protected void flushObject(PdfObject pdfObject,
                           boolean canBeInObjStm)
                    throws IOException

Overrides:

flushObject in class PdfDocument

Throws:

IOException

setChecker

protected void setChecker(PdfAConformanceLevel conformanceLevel)

Sets the checker that defines the requirements of the PDF/A standard depending on conformance level.

Parameters:

conformanceLevel - PdfAConformanceLevel

setChecker

protected void setChecker(PdfAChecker checker)

initTagStructureContext

protected void initTagStructureContext()

Initializes tagStructureContext to track necessary information of document's tag structure.

Overrides:

initTagStructureContext in class PdfDocument

getPageFactory

protected IPdfPageFactory getPageFactory()

Overrides:

getPageFactory in class PdfDocument

flushInfoDictionary

protected void flushInfoDictionary(boolean appendMode)

Overrides:

flushInfoDictionary in class PdfDocument

Parameters:

appendMode -