Class PdfCopyFieldsImp

java.lang.Object

com.aowagie.text.DocWriter

com.aowagie.text.pdf.PdfWriter

com.aowagie.text.pdf.PdfCopyFieldsImp

All Implemented Interfaces:

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

class PdfCopyFieldsImp
extends PdfWriter

Nested Class Summary

Nested classes/interfaces inherited from class PdfWriter

PdfWriter.PdfBody, PdfWriter.PdfTrailer

Field Summary

Fields

Modifier and Type	Field	Description
private final ArrayList	calculationOrder
private ArrayList	calculationOrderRefs
private boolean	closing
protected static final HashMap	fieldKeys
(package private) ArrayList	fields
private final HashMap	fieldTree
private RandomAccessFileOrArray	file
private PdfDictionary	form
private boolean	hasSignature
private static final PdfName	iTextTag
private final Document	nd
private final ArrayList	pageDics
private final ArrayList	pageRefs
private final HashMap	pages2intrefs
private final ArrayList	readers
(package private) HashMap	readers2intrefs
private final PdfDictionary	resources
private HashMap	tabOrder
private final HashMap	visited
private static final HashMap	widgetKeys
private static final Integer	zero

Fields inherited from class PdfWriter

ALLOW_ASSEMBLY, ALLOW_COPY, ALLOW_DEGRADED_PRINTING, ALLOW_FILL_IN, ALLOW_MODIFY_ANNOTATIONS, ALLOW_MODIFY_CONTENTS, ALLOW_PRINTING, ALLOW_SCREENREADERS, body, CenterWindow, compressionLevel, crypto, currentPdfReaderInstance, DID_PRINT, DID_SAVE, DirectionL2R, DirectionR2L, DisplayDocTitle, DO_NOT_ENCRYPT_METADATA, DOCUMENT_CLOSE, documentOCG, EMBEDDED_FILES_ONLY, ENCRYPTION_AES_128, ENCRYPTION_MASK, FitWindow, fullCompression, GENERATION_MAX, HideMenubar, HideToolbar, HideWindowUI, newBookmarks, NonFullScreenPageModeUseNone, NonFullScreenPageModeUseOC, NonFullScreenPageModeUseOutlines, NonFullScreenPageModeUseThumbs, OCGLocked, OCGRadioGroup, OCProperties, PageLayoutOneColumn, PageLayoutSinglePage, PageLayoutTwoColumnLeft, PageLayoutTwoColumnRight, PageLayoutTwoPageLeft, PageLayoutTwoPageRight, PageModeFullScreen, PageModeUseAttachments, PageModeUseNone, PageModeUseOC, PageModeUseOutlines, PageModeUseThumbs, 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, PDFA1A, PDFA1B, PDFA2A, PDFA2B, PDFX1A2001, PDFX32002, PDFXNONE, prevxref, PrintScalingNone, root, RUN_DIRECTION_DEFAULT, RUN_DIRECTION_LTR, RUN_DIRECTION_NO_BIDI, RUN_DIRECTION_RTL, STANDARD_ENCRYPTION_128, STANDARD_ENCRYPTION_40, VERSION_1_2, VERSION_1_3, VERSION_1_4, VERSION_1_5, VERSION_1_6, VERSION_1_7, WILL_PRINT, WILL_SAVE, xmpMetadata

Fields inherited from class DocWriter

open, os

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PdfCopyFieldsImp(OutputStream os, char pdfVersion, Calendar globalDate)
(package private)	PdfCopyFieldsImp(OutputStream os, Calendar globalDate)

Method Summary

Modifier and Type	Method	Description
(package private) void	addDocument(PdfReader reader)
(package private) void	addDocument(PdfReader reader, List pagesToKeep)
private void	addPageOffsetToField(HashMap fd, int pageOffset)
private void	adjustTabOrder(PdfArray annots, PdfIndirectReference ind, PdfNumber nn)
private PdfArray	branchForm(HashMap level, PdfIndirectReference parent, String fname)
void	close()	Signals that the Document was closed and that no other Elements will be added.
private void	closeIt()	Creates the new PDF by merging the fields and forms.
private void	createAcroForms()
private void	createWidgets(ArrayList list, AcroFields.Item item)
protected PdfDictionary	getCatalog(PdfIndirectReference rootObj)
private static String	getCOName(PdfReader reader, PRIndirectReference ref)
protected int	getNewObjectNumber(PdfReader reader, int number, int generation)
private PdfIndirectReference	getNewReference(PRIndirectReference ref)
PdfIndirectReference	getPageReference(int page)	Use this method to get a reference to a page existing or not.
(package private) RandomAccessFileOrArray	getReaderFile(PdfReader reader)
private boolean	isPage(PRIndirectReference ref)	Checks if a reference refers to a page object.
private boolean	isVisited(PRIndirectReference ref)	Checks if a reference has already been "visited" in the copy process.
private void	mergeField(String name, AcroFields.Item item)
(package private) void	mergeFields()
(package private) void	mergeWithMaster(HashMap fd)
void	openDoc()
private void	propagate(PdfObject obj, PdfIndirectReference refo, boolean restricted)
private boolean	setVisited(PRIndirectReference ref)	Sets a reference to "visited" in the copy process.
protected void	updateCalculationOrder(PdfReader reader)

Methods inherited from class PdfWriter

add, addAnnotation, addAnnotation, addDeveloperExtension, addDirectImageSimple, addDirectTemplateSimple, addFileAttachment, addFileAttachment, addJavaScript, addLocalDestinations, addSharedObjectsToBody, addSimple, addSimple, addSimpleExtGState, addSimplePattern, addSimplePatternColorspace, addSimpleProperty, addSimpleShading, addSimpleShadingPattern, addToBody, addToBody, addToBody, addToBody, addToBody, addToBody, addViewerPreference, createXmpMetadata, eliminateFontSubset, fillOCProperties, freeReader, getAcroForm, getColorspaceName, getCompressionLevel, getCurrentDocumentSize, getCurrentPage, getCurrentPageNumber, getDefaultColorspace, getDirectContent, getDirectContentUnder, getEncryption, getExtraCatalog, getGroup, getImageReference, getImportedPage, getIndirectReferenceNumber, getInfo, getInstance, getOCProperties, getPageEvent, getPageNumber, getPageSize, getPdfDocument, getPdfIndirectReference, getPdfVersion, getPDFXConformance, getReferenceJBIG2Globals, getRootOutline, getRunDirection, getSpaceCharRatio, getStructureTreeRoot, getTabs, getUserunit, isFullCompression, isPdfX, isRgbTransparencyBlending, isStrictImageSequence, isTagged, isUserProperties, open, propertyExists, registerLayer, releaseTemplate, resetContent, setAdditionalAction, setAtLeastPdfVersion, setCollection, setCompressionLevel, setCropBoxSize, setDuration, setEncryption, setEncryption, setFullCompression, setGroup, setInitialLeading, setOpenAction, setOpenAction, setOutlines, setOutputIntents, setPageAction, setPageEmpty, setPageEvent, setPageLabels, setPageXmpMetadata, setPdfVersion, setPdfVersion, setPDFXConformance, setRgbTransparencyBlending, setRunDirection, setSigFlags, setSpaceCharRatio, setStrictImageSequence, setTabs, setTagged, setThumbnail, setTransition, setUserProperties, setUserunit, setViewerPreferences, setXmpMetadata, writeOutlines

Methods inherited from class DocWriter

add, getISOBytes, isCloseStream, isPaused, newPage, resetFooter, resetHeader, resetPageCount, setCloseStream, setFooter, setHeader, setMarginMirroring, setMarginMirroringTopBottom, setMargins, setPageCount, setPageSize

Methods inherited from class Object

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

Field Details

iTextTag

private static final PdfName iTextTag

zero

private static final Integer zero

readers

private final ArrayList readers

readers2intrefs

HashMap readers2intrefs

pages2intrefs

private final HashMap pages2intrefs

visited

private final HashMap visited

fields

ArrayList fields

file

private RandomAccessFileOrArray file

fieldTree

private final HashMap fieldTree

pageRefs

private final ArrayList pageRefs

pageDics

private final ArrayList pageDics

resources

private final PdfDictionary resources

form

private PdfDictionary form

closing

private boolean closing

nd

private final Document nd

tabOrder

private HashMap tabOrder

calculationOrder

private final ArrayList calculationOrder

calculationOrderRefs

private ArrayList calculationOrderRefs

hasSignature

private boolean hasSignature

widgetKeys

private static final HashMap widgetKeys

fieldKeys

protected static final HashMap fieldKeys

Constructor Details

PdfCopyFieldsImp

PdfCopyFieldsImp(OutputStream os,
 Calendar globalDate)
          throws DocumentException

Throws:

DocumentException

PdfCopyFieldsImp

private PdfCopyFieldsImp(OutputStream os,
 char pdfVersion,
 Calendar globalDate)
                  throws DocumentException

Throws:

DocumentException

Method Details

addDocument

void addDocument(PdfReader reader,
 List pagesToKeep)
          throws DocumentException,
IOException

Throws:

DocumentException

IOException

addDocument

void addDocument(PdfReader reader)
          throws DocumentException,
IOException

Throws:

DocumentException

IOException

getCOName

private static String getCOName(PdfReader reader,
 PRIndirectReference ref)

updateCalculationOrder

protected void updateCalculationOrder(PdfReader reader)

Since:

2.1.5; before 2.1.5 the method was private

propagate

private void propagate(PdfObject obj,
 PdfIndirectReference refo,
 boolean restricted)
                throws IOException

Throws:

IOException

adjustTabOrder

private void adjustTabOrder(PdfArray annots,
 PdfIndirectReference ind,
 PdfNumber nn)

branchForm

private PdfArray branchForm(HashMap level,
 PdfIndirectReference parent,
 String fname)
                     throws IOException

Throws:

IOException

createAcroForms

private void createAcroForms()
                      throws IOException

Throws:

IOException

close

public void close()

Description copied from class: PdfWriter

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 PdfWriter

See Also:

• DocWriter.close()

closeIt

private void closeIt()
              throws IOException

Creates the new PDF by merging the fields and forms.

Throws:

IOException

addPageOffsetToField

private void addPageOffsetToField(HashMap fd,
 int pageOffset)

createWidgets

private void createWidgets(ArrayList list,
 AcroFields.Item item)

mergeField

private void mergeField(String name,
 AcroFields.Item item)

mergeWithMaster

void mergeWithMaster(HashMap fd)

mergeFields

void mergeFields()

getPageReference

public PdfIndirectReference getPageReference(int page)

Description copied from class: PdfWriter

Use this method to get a reference to a page existing or not. If the page does not exist yet the reference will be created in advance. If on closing the document, a page number greater than the total number of pages was requested, an exception is thrown.

Overrides:

getPageReference in class PdfWriter

Parameters:

page - the page number. The first page is 1

Returns:

the reference to the page

getCatalog

protected PdfDictionary getCatalog(PdfIndirectReference rootObj)

Overrides:

getCatalog in class PdfWriter

getNewReference

private PdfIndirectReference getNewReference(PRIndirectReference ref)

getNewObjectNumber

protected int getNewObjectNumber(PdfReader reader,
 int number,
 int generation)

Overrides:

getNewObjectNumber in class PdfWriter

setVisited

private boolean setVisited(PRIndirectReference ref)

Sets a reference to "visited" in the copy process.

Parameters:

ref - the reference that needs to be set to "visited"

Returns:

true if the reference was set to visited

isVisited

private boolean isVisited(PRIndirectReference ref)

Checks if a reference has already been "visited" in the copy process.

Parameters:

ref - the reference that needs to be checked

Returns:

true if the reference was already visited

isPage

private boolean isPage(PRIndirectReference ref)

Checks if a reference refers to a page object.

Parameters:

ref - the reference that needs to be checked

Returns:

true is the reference refers to a page object.

getReaderFile

RandomAccessFileOrArray getReaderFile(PdfReader reader)

Overrides:

getReaderFile in class PdfWriter

openDoc

public void openDoc()