com.itextpdf.text.pdf

Class PdfACopy

java.lang.Object

com.itextpdf.text.DocWriter

com.itextpdf.text.pdf.PdfWriter

com.itextpdf.text.pdf.PdfCopy

com.itextpdf.text.pdf.PdfACopy

All Implemented Interfaces:

DocListener, ElementListener, PdfAnnotations, PdfDocumentActions, PdfEncryptionSettings, PdfPageActions, PdfRunDirection, PdfVersion, PdfViewerPreferences, EventListener

Direct Known Subclasses:

PdfASmartCopy

public class PdfACopy
extends PdfCopy

Extension of PdfCopy that will attempt to keep a file in conformance with the PDF/A standard.

See Also:

PdfCopy

Nested Class Summary

Nested classes/interfaces inherited from class com.itextpdf.text.pdf.PdfCopy

PdfCopy.ImportedPage, PdfCopy.PageStamp, PdfCopy.StampContent

Nested classes/interfaces inherited from class com.itextpdf.text.pdf.PdfWriter

PdfWriter.PdfBody, PdfWriter.PdfTrailer

Field Summary

Fields

Modifier and Type	Field and Description
protected Counter	COUNTER

Fields inherited from class com.itextpdf.text.pdf.PdfCopy

disableIndirects, fieldArray, fieldKeys, fields, fieldTemplates, importedPages, indirectMap, indirectObjects, indirects, mergeFields, namePtr, parentObjects, reader, savedObjects, structTreeRootReference, updateRootKids, widgetKeys

Fields inherited from class com.itextpdf.text.pdf.PdfWriter

ALLOW_ASSEMBLY, ALLOW_COPY, ALLOW_DEGRADED_PRINTING, ALLOW_FILL_IN, ALLOW_MODIFY_ANNOTATIONS, ALLOW_MODIFY_CONTENTS, ALLOW_PRINTING, ALLOW_SCREENREADERS, AllowAssembly, AllowCopy, AllowDegradedPrinting, AllowFillIn, AllowModifyAnnotations, AllowModifyContents, AllowPrinting, AllowScreenReaders, body, CenterWindow, colorNumber, colorProfile, compressionLevel, crypto, currentPageNumber, currentPdfReaderInstance, defaultColorspace, DID_PRINT, DID_SAVE, directContent, directContentUnder, DirectionL2R, DirectionR2L, DisplayDocTitle, DO_NOT_ENCRYPT_METADATA, DOCUMENT_CLOSE, documentColors, documentExtGState, documentFonts, documentOCG, documentOCGorder, documentPatterns, documentProperties, documentShadingPatterns, documentShadings, documentSpotPatterns, EMBEDDED_FILES_ONLY, ENCRYPTION_AES_128, ENCRYPTION_AES_256, extraCatalog, FitWindow, fontNumber, formXObjects, formXObjectsCounter, fullCompression, GENERATION_MAX, group, HideMenubar, HideToolbar, HideWindowUI, imageDictionary, JBIG2Globals, markAll, markInlineElementsOnly, newBookmarks, NO_SPACE_CHAR_RATIO, NonFullScreenPageModeUseNone, NonFullScreenPageModeUseOC, NonFullScreenPageModeUseOutlines, NonFullScreenPageModeUseThumbs, OCGLocked, OCGRadioGroup, OCProperties, originalFileID, PAGE_CLOSE, PAGE_OPEN, pageDictEntries, PageLayoutOneColumn, PageLayoutSinglePage, PageLayoutTwoColumnLeft, PageLayoutTwoColumnRight, PageLayoutTwoPageLeft, PageLayoutTwoPageRight, PageModeFullScreen, PageModeUseAttachments, PageModeUseNone, PageModeUseOC, PageModeUseOutlines, PageModeUseThumbs, pageReferences, patternColorspaceCMYK, patternColorspaceGRAY, patternColorspaceRGB, patternNumber, pdf, pdf_version, PDF_VERSION_1_2, PDF_VERSION_1_3, PDF_VERSION_1_4, PDF_VERSION_1_5, PDF_VERSION_1_6, PDF_VERSION_1_7, pdfIsoConformance, PDFX1A2001, PDFX32002, PDFXNONE, prevxref, PrintScalingNone, readerInstances, root, RUN_DIRECTION_DEFAULT, RUN_DIRECTION_LTR, RUN_DIRECTION_NO_BIDI, RUN_DIRECTION_RTL, runDirection, SIGNATURE_APPEND_ONLY, SIGNATURE_EXISTS, SPACE_CHAR_RATIO_DEFAULT, STANDARD_ENCRYPTION_128, STANDARD_ENCRYPTION_40, STRENGTH128BITS, STRENGTH40BITS, structureTreeRoot, tabs, tagged, taggingMode, ttfUnicodeWriter, VERSION_1_2, VERSION_1_3, VERSION_1_4, VERSION_1_5, VERSION_1_6, VERSION_1_7, WILL_PRINT, WILL_SAVE, xmpMetadata, xmpWriter

Fields inherited from class com.itextpdf.text.DocWriter

closeStream, document, EQUALS, FORWARD, GT, LT, NEWLINE, open, os, pageSize, pause, QUOTE, SPACE, TAB

Constructor Summary

Constructors

Constructor and Description
PdfACopy(Document document, OutputStream os, PdfAConformanceLevel conformanceLevel) Constructor

Method Summary

Modifier and Type	Method and Description
void	addDocument(PdfReader reader)
void	addPage(PdfImportedPage iPage) Add an imported page to our output
protected void	cacheObject(PdfIndirectObject iobj) Use this method for caching objects.
void	close() Signals that the Document was closed and that no other Elements will be added.
PdfCopy.PageStamp	createPageStamp(PdfImportedPage iPage) Create a page stamp.
protected XmpWriter	createXmpWriter(ByteArrayOutputStream baos, HashMap<String,String> info)
protected XmpWriter	createXmpWriter(ByteArrayOutputStream baos, PdfDictionary info)
protected Counter	getCounter()
protected TtfUnicodeWriter	getTtfUnicodeWriter()
protected PdfIsoConformance	initPdfIsoConformance()
boolean	setOutputIntents(PdfReader reader, boolean checkExistence) Copies the output intent dictionary from other document to this one.
void	setOutputIntents(String outputConditionIdentifier, String outputCondition, String registryName, String info, ICC_Profile colorProfile) Sets the values of the output intent dictionary.

Methods inherited from class com.itextpdf.text.pdf.PdfCopy

add, addAnnotation, addDocument, addPage, addToBody, addToBody, copyArray, copyArray, copyDictionary, copyDictionary, copyDocumentFields, copyIndirect, copyIndirect, copyObject, copyObject, copyStream, fixStructureTreeRoot, fixTaggedStructure, flushAcroFields, flushIndirectObjects, flushTaggedObjects, freeReader, getCatalog, getImportedPage, getImportedPage, getImportedPageImpl, getOffStateName, isRotateContents, isStructTreeRootReference, setFromIPage, setFromReader, setMergeFields, setPageEvent, setRotateContents, structureTreeRootKidsForReaderImported

Methods inherited from class com.itextpdf.text.pdf.PdfWriter

add, addCalculationOrder, addDeveloperExtension, addDirectImageSimple, addDirectImageSimple, addFileAttachment, addFileAttachment, addFileAttachment, addJavaScript, addJavaScript, addJavaScript, addJavaScript, addJavaScript, addJavaScript, addNamedDestination, addNamedDestinations, addOCGRadioGroup, addPageDictEntry, addSharedObjectsToBody, addToBody, addToBody, addToBody, addToBody, addViewerPreference, addXFormsToBody, buildStructTreeRootForTagged, checkElementRole, checkPdfIsoConformance, checkPdfIsoConformance, clearTextWrap, createAnnotation, createAnnotation, createAnnotation, createXmpMetadata, fillOCProperties, getAcroForm, getBoxSize, getBoxSize, getColorProfile, getCompressionLevel, getCurrentDocumentSize, getCurrentPageNumber, getDefaultColorspace, getDirectContent, getDirectContentUnder, getExtraCatalog, getGroup, getIndirectReferenceNumber, getInfo, getInstance, getInstance, getNameString, getNewObjectNumber, getOCProperties, getOs, getPageDictEntries, getPageEvent, getPageNumber, getPageReference, getPageSize, getPdfIndirectReference, getPdfReaderInstance, getPDFXConformance, getReferenceJBIG2Globals, getRootOutline, getRunDirection, getSpaceCharRatio, getStandardStructElems, getStructureTreeRoot, getTabs, getVerticalPosition, getXmpWriter, isFullCompression, isPageEmpty, isPdfIso, isPdfX, isRgbTransparencyBlending, isStrictImageSequence, isTagged, isUserProperties, lockLayer, needToBeMarkedInContent, open, releaseTemplate, reorderPages, resetPageDictEntries, setAdditionalAction, setAtLeastPdfVersion, setBoxSize, setCollection, setCompressionLevel, setCropBoxSize, setDefaultColorspace, setDuration, setEncryption, setEncryption, setEncryption, setEncryption, setEncryption, setFullCompression, setGroup, setInitialLeading, setLanguage, setLinearPageMode, setOpenAction, setOpenAction, setOutlines, setOutputIntents, setPageAction, setPageEmpty, setPageLabels, setPageViewport, setPageXmpMetadata, setPdfVersion, setPdfVersion, setPDFXConformance, setRgbTransparencyBlending, setRunDirection, setSigFlags, setSpaceCharRatio, setStrictImageSequence, setTabs, setTagged, setTagged, setThumbnail, setTransition, setUserProperties, setUserunit, setViewerPreferences, setXmpMetadata, useExternalCacheForTagStructure, writeKeyInfo, writeOutlines

Methods inherited from class com.itextpdf.text.DocWriter

add, addTabs, flush, getISOBytes, isCloseStream, isPaused, newPage, pause, resetPageCount, resume, setCloseStream, setMarginMirroring, setMarginMirroringTopBottom, setMargins, setPageCount, setPageSize, write, write, writeEnd, writeEnd, writeMarkupAttributes, writeStart

Methods inherited from class java.lang.Object

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

Field Detail

COUNTER

protected Counter COUNTER

Constructor Detail

PdfACopy

public PdfACopy(Document document,
                OutputStream os,
                PdfAConformanceLevel conformanceLevel)
         throws DocumentException

Constructor

Parameters:

document - document

os - outputstream

Throws:

DocumentException

Method Detail

getCounter

protected Counter getCounter()

Overrides:

getCounter in class PdfCopy

initPdfIsoConformance

protected PdfIsoConformance initPdfIsoConformance()

Overrides:

initPdfIsoConformance in class PdfWriter

cacheObject

protected void cacheObject(PdfIndirectObject iobj)

Description copied from class: PdfWriter

Use this method for caching objects.

Overrides:

cacheObject in class PdfCopy

Parameters:

iobj - @see PdfIndirectObject

addDocument

public void addDocument(PdfReader reader)
                 throws DocumentException,
                        IOException

Overrides:

addDocument in class PdfCopy

Throws:

DocumentException

IOException

addPage

public void addPage(PdfImportedPage iPage)
             throws IOException,
                    BadPdfFormatException

Description copied from class: PdfCopy

Add an imported page to our output

Overrides:

addPage in class PdfCopy

Parameters:

iPage - an imported page

Throws:

IOException

BadPdfFormatException

createPageStamp

public PdfCopy.PageStamp createPageStamp(PdfImportedPage iPage)

Description copied from class: PdfCopy

Create a page stamp. New content and annotations, including new fields, are allowed. The fields added cannot have parents in another pages. This method modifies the PdfReader instance.

The general usage to stamp something in a page is:

 PdfImportedPage page = copy.getImportedPage(reader, 1);
 PdfCopy.PageStamp ps = copy.createPageStamp(page);
 ps.addAnnotation(PdfAnnotation.createText(copy, new Rectangle(50, 180, 70, 200), "Hello", "No Thanks", true, "Comment"));
 PdfContentByte under = ps.getUnderContent();
 under.addImage(img);
 PdfContentByte over = ps.getOverContent();
 over.beginText();
 over.setFontAndSize(bf, 18);
 over.setTextMatrix(30, 30);
 over.showText("total page " + totalPage);
 over.endText();
 ps.alterContents();
 copy.addPage(page);
 

Overrides:

createPageStamp in class PdfCopy

Parameters:

iPage - an imported page

Returns:

the PageStamp

setOutputIntents

public void setOutputIntents(String outputConditionIdentifier,
                             String outputCondition,
                             String registryName,
                             String info,
                             ICC_Profile colorProfile)
                      throws IOException

Description copied from class: PdfWriter

Sets the values of the output intent dictionary. Null values are allowed to suppress any key.

Overrides:

setOutputIntents in class PdfWriter

Parameters:

outputConditionIdentifier - a value

outputCondition - a value

registryName - a value

info - a value

colorProfile - a value

Throws:

IOException - on error

setOutputIntents

public boolean setOutputIntents(PdfReader reader,
                                boolean checkExistence)
                         throws IOException

Copies the output intent dictionary from other document to this one.

Overrides:

setOutputIntents in class PdfWriter

Parameters:

reader - the other document

checkExistence - true to just check for the existence of a valid output intent dictionary, false to insert the dictionary if it exists

Returns:

true if the output intent dictionary exists, false otherwise

Throws:

IOException - on error

createXmpWriter

protected XmpWriter createXmpWriter(ByteArrayOutputStream baos,
                                    PdfDictionary info)
                             throws IOException

Overrides:

createXmpWriter in class PdfWriter

Throws:

IOException

createXmpWriter

protected XmpWriter createXmpWriter(ByteArrayOutputStream baos,
                                    HashMap<String,String> info)
                             throws IOException

Overrides:

createXmpWriter in class PdfWriter

Throws:

IOException

getTtfUnicodeWriter

protected TtfUnicodeWriter getTtfUnicodeWriter()

Overrides:

getTtfUnicodeWriter in class PdfWriter

See Also:

PdfWriter.getTtfUnicodeWriter()

close

public void close()

Description copied from class: PdfCopy

Signals that the Document was closed and that no other Elements will be added.

The pages-tree is built and written to the outputstream. A Catalog is constructed, as well as an Info-object, the reference table is composed and everything is written to the outputstream embedded in a Trailer.

Specified by:

close in interface DocListener

Overrides:

close in class PdfCopy

See Also:

DocWriter.close()