com.itextpdf.zugferd

Class ZugferdDocument

java.lang.Object

com.itextpdf.kernel.pdf.PdfDocument

com.itextpdf.pdfa.PdfADocument

com.itextpdf.zugferd.ZugferdDocument

All Implemented Interfaces:

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

public class ZugferdDocument
extends com.itextpdf.pdfa.PdfADocument

ZUGFeRD documents need to be PDF/A-3 compliant. This class inherits from the iText 7 PdfADocument implementation for convenience. The PdfADocument class will handle all of the PDF/A-3 compliance, while this class will handle the ZUGFeRD compliance.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.itextpdf.pdfa.PdfADocument

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
ZugferdDocument(com.itextpdf.kernel.pdf.PdfWriter writer, com.itextpdf.kernel.pdf.PdfAConformanceLevel pdfaConformanceLevel, com.itextpdf.kernel.pdf.PdfOutputIntent outputIntent) Creates a ZUGFeRD document with the passed Pdf/A conformance level and output intent using the passed writer.
ZugferdDocument(com.itextpdf.kernel.pdf.PdfWriter writer, com.itextpdf.kernel.pdf.PdfOutputIntent outputIntent) Create a ZUGFeRD document with the given output intent using given the writer.
ZugferdDocument(com.itextpdf.kernel.pdf.PdfWriter writer, ZugferdConformanceLevel zugferdConformanceLevel, com.itextpdf.kernel.pdf.PdfAConformanceLevel pdfaConformanceLevel, com.itextpdf.kernel.pdf.PdfOutputIntent outputIntent) Creates a ZUGFeRD document with the passed ZUGFeRD conformance level, PDF/A conformance level and output intent using the passed writer.
ZugferdDocument(com.itextpdf.kernel.pdf.PdfWriter writer, ZugferdConformanceLevel zugferdConformanceLevel, com.itextpdf.kernel.pdf.PdfOutputIntent outputIntent) Creates a ZUGFeRD document with the passed ZUGFeRD conformance level and output intent using the passed writer.
ZugferdDocument(com.itextpdf.kernel.pdf.PdfWriter writer, ZugferdProperties properties) Creates a ZUGFeRD document with the passed ZUGFeRD conformance level, PDF/A conformance level and output intent using the passed writer.

Method Summary

Modifier and Type	Method and Description
protected void	addCustomMetadataExtensions(com.itextpdf.kernel.xmp.XMPMeta xmpMeta)
protected List<com.itextpdf.kernel.log.ICounter>	getCounters() Deprecated.
protected void	setChecker(com.itextpdf.kernel.pdf.PdfAConformanceLevel conformanceLevel)

Methods inherited from class com.itextpdf.pdfa.PdfADocument

checkIsoConformance, checkIsoConformance, checkIsoConformance, flushFonts, flushObject, getConformanceLevel, initTagStructureContext, 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, 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

Constructor Detail

ZugferdDocument

public ZugferdDocument(com.itextpdf.kernel.pdf.PdfWriter writer,
                       ZugferdProperties properties)

Creates a ZUGFeRD document with the passed ZUGFeRD conformance level, PDF/A conformance level and output intent using the passed writer.

Parameters:

writer - Writer to output the PDF

properties - ZUGFeRD properties.

ZugferdDocument

public ZugferdDocument(com.itextpdf.kernel.pdf.PdfWriter writer,
                       ZugferdConformanceLevel zugferdConformanceLevel,
                       com.itextpdf.kernel.pdf.PdfAConformanceLevel pdfaConformanceLevel,
                       com.itextpdf.kernel.pdf.PdfOutputIntent outputIntent)

Creates a ZUGFeRD document with the passed ZUGFeRD conformance level, PDF/A conformance level and output intent using the passed writer.

Parameters:

writer - Writer to output the PDF

zugferdConformanceLevel - ZUGFeRD conformance level, one of the following: BASIC, COMFORT or EXTENDED

pdfaConformanceLevel - PDF/A conformance level

outputIntent - PDF/A output intent for the document.

ZugferdDocument

public ZugferdDocument(com.itextpdf.kernel.pdf.PdfWriter writer,
                       ZugferdConformanceLevel zugferdConformanceLevel,
                       com.itextpdf.kernel.pdf.PdfOutputIntent outputIntent)

Creates a ZUGFeRD document with the passed ZUGFeRD conformance level and output intent using the passed writer. The PdfAConformanceLevel will be set to PDF/A-3B.

Parameters:

writer - Writer to output the pdf

zugferdConformanceLevel - ZUGFeRD conformance level, BASIC, COMFORT or EXTENDED

outputIntent - Pdf/A output intent for the document

ZugferdDocument

public ZugferdDocument(com.itextpdf.kernel.pdf.PdfWriter writer,
                       com.itextpdf.kernel.pdf.PdfAConformanceLevel pdfaConformanceLevel,
                       com.itextpdf.kernel.pdf.PdfOutputIntent outputIntent)

Creates a ZUGFeRD document with the passed Pdf/A conformance level and output intent using the passed writer. The ZUGFeRD Conformance level will be set to BASIC.

Parameters:

writer - Writer to output the pdf

pdfaConformanceLevel - Pdf/A conformance level

outputIntent - Pdf/A output intent for the document

ZugferdDocument

public ZugferdDocument(com.itextpdf.kernel.pdf.PdfWriter writer,
                       com.itextpdf.kernel.pdf.PdfOutputIntent outputIntent)

Create a ZUGFeRD document with the given output intent using given the writer. The ZUGFeRD Conformance level will be set to BASIC and the Pdf/A conformance level will be set to PDF/A-3B.

Parameters:

writer - Writer to output the pdf

outputIntent - Pdf/A output intent for the document

Method Detail

addCustomMetadataExtensions

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

Overrides:

addCustomMetadataExtensions in class com.itextpdf.pdfa.PdfADocument

setChecker

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

Overrides:

setChecker in class com.itextpdf.pdfa.PdfADocument

getCounters

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

Deprecated.

Overrides:

getCounters in class com.itextpdf.pdfa.PdfADocument