Package com.lowagie.text.pdf

Class PdfStamperImp

java.lang.Object

com.lowagie.text.DocWriter

com.lowagie.text.pdf.PdfWriter

com.lowagie.text.pdf.PdfStamperImp

All Implemented Interfaces:

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

public class PdfStamperImp
extends PdfWriter

Nested Class Summary

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

PdfWriter.PdfBody

Field Summary

Fields

Modifier and Type	Field	Description
protected AcroFields	acroFields
protected boolean	append
protected boolean	fieldsAdded
protected HashMap	fieldTemplates
protected boolean	flat
protected boolean	flatAnnotations
protected boolean	flatFreeText
protected int	initialXrefSize
protected IntHashtable	marked
protected int[]	namePtr
protected PdfAction	openAction
protected HashSet	partialFlattening
protected int	sigFlags
protected boolean	useVp
protected PdfViewerPreferencesImp	viewerPreferences

Fields inherited from class com.lowagie.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, 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, extraCatalog, FitWindow, fontNumber, formXObjects, formXObjectsCounter, fullCompression, GENERATION_MAX, group, HideMenubar, HideToolbar, HideWindowUI, imageDictionary, importedPages, JBIG2Globals, newBookmarks, NO_SPACE_CHAR_RATIO, NonFullScreenPageModeUseNone, NonFullScreenPageModeUseOC, NonFullScreenPageModeUseOutlines, NonFullScreenPageModeUseThumbs, OCGLocked, OCGRadioGroup, OCProperties, PAGE_CLOSE, PAGE_OPEN, 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, PDFA1A, PDFA1B, PDFX1A2001, PDFX32002, PDFXNONE, prevxref, PrintScalingNone, 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, userunit, 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 com.lowagie.text.DocWriter

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PdfStamperImp(PdfReader reader, OutputStream os, char pdfVersion, boolean append)	Creates new PdfStamperImp.

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(PdfAnnotation annot)	Use this methods to add a PdfAnnotation or a PdfFormField to the document.
void	addComments(FdfReader fdf)
void	addViewerPreference(PdfName key, PdfObject value)	Adds a viewer preference
protected void	close(HashMap moreInfo)
protected void	flatFreeTextFields()
protected void	flattenAnnotations()
protected AcroFields	getAcroFields()
PdfContentByte	getDirectContent()	Use this method to get the direct content for this document.
PdfContentByte	getDirectContentUnder()	Use this method to get the direct content under for this document.
Calendar	getModificationDate()
protected int	getNewObjectNumber(PdfReader reader, int number, int generation)
protected PdfContentByte	getOverContent(int pageNum)
PdfObject	getOverrideFileId()
PdfIndirectReference	getPageReference(int page)	Use this method to get a reference to a page existing or not.
Map	getPdfLayers()	Gets the PdfLayer objects in an existing document as a Map with the names/titles of the layers as keys.
protected PdfContentByte	getUnderContent(int pageNum)
boolean	isIncludeFileID()
protected void	markUsed(int num)
protected void	markUsed(PdfObject obj)
protected void	readOCProperties()	Reads the OCProperties dictionary from the catalog of the existing document and fills the documentOCG, documentOCGorder and OCGRadioGroup variables in PdfWriter.
void	registerReader(PdfReader reader, boolean openFile)
void	setAdditionalAction(PdfName actionType, PdfAction action)	Additional-actions defining the actions to be taken in response to various trigger events affecting the document as a whole.
void	setDuration(int seconds)	Always throws an UnsupportedOperationException.
void	setFlatAnnotations(boolean flatAnnotations)
protected void	setFormFlattening(boolean flat)
void	setIncludeFileID(boolean includeFileID)
void	setModificationDate(Calendar modificationDate)
void	setOpenAction(PdfAction action)	When the document opens this action will be invoked.
void	setOpenAction(String name)	When the document opens it will jump to the destination with this name.
void	setOverrideFileId(PdfObject overrideFileId)
void	setPageAction(PdfName actionType, PdfAction action)	Always throws an UnsupportedOperationException.
void	setSigFlags(int f)	Set the signature flags.
void	setThumbnail(Image image)	Use this method to set the thumbnail image for the current page.
void	setTransition(PdfTransition transition)	Always throws an UnsupportedOperationException.
void	setViewerPreferences(int preferences)	Sets the viewer preferences.
void	unRegisterReader(PdfReader reader)

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

add, addCalculationOrder, addDeveloperExtension, addDirectImageSimple, addDirectImageSimple, addFileAttachment, addFileAttachment, addFileAttachment, addJavaScript, addJavaScript, addJavaScript, addJavaScript, addJavaScript, addJavaScript, addOCGRadioGroup, addSharedObjectsToBody, addToBody, addToBody, addToBody, addToBody, addToBody, addToBody, clearTextWrap, close, createXmpMetadata, fillOCProperties, fitsPage, fitsPage, freeReader, getAcroForm, getBoxSize, getCatalog, getCompressionLevel, getCurrentDocumentSize, getCurrentPageNumber, getDefaultColorspace, getExtraCatalog, getGroup, getImportedPage, getInfo, getInstance, getInstance, getOCProperties, getPageEvent, getPageNumber, getPageSize, getPdfIndirectReference, getPDFXConformance, getReferenceJBIG2Globals, getRootOutline, getRunDirection, getSpaceCharRatio, getStructureTreeRoot, getTabs, getUserunit, getVerticalPosition, isFullCompression, isPageEmpty, isPdfX, isRgbTransparencyBlending, isStrictImageSequence, isTagged, isUserProperties, lockLayer, open, releaseTemplate, reorderPages, setAtLeastPdfVersion, setBoxSize, setCollection, setCompressionLevel, setCropBoxSize, setDefaultColorspace, setEncryption, setEncryption, setEncryption, setEncryption, setEncryption, setFullCompression, setGroup, setInitialLeading, setLinearPageMode, setOutlines, setOutputIntents, setOutputIntents, setOutputIntents, setPageEmpty, setPageEvent, setPageLabels, setPageXmpMetadata, setPdfVersion, setPdfVersion, setPDFXConformance, setRgbTransparencyBlending, setRunDirection, setSpaceCharRatio, setStrictImageSequence, setTabs, setTagged, setUserProperties, setUserunit, setXmpMetadata, writeOutlines

Methods inherited from class com.lowagie.text.DocWriter

add, addTabs, flush, getISOBytes, isCloseStream, isPaused, newPage, pause, resetFooter, resetHeader, resetPageCount, resume, setCloseStream, setFooter, setHeader, 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 Details

acroFields

protected AcroFields acroFields

flat

protected boolean flat

flatFreeText

protected boolean flatFreeText

flatAnnotations

protected boolean flatAnnotations

namePtr

protected int[] namePtr

partialFlattening

protected HashSet partialFlattening

useVp

protected boolean useVp

viewerPreferences

protected PdfViewerPreferencesImp viewerPreferences

fieldTemplates

protected HashMap fieldTemplates

fieldsAdded

protected boolean fieldsAdded

sigFlags

protected int sigFlags

append

protected boolean append

marked

protected IntHashtable marked

initialXrefSize

protected int initialXrefSize

openAction

protected PdfAction openAction

Constructor Details

PdfStamperImp

protected PdfStamperImp(PdfReader reader,
 OutputStream os,
 char pdfVersion,
 boolean append)
                 throws DocumentException,
IOException

Creates new PdfStamperImp.

Parameters:

reader - the read PDF

os - the output destination

pdfVersion - the new pdf version or '\0' to keep the same version as the original document

append -

Throws:

DocumentException - on error

IOException

Method Details

close

protected void close(HashMap moreInfo)
              throws IOException

Throws:

IOException

getNewObjectNumber

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

Overrides:

getNewObjectNumber in class PdfWriter

registerReader

public void registerReader(PdfReader reader,
 boolean openFile)
                    throws IOException

Parameters:

reader -

openFile -

Throws:

IOException

unRegisterReader

public void unRegisterReader(PdfReader reader)

Parameters:

reader -

addComments

public void addComments(FdfReader fdf)
                 throws IOException

Parameters:

fdf -

Throws:

IOException

getUnderContent

protected PdfContentByte getUnderContent(int pageNum)

getOverContent

protected PdfContentByte getOverContent(int pageNum)

getAcroFields

protected AcroFields getAcroFields()

setFormFlattening

protected void setFormFlattening(boolean flat)

setFlatAnnotations

public void setFlatAnnotations(boolean flatAnnotations)

flattenAnnotations

protected void flattenAnnotations()

flatFreeTextFields

protected void flatFreeTextFields()

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

See Also:

• PdfWriter.getPageReference(int)

addAnnotation

public void addAnnotation(PdfAnnotation annot)

Description copied from interface: PdfAnnotations

Use this methods to add a PdfAnnotation or a PdfFormField to the document. Only the top parent of a PdfFormField needs to be added.

Specified by:

addAnnotation in interface PdfAnnotations

Overrides:

addAnnotation in class PdfWriter

Parameters:

annot - the PdfAnnotation or the PdfFormField to add

See Also:

• PdfWriter.addAnnotation(com.lowagie.text.pdf.PdfAnnotation)

setViewerPreferences

public void setViewerPreferences(int preferences)

Sets the viewer preferences.

Specified by:

setViewerPreferences in interface PdfViewerPreferences

Overrides:

setViewerPreferences in class PdfWriter

Parameters:

preferences - the viewer preferences

See Also:

• PdfWriter.setViewerPreferences(int)

addViewerPreference

public void addViewerPreference(PdfName key,
 PdfObject value)

Adds a viewer preference

Specified by:

addViewerPreference in interface PdfViewerPreferences

Overrides:

addViewerPreference in class PdfWriter

Parameters:

key - a key for a viewer preference

value - the value for the viewer preference

See Also:

• PdfViewerPreferences.addViewerPreference(com.lowagie.text.pdf.PdfName, com.lowagie.text.pdf.PdfObject)

setSigFlags

public void setSigFlags(int f)

Set the signature flags.

Specified by:

setSigFlags in interface PdfAnnotations

Overrides:

setSigFlags in class PdfWriter

Parameters:

f - the flags. This flags are ORed with current ones

See Also:

• PdfAnnotations.setSigFlags(int)

setPageAction

public void setPageAction(PdfName actionType,
 PdfAction action)
                   throws PdfException

Always throws an UnsupportedOperationException.

Specified by:

setPageAction in interface PdfPageActions

Overrides:

setPageAction in class PdfWriter

Parameters:

actionType - ignore

action - ignore

Throws:

PdfException - ignore

See Also:

• PdfStamper.setPageAction(PdfName, PdfAction, int)

setDuration

public void setDuration(int seconds)

Always throws an UnsupportedOperationException.

Specified by:

setDuration in interface PdfPageActions

Overrides:

setDuration in class PdfWriter

Parameters:

seconds - ignore

See Also:

• PdfPageActions.setDuration(int)

setTransition

public void setTransition(PdfTransition transition)

Always throws an UnsupportedOperationException.

Specified by:

setTransition in interface PdfPageActions

Overrides:

setTransition in class PdfWriter

Parameters:

transition - ignore

See Also:

• PdfPageActions.setTransition(com.lowagie.text.pdf.PdfTransition)

markUsed

protected void markUsed(PdfObject obj)

markUsed

protected void markUsed(int num)

setAdditionalAction

public void setAdditionalAction(PdfName actionType,
 PdfAction action)
                         throws PdfException

Additional-actions defining the actions to be taken in response to various trigger events affecting the document as a whole. The actions types allowed are: DOCUMENT_CLOSE, WILL_SAVE, DID_SAVE, WILL_PRINT and DID_PRINT.

Specified by:

setAdditionalAction in interface PdfDocumentActions

Overrides:

setAdditionalAction in class PdfWriter

Parameters:

actionType - the action type

action - the action to execute in response to the trigger

Throws:

PdfException - on invalid action type

See Also:

• PdfDocumentActions.setAdditionalAction(com.lowagie.text.pdf.PdfName, com.lowagie.text.pdf.PdfAction)

setOpenAction

public void setOpenAction(PdfAction action)

Description copied from interface: PdfDocumentActions

When the document opens this action will be invoked.

Specified by:

setOpenAction in interface PdfDocumentActions

Overrides:

setOpenAction in class PdfWriter

Parameters:

action - the action to be invoked

See Also:

• PdfWriter.setOpenAction(com.lowagie.text.pdf.PdfAction)

setOpenAction

public void setOpenAction(String name)

Description copied from interface: PdfDocumentActions

When the document opens it will jump to the destination with this name.

Specified by:

setOpenAction in interface PdfDocumentActions

Overrides:

setOpenAction in class PdfWriter

Parameters:

name - the name of the destination to jump to

See Also:

• PdfWriter.setOpenAction(java.lang.String)

setThumbnail

public void setThumbnail(Image image)

Description copied from class: PdfWriter

Use this method to set the thumbnail image for the current page.

Overrides:

setThumbnail in class PdfWriter

Parameters:

image - the image

See Also:

• PdfWriter.setThumbnail(com.lowagie.text.Image)

getDirectContentUnder

public PdfContentByte getDirectContentUnder()

Description copied from class: PdfWriter

Use this method to get the direct content under for this document. There is only one direct content, multiple calls to this method will always retrieve the same object.

Overrides:

getDirectContentUnder in class PdfWriter

Returns:

the direct content

getDirectContent

public PdfContentByte getDirectContent()

Description copied from class: PdfWriter

Use this method to get the direct content for this document. There is only one direct content, multiple calls to this method will allways retrieve the same object.

Overrides:

getDirectContent in class PdfWriter

Returns:

the direct content

readOCProperties

protected void readOCProperties()

Reads the OCProperties dictionary from the catalog of the existing document and fills the documentOCG, documentOCGorder and OCGRadioGroup variables in PdfWriter. Note that the original OCProperties of the existing document can contain more information.

Since:

2.1.2

getPdfLayers

public Map getPdfLayers()

Gets the PdfLayer objects in an existing document as a Map with the names/titles of the layers as keys.

Returns:

a Map with all the PdfLayers in the document (and the name/title of the layer as key)

Since:

2.1.2

isIncludeFileID

public boolean isIncludeFileID()

setIncludeFileID

public void setIncludeFileID(boolean includeFileID)

getOverrideFileId

public PdfObject getOverrideFileId()

setOverrideFileId

public void setOverrideFileId(PdfObject overrideFileId)

getModificationDate

public Calendar getModificationDate()

setModificationDate

public void setModificationDate(Calendar modificationDate)