com.itextpdf.pdfa

Class PdfADocument

java.lang.Object

com.itextpdf.kernel.pdf.PdfDocument

com.itextpdf.pdfa.PdfADocument

All Implemented Interfaces:

com.itextpdf.kernel.events.IEventDispatcher, Closeable, Serializable, AutoCloseable

public class PdfADocument
extends com.itextpdf.kernel.pdf.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.

See Also:

Serialized Form

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, currentPage, defaultPageSize, eventDispatcher, fingerPrint, flushUnusedObjects, info, isClosing, pdfVersion, properties, reader, structParentIndex, structTreeRoot, tagStructureContext, trailer, writer, xmpMetadata

Constructor Summary

Constructors

Constructor and Description
PdfADocument(com.itextpdf.kernel.pdf.PdfReader reader, com.itextpdf.kernel.pdf.PdfWriter writer) Opens a PDF/A document in the stamping mode.
PdfADocument(com.itextpdf.kernel.pdf.PdfReader reader, com.itextpdf.kernel.pdf.PdfWriter writer, com.itextpdf.kernel.pdf.StampingProperties properties) Open a PDF/A document in stamping mode.
PdfADocument(com.itextpdf.kernel.pdf.PdfWriter writer, com.itextpdf.kernel.pdf.PdfAConformanceLevel conformanceLevel, com.itextpdf.kernel.pdf.PdfOutputIntent outputIntent) Constructs a new PdfADocument for writing purposes, i.e.
PdfADocument(com.itextpdf.kernel.pdf.PdfWriter writer, com.itextpdf.kernel.pdf.PdfAConformanceLevel conformanceLevel, com.itextpdf.kernel.pdf.PdfOutputIntent outputIntent, com.itextpdf.kernel.pdf.DocumentProperties properties) Constructs a new PdfADocument for writing purposes, i.e.

Method Summary

Modifier and Type	Method and Description
protected void	addCustomMetadataExtensions(com.itextpdf.kernel.xmp.XMPMeta xmpMeta)
protected void	checkIsoConformance()
void	checkIsoConformance(Object obj, com.itextpdf.kernel.pdf.IsoKey key)
void	checkIsoConformance(Object obj, com.itextpdf.kernel.pdf.IsoKey key, com.itextpdf.kernel.pdf.PdfResources resources)
protected void	flushFonts()
protected void	flushObject(com.itextpdf.kernel.pdf.PdfObject pdfObject, boolean canBeInObjStm)
com.itextpdf.kernel.pdf.PdfAConformanceLevel	getConformanceLevel() Gets the PdfAConformanceLevel set in the constructor or in the metadata of the PdfReader.
protected List<com.itextpdf.kernel.log.ICounter>	getCounters() Deprecated.
protected void	initTagStructureContext()
protected void	setChecker(com.itextpdf.kernel.pdf.PdfAConformanceLevel conformanceLevel)
protected void	updateXmpMetadata()

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

addAssociatedFile, addEventHandler, addFileAttachment, addFont, addNamedDestination, addNewPage, addNewPage, addNewPage, addNewPage, addOutputIntent, addPage, addPage, checkAndAddPage, checkAndAddPage, checkClosingStatus, checkShowTextIsoConformance, close, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, createNextIndirectReference, dispatchEvent, dispatchEvent, findFont, flushCopiedObjects, getAssociatedFiles, getCatalog, getDefaultFont, getDefaultPageSize, getDocumentFonts, getDocumentInfo, getEncryptedPayloadDocument, getFingerPrint, getFirstPage, getFont, getLastPage, getNextStructParentIndex, getNumberOfPages, getNumberOfPdfObjects, getOutlines, getPage, getPage, getPageLabels, getPageNumber, getPageNumber, getPdfObject, getPdfVersion, getReader, getStructTreeRoot, getTagStructureContext, getTrailer, getWriter, getXmpMetadata, getXmpMetadata, hasEventHandler, hasOutlines, initializeOutlines, isAppendMode, isClosed, isCloseReader, isCloseWriter, isFlushUnusedObjects, isTagged, listIndirectReferences, markObjectAsMustBeFlushed, movePage, movePage, open, registerProduct, removeAllHandlers, removeEventHandler, removePage, removePage, setCloseReader, setCloseWriter, setDefaultPageSize, setEncryptedPayload, setFlushUnusedObjects, setTagged, setUserProperties, setXmpMetadata, setXmpMetadata, setXmpMetadata, storeLinkAnnotation, 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(com.itextpdf.kernel.pdf.PdfWriter writer,
                    com.itextpdf.kernel.pdf.PdfAConformanceLevel conformanceLevel,
                    com.itextpdf.kernel.pdf.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(com.itextpdf.kernel.pdf.PdfWriter writer,
                    com.itextpdf.kernel.pdf.PdfAConformanceLevel conformanceLevel,
                    com.itextpdf.kernel.pdf.PdfOutputIntent outputIntent,
                    com.itextpdf.kernel.pdf.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(com.itextpdf.kernel.pdf.PdfReader reader,
                    com.itextpdf.kernel.pdf.PdfWriter writer)

Opens a PDF/A document in the stamping mode.

Parameters:

reader - PDF reader.

writer - PDF writer.

PdfADocument

public PdfADocument(com.itextpdf.kernel.pdf.PdfReader reader,
                    com.itextpdf.kernel.pdf.PdfWriter writer,
                    com.itextpdf.kernel.pdf.StampingProperties properties)

Open a PDF/A document in stamping mode.

Parameters:

reader - PDF reader.

writer - PDF writer.

properties - properties of the stamping process

Method Detail

checkIsoConformance

public void checkIsoConformance(Object obj,
                                com.itextpdf.kernel.pdf.IsoKey key)

Overrides:

checkIsoConformance in class com.itextpdf.kernel.pdf.PdfDocument

checkIsoConformance

public void checkIsoConformance(Object obj,
                                com.itextpdf.kernel.pdf.IsoKey key,
                                com.itextpdf.kernel.pdf.PdfResources resources)

Overrides:

checkIsoConformance in class com.itextpdf.kernel.pdf.PdfDocument

getConformanceLevel

public com.itextpdf.kernel.pdf.PdfAConformanceLevel getConformanceLevel()

Gets the PdfAConformanceLevel set in the constructor or in the metadata of the PdfReader.

Returns:

a PdfAConformanceLevel

addCustomMetadataExtensions

protected void addCustomMetadataExtensions(com.itextpdf.kernel.xmp.XMPMeta xmpMeta)

Overrides:

addCustomMetadataExtensions in class com.itextpdf.kernel.pdf.PdfDocument

updateXmpMetadata

protected void updateXmpMetadata()

Overrides:

updateXmpMetadata in class com.itextpdf.kernel.pdf.PdfDocument

checkIsoConformance

protected void checkIsoConformance()

Overrides:

checkIsoConformance in class com.itextpdf.kernel.pdf.PdfDocument

flushObject

protected void flushObject(com.itextpdf.kernel.pdf.PdfObject pdfObject,
                           boolean canBeInObjStm)
                    throws IOException

Overrides:

flushObject in class com.itextpdf.kernel.pdf.PdfDocument

Throws:

IOException

flushFonts

protected void flushFonts()

Overrides:

flushFonts in class com.itextpdf.kernel.pdf.PdfDocument

setChecker

protected void setChecker(com.itextpdf.kernel.pdf.PdfAConformanceLevel conformanceLevel)

initTagStructureContext

protected void initTagStructureContext()

Overrides:

initTagStructureContext in class com.itextpdf.kernel.pdf.PdfDocument

getCounters

@Deprecated
protected List<com.itextpdf.kernel.log.ICounter> getCounters()

Deprecated.

Overrides:

getCounters in class com.itextpdf.kernel.pdf.PdfDocument