Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Overlay.LayoutPage Stores the overlay page information.
public static enum	Overlay.Position Possible location of the overlaid pages: foreground or background.

Modifier and Type	Field and Description
private PDDocument	allPagesOverlay
private String	allPagesOverlayFilename
private PDDocument	defaultOverlay
private String	defaultOverlayFilename
private Overlay.LayoutPage	defaultOverlayPage
private PDDocument	evenPageOverlay
private String	evenPageOverlayFilename
private Overlay.LayoutPage	evenPageOverlayPage
private PDDocument	firstPageOverlay
private String	firstPageOverlayFilename
private Overlay.LayoutPage	firstPageOverlayPage
private String	inputFileName
private PDDocument	inputPDFDocument
private PDDocument	lastPageOverlay
private String	lastPageOverlayFilename
private Overlay.LayoutPage	lastPageOverlayPage
private int	numberOfOverlayPages
private PDDocument	oddPageOverlay
private String	oddPageOverlayFilename
private Overlay.LayoutPage	oddPageOverlayPage
private final Set<PDDocument>	openDocumentsSet
private Overlay.Position	position
private Map<Integer, Overlay.LayoutPage>	specificPageOverlayLayoutPageMap
private boolean	useAllOverlayPages

Constructor Summary

Access	Constructor and Description
public	Overlay()

Method Summary

Modifier and Type	Method and Description
private void	addOriginalContent(COSBase contents, COSArray contentArray)
protected AffineTransform	Returns: The affine transform to be used. calculateAffineTransform(PDPage The page that will get the overlay. page, PDRectangle The overlay media box. overlayMediaBox) Calculate the transform to be used when positioning the overlay.
public void	close() Implements java.io.Closeable.close. Close all input documents which were used for the overlay and opened by this class.
private COSStream	createCombinedContentStream(COSBase contents)
private List<COSStream>	createContentStreamList(COSBase contents)
private Overlay.LayoutPage	createLayoutPage(PDPage page) Create a LayoutPage object from given PDPage object.
private COSStream	createOverlayStream(PDPage page, Overlay.LayoutPage layoutPage, COSName xObjectId)
private COSName	createOverlayXObject(PDPage page, Overlay.LayoutPage layoutPage, PDFCloneUtility cloner)
private COSStream	createStream(String content)
private String	float2String(float floatValue)
public String	Returns: the default overlay file getDefaultOverlayFile() Returns the default overlay file.
public String	Returns: the input file getInputFile() Returns the input file.
private Overlay.LayoutPage	getLayoutPage(PDDocument doc) Create a LayoutPage object from the first page of the given document.
private Overlay.LayoutPage	getLayoutPage(int pageNumber, int numberOfPages)
private Map<Integer, Overlay.LayoutPage>	getLayoutPages(PDDocument doc)
private PDDocument	loadPDF(String pdfName)
private void	loadPDFs()
public PDDocument	Returns: The modified input PDF document, which has to be saved and closed by the caller. If the input document was passed by `setInputPDF(PDDocument)` then it is that object that is returned. overlay(Map<Integer, String> Optional map of overlay files of which the first page will be used for specific pages of the input document. The page numbers are 1-based. The map must be empty (but not null) if no specific mappings are used. specificPageOverlayMap) This will add overlays to a document.
public PDDocument	Returns: The modified input PDF document, which has to be saved and closed by the caller. If the input document was passed by `setInputPDF(PDDocument)` then it is that object that is returned. overlayDocuments(Map<Integer, PDDocument> Optional map of overlay documents for specific pages. The page numbers are 1-based. The map must be empty (but not null) if no specific mappings are used. specificPageOverlayDocumentMap) This will add overlays documents to a document.
private void	overlayPage(PDPage page, Overlay.LayoutPage layoutPage, COSArray array, PDFCloneUtility cloner)
private void	processPages(PDDocument document)
public void	setAllPagesOverlayFile(String the all pages overlay file allPagesOverlayFile) Sets the all pages overlay file.
public void	setAllPagesOverlayPDF(PDDocument the all pages overlay PDF. This should not be a PDDocument that you created on the fly, it should be saved first, if it contains any fonts that are subset. allPagesOverlayPDF) Sets the all pages overlay PDF.
public void	setDefaultOverlayFile(String the default overlay file defaultOverlayFile) Sets the default overlay file.
public void	setDefaultOverlayPDF(PDDocument the default overlay PDF defaultOverlayPDF) Sets the default overlay PDF.
public void	setEvenPageOverlayFile(String the even page overlay file evenPageOverlayFile) Sets the even page overlay file.
public void	setEvenPageOverlayPDF(PDDocument the even page overlay PDF evenPageOverlayPDF) Sets the even page overlay PDF.
public void	setFirstPageOverlayFile(String the first page overlay file firstPageOverlayFile) Sets the first page overlay file.
public void	setFirstPageOverlayPDF(PDDocument the first page overlay PDF firstPageOverlayPDF) Sets the first page overlay PDF.
public void	setInputFile(String the file to be overlaid. The `PDDocument` object gathered from opening this file will be returned by `overlay(Map<Integer, String>)`. inputFile) Sets the file to be overlaid.
public void	setInputPDF(PDDocument the PDF to be overlaid. This will be the object that is returned by `overlay(Map<Integer, String>)`. inputPDF) Sets the PDF to be overlaid.
public void	setLastPageOverlayFile(String the last page overlay file lastPageOverlayFile) Sets the last page overlay file.
public void	setLastPageOverlayPDF(PDDocument the last page overlay PDF lastPageOverlayPDF) Sets the last page overlay PDF.
public void	setOddPageOverlayFile(String the odd page overlay file oddPageOverlayFile) Sets the odd page overlay file.
public void	setOddPageOverlayPDF(PDDocument the odd page overlay PDF oddPageOverlayPDF) Sets the odd page overlay PDF.
public void	setOverlayPosition(Overlay.Position the overlay position overlayPosition) Sets the overlay position.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allPagesOverlay	back to summary
private PDDocument allPagesOverlay

allPagesOverlayFilename	back to summary
private String allPagesOverlayFilename

defaultOverlay	back to summary
private PDDocument defaultOverlay

defaultOverlayFilename	back to summary
private String defaultOverlayFilename

defaultOverlayPage	back to summary
private Overlay.LayoutPage defaultOverlayPage

evenPageOverlay	back to summary
private PDDocument evenPageOverlay

evenPageOverlayFilename	back to summary
private String evenPageOverlayFilename

evenPageOverlayPage	back to summary
private Overlay.LayoutPage evenPageOverlayPage

firstPageOverlay	back to summary
private PDDocument firstPageOverlay

firstPageOverlayFilename	back to summary
private String firstPageOverlayFilename

firstPageOverlayPage	back to summary
private Overlay.LayoutPage firstPageOverlayPage

inputFileName	back to summary
private String inputFileName

inputPDFDocument	back to summary
private PDDocument inputPDFDocument

lastPageOverlay	back to summary
private PDDocument lastPageOverlay

lastPageOverlayFilename	back to summary
private String lastPageOverlayFilename

lastPageOverlayPage	back to summary
private Overlay.LayoutPage lastPageOverlayPage

numberOfOverlayPages	back to summary
private int numberOfOverlayPages

oddPageOverlay	back to summary
private PDDocument oddPageOverlay

oddPageOverlayFilename	back to summary
private String oddPageOverlayFilename

oddPageOverlayPage	back to summary
private Overlay.LayoutPage oddPageOverlayPage

openDocumentsSet	back to summary
private final Set<PDDocument> openDocumentsSet

position	back to summary
private Overlay.Position position

specificPageOverlayLayoutPageMap	back to summary
private Map<Integer, Overlay.LayoutPage> specificPageOverlayLayoutPageMap

useAllOverlayPages	back to summary
private boolean useAllOverlayPages

Constructor Detail

Overlay	back to summary
public Overlay()

Method Detail

addOriginalContent	back to summary
private void addOriginalContent(COSBase contents, COSArray contentArray) throws IOException

calculateAffineTransform	back to summary
protected AffineTransform calculateAffineTransform(PDPage page, PDRectangle overlayMediaBox) Calculate the transform to be used when positioning the overlay. The default implementation centers on the destination. Override this method to do your own, e.g. move to a corner, or rotate. Parameters page:PDPage The page that will get the overlay. overlayMediaBox:PDRectangle The overlay media box. Returns:AffineTransform The affine transform to be used.

calculateAffineTransform

back to summary

protected AffineTransform calculateAffineTransform(PDPage page, PDRectangle overlayMediaBox)

Calculate the transform to be used when positioning the overlay. The default implementation centers on the destination. Override this method to do your own, e.g. move to a corner, or rotate.

Parameters

page:PDPage: The page that will get the overlay.
overlayMediaBox:PDRectangle: The overlay media box.

Returns:AffineTransform

The affine transform to be used.

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Close all input documents which were used for the overlay and opened by this class. Annotations @Override Exceptions IOException: if something went wrong

back to summary

public void close() throws IOException

Implements java.io.Closeable.close.

Close all input documents which were used for the overlay and opened by this class.

Annotations

@Override

Exceptions

IOException:: if something went wrong

createCombinedContentStream	back to summary
private COSStream createCombinedContentStream(COSBase contents) throws IOException

createContentStreamList	back to summary
private List<COSStream> createContentStreamList(COSBase contents) throws IOException

createLayoutPage	back to summary
private Overlay.LayoutPage createLayoutPage(PDPage page) throws IOException Create a LayoutPage object from given PDPage object.

createOverlayStream	back to summary
private COSStream createOverlayStream(PDPage page, Overlay.LayoutPage layoutPage, COSName xObjectId) throws IOException

createOverlayXObject	back to summary
private COSName createOverlayXObject(PDPage page, Overlay.LayoutPage layoutPage, PDFCloneUtility cloner) throws IOException

createStream	back to summary
private COSStream createStream(String content) throws IOException

float2String	back to summary
private String float2String(float floatValue)

getDefaultOverlayFile	back to summary
public String getDefaultOverlayFile() Returns the default overlay file. Returns:String the default overlay file

getDefaultOverlayFile

back to summary

public String getDefaultOverlayFile()

Returns the default overlay file.

Returns:String: the default overlay file

getInputFile	back to summary
public String getInputFile() Returns the input file. Returns:String the input file

getInputFile

back to summary

public String getInputFile()

Returns the input file.

Returns:String: the input file

getLayoutPage	back to summary
private Overlay.LayoutPage getLayoutPage(PDDocument doc) throws IOException Create a LayoutPage object from the first page of the given document.

getLayoutPage	back to summary
private Overlay.LayoutPage getLayoutPage(int pageNumber, int numberOfPages)

getLayoutPages	back to summary
private Map<Integer, Overlay.LayoutPage> getLayoutPages(PDDocument doc) throws IOException

loadPDF	back to summary
private PDDocument loadPDF(String pdfName) throws IOException

loadPDFs	back to summary
private void loadPDFs() throws IOException

overlay back to summary

overlay	back to summary
public PDDocument overlay(Map<Integer, String> specificPageOverlayMap) throws IOException This will add overlays to a document. Parameters specificPageOverlayMap:Map<Integer, String> Optional map of overlay files of which the first page will be used for specific pages of the input document. The page numbers are 1-based. The map must be empty (but not null) if no specific mappings are used. Returns:PDDocument The modified input PDF document, which has to be saved and closed by the caller. If the input document was passed by `setInputPDF(PDDocument)` then it is that object that is returned. Exceptions IOException: if something went wrong. IllegalArgumentException: if the input document is missing.

public PDDocument overlay(Map<Integer, String> specificPageOverlayMap) throws IOException

This will add overlays to a document.

Parameters

specificPageOverlayMap:Map<Integer, String>: Optional map of overlay files of which the first page will be used for specific pages of the input document. The page numbers are 1-based. The map must be empty (but not null) if no specific mappings are used.

Returns:PDDocument

The modified input PDF document, which has to be saved and closed by the caller. If the input document was passed by setInputPDF(PDDocument) then it is that object that is returned.

Exceptions

IOException:: if something went wrong.
IllegalArgumentException:: if the input document is missing.

overlayDocuments back to summary

overlayDocuments	back to summary
public PDDocument overlayDocuments(Map<Integer, PDDocument> specificPageOverlayDocumentMap) throws IOException This will add overlays documents to a document. If you created the overlay documents with subsetted fonts, you need to save them first so that the subsetting gets done. Parameters specificPageOverlayDocumentMap:Map<Integer, PDDocument> Optional map of overlay documents for specific pages. The page numbers are 1-based. The map must be empty (but not null) if no specific mappings are used. Returns:PDDocument The modified input PDF document, which has to be saved and closed by the caller. If the input document was passed by `setInputPDF(PDDocument)` then it is that object that is returned. Exceptions IOException: if something went wrong

public PDDocument overlayDocuments(Map<Integer, PDDocument> specificPageOverlayDocumentMap) throws IOException

This will add overlays documents to a document. If you created the overlay documents with subsetted fonts, you need to save them first so that the subsetting gets done.

Parameters

specificPageOverlayDocumentMap:Map<Integer, PDDocument>: Optional map of overlay documents for specific pages. The page numbers are 1-based. The map must be empty (but not null) if no specific mappings are used.

Returns:PDDocument

The modified input PDF document, which has to be saved and closed by the caller. If the input document was passed by setInputPDF(PDDocument) then it is that object that is returned.

Exceptions

IOException:: if something went wrong

overlayPage	back to summary
private void overlayPage(PDPage page, Overlay.LayoutPage layoutPage, COSArray array, PDFCloneUtility cloner) throws IOException

processPages	back to summary
private void processPages(PDDocument document) throws IOException

setAllPagesOverlayFile

back to summary

public void setAllPagesOverlayFile(String allPagesOverlayFile)

Sets the all pages overlay file.

Parameters

allPagesOverlayFile:String: the all pages overlay file

setAllPagesOverlayPDF

back to summary

public void setAllPagesOverlayPDF(PDDocument allPagesOverlayPDF)

Sets the all pages overlay PDF. If you created the overlay document with subsetted fonts, you need to save it first so that the subsetting gets done.

Parameters

allPagesOverlayPDF:PDDocument: the all pages overlay PDF. This should not be a PDDocument that you created on the fly, it should be saved first, if it contains any fonts that are subset.

setDefaultOverlayFile

back to summary

public void setDefaultOverlayFile(String defaultOverlayFile)

Sets the default overlay file.

Parameters

defaultOverlayFile:String: the default overlay file

setDefaultOverlayPDF

back to summary

public void setDefaultOverlayPDF(PDDocument defaultOverlayPDF)

Sets the default overlay PDF. If you created the overlay document with subsetted fonts, you need to save it first so that the subsetting gets done.

Parameters

defaultOverlayPDF:PDDocument: the default overlay PDF

setEvenPageOverlayFile

back to summary

public void setEvenPageOverlayFile(String evenPageOverlayFile)

Sets the even page overlay file.

Parameters

evenPageOverlayFile:String: the even page overlay file

setEvenPageOverlayPDF

back to summary

public void setEvenPageOverlayPDF(PDDocument evenPageOverlayPDF)

Sets the even page overlay PDF. If you created the overlay document with subsetted fonts, you need to save it first so that the subsetting gets done.

Parameters

evenPageOverlayPDF:PDDocument: the even page overlay PDF

setFirstPageOverlayFile

back to summary

public void setFirstPageOverlayFile(String firstPageOverlayFile)

Sets the first page overlay file.

Parameters

firstPageOverlayFile:String: the first page overlay file

setFirstPageOverlayPDF

back to summary

public void setFirstPageOverlayPDF(PDDocument firstPageOverlayPDF)

Sets the first page overlay PDF. If you created the overlay document with subsetted fonts, you need to save it first so that the subsetting gets done.

Parameters

firstPageOverlayPDF:PDDocument: the first page overlay PDF

setInputFile back to summary

public void setInputFile(String inputFile)

Sets the file to be overlaid.

Parameters

inputFile:String: the file to be overlaid. The PDDocument object gathered from opening this file will be returned by overlay(Map<Integer, String>).

setInputPDF back to summary

public void setInputPDF(PDDocument inputPDF)

Sets the PDF to be overlaid.

Parameters

inputPDF:PDDocument: the PDF to be overlaid. This will be the object that is returned by overlay(Map<Integer, String>).

setLastPageOverlayFile

back to summary

public void setLastPageOverlayFile(String lastPageOverlayFile)

Sets the last page overlay file.

Parameters

lastPageOverlayFile:String: the last page overlay file

setLastPageOverlayPDF

back to summary

public void setLastPageOverlayPDF(PDDocument lastPageOverlayPDF)

Sets the last page overlay PDF. If you created the overlay document with subsetted fonts, you need to save it first so that the subsetting gets done.

Parameters

lastPageOverlayPDF:PDDocument: the last page overlay PDF

setOddPageOverlayFile

back to summary

public void setOddPageOverlayFile(String oddPageOverlayFile)

Sets the odd page overlay file.

Parameters

oddPageOverlayFile:String: the odd page overlay file

setOddPageOverlayPDF

back to summary

public void setOddPageOverlayPDF(PDDocument oddPageOverlayPDF)

Sets the odd page overlay PDF. If you created the overlay document with subsetted fonts, you need to save it first so that the subsetting gets done.

Parameters

oddPageOverlayPDF:PDDocument: the odd page overlay PDF

setOverlayPosition

back to summary

public void setOverlayPosition(Overlay.Position overlayPosition)

Sets the overlay position.

Parameters

overlayPosition:Overlay.Position: the overlay position

org.apache.pdfbox.multipdf back to summary

private final Class Overlay.LayoutPage

Class Inheritance

extends Object

java.lang.Object
org.apache.pdfbox.multipdf.Overlay.LayoutPage

Stores the overlay page information.

Field Summary

Modifier and Type	Field and Description
private final COSStream	overlayContentStream
private final PDRectangle	overlayMediaBox
private final COSDictionary	overlayResources
private final short	overlayRotation

Constructor Summary

Access	Constructor and Description
private	LayoutPage(PDRectangle mediaBox, COSStream contentStream, COSDictionary resources, short rotation)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

overlayContentStream	back to summary
private final COSStream overlayContentStream

overlayMediaBox	back to summary
private final PDRectangle overlayMediaBox

overlayResources	back to summary
private final COSDictionary overlayResources

overlayRotation	back to summary
private final short overlayRotation

Constructor Detail

LayoutPage	back to summary
private LayoutPage(PDRectangle mediaBox, COSStream contentStream, COSDictionary resources, short rotation)

org.apache.pdfbox.multipdf back to summary

public final Enum Overlay.Position

Class Inheritance

extends Enum<Overlay.Position>

java.lang.Object
java.lang.Enum
org.apache.pdfbox.multipdf.Overlay.Position

Possible location of the overlaid pages: foreground or background.

Field Summary

Modifier and Type	Field and Description
public static final Overlay.Position	BACKGROUND
public static final Overlay.Position	FOREGROUND

Constructor Summary

Access	Constructor and Description
private	Position()

Method Summary

Modifier and Type	Method and Description
public static Overlay.Position	valueOf(String name)
public static Overlay.Position[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BACKGROUND	back to summary
public static final Overlay.Position BACKGROUND

FOREGROUND	back to summary
public static final Overlay.Position FOREGROUND

Constructor Detail

Position	back to summary
private Position()

Method Detail

valueOf	back to summary
public static Overlay.Position valueOf(String name)

values	back to summary
public static Overlay.Position[] values()

public Class Overlay

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class Overlay.LayoutPage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public final Enum Overlay.Position

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail