Class PdfStamperImp

java.lang.Object

com.aowagie.text.DocWriter

com.aowagie.text.pdf.PdfWriter

com.aowagie.text.pdf.PdfStamperImp

All Implemented Interfaces:

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

public class PdfStamperImp
extends PdfWriter

Field Summary

Fields inherited from class PdfWriter

body, CenterWindow, compressionLevel, crypto, currentPdfReaderInstance, DirectionL2R, DirectionR2L, DisplayDocTitle, documentOCG, FitWindow, fullCompression, 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, VERSION_1_2, VERSION_1_3, VERSION_1_4, VERSION_1_5, VERSION_1_6, VERSION_1_7, xmpMetadata

Fields inherited from class DocWriter

open, os

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	addViewerPreference(PdfName key, PdfObject value)	Adds a viewer preference
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.
PdfObject	getFileID()
protected int	getNewObjectNumber(PdfReader reader, int number, int generation)
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 void	markUsed(PdfObject obj)
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	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	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.

Methods inherited from class PdfWriter

addDeveloperExtension, addFileAttachment, addSharedObjectsToBody, addToBody, addToBody, close, createXmpMetadata, fillOCProperties, freeReader, getAcroForm, getCatalog, getCompressionLevel, getCurrentDocumentSize, getCurrentPageNumber, getDefaultColorspace, getExtraCatalog, getGroup, getImportedPage, getInfo, getInstance, getOCProperties, getPageEvent, getPageNumber, getPageSize, getPdfIndirectReference, getPDFXConformance, getReferenceJBIG2Globals, getRootOutline, getRunDirection, getSpaceCharRatio, getStructureTreeRoot, getTabs, getUserunit, isFullCompression, isPdfX, isRgbTransparencyBlending, isStrictImageSequence, isTagged, isUserProperties, open, setAtLeastPdfVersion, setCollection, setCompressionLevel, setCropBoxSize, setEncryption, setEncryption, setGroup, setInitialLeading, setOutlines, setOutputIntents, setPageEmpty, setPageEvent, setPageLabels, setPageXmpMetadata, setPdfVersion, setPdfVersion, setPDFXConformance, setRgbTransparencyBlending, setRunDirection, setSpaceCharRatio, setStrictImageSequence, setTabs, setTagged, setUserProperties, setUserunit, 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

Method Details

getNewObjectNumber

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

Overrides:

getNewObjectNumber in class PdfWriter

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.aowagie.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(PdfName, 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 com.aowagie.text.pdf.PdfException

Always throws an UnsupportedOperationException.

Overrides:

setPageAction in class PdfWriter

Parameters:

actionType - ignore

action - ignore

Throws:

com.aowagie.text.pdf.PdfException - ignore

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.aowagie.text.pdf.PdfTransition)

markUsed

protected void markUsed(PdfObject obj)

setAdditionalAction

public void setAdditionalAction(PdfName actionType,
 PdfAction action)
                         throws com.aowagie.text.pdf.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.

Overrides:

setAdditionalAction in class PdfWriter

Parameters:

actionType - the action type

action - the action to execute in response to the trigger

Throws:

com.aowagie.text.pdf.PdfException - on invalid action type

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.aowagie.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.aowagie.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

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

getFileID

public PdfObject getFileID()