Package org.apache.pdfbox.util
Class Overlay
- java.lang.Object
-
- org.apache.pdfbox.util.Overlay
-
public class Overlay extends java.lang.Object
Adds an overlay to an existing PDF document. Based on code contributed by Balazs Jerk.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Overlay.Position
Possible location of the overlayed pages: foreground or background.
-
Constructor Summary
Constructors Constructor Description Overlay()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDefaultOverlayFile()
Returns the default overlay file.java.lang.String
getInputFile()
Returns the input file.java.lang.String
getOutputFile()
Returns the output file.void
overlay(java.util.Map<java.lang.Integer,java.lang.String> specificPageOverlayFile, boolean useNonSeqParser)
This will add overlays to a documents.void
setAllPagesOverlayFile(java.lang.String allPagesOverlayFile)
Sets the all pages overlay file.void
setAllPagesOverlayPDF(PDDocument allPagesOverlayPDF)
Sets the all pages overlay PDF.void
setDefaultOverlayFile(java.lang.String defaultOverlayFile)
Sets the default overlay file.void
setDefaultOverlayPDF(PDDocument defaultOverlayPDF)
Sets the default overlay PDF.void
setEvenPageOverlayFile(java.lang.String evenPageOverlayFile)
Sets the even page overlay file.void
setEvenPageOverlayPDF(PDDocument evenPageOverlayPDF)
Sets the even page overlay PDF.void
setFirstPageOverlayFile(java.lang.String firstPageOverlayFile)
Sets the first page overlay file.void
setFirstPageOverlayPDF(PDDocument firstPageOverlayPDF)
Sets the first page overlay PDF.void
setInputFile(java.lang.String inputFile)
Sets the file to be overlayed.void
setInputPDF(PDDocument inputPDF)
Sets the PDF to be overlayed.void
setLastPageOverlayFile(java.lang.String lastPageOverlayFile)
Sets the last page overlay file.void
setLastPageOverlayPDF(PDDocument lastPageOverlayPDF)
Sets the last page overlay PDF.void
setOddPageOverlayFile(java.lang.String oddPageOverlayFile)
Sets the odd page overlay file.void
setOddPageOverlayPDF(PDDocument oddPageOverlayPDF)
Sets the odd page overlay PDF.void
setOutputFile(java.lang.String outputFile)
Sets the output file.void
setOverlayPosition(Overlay.Position overlayPosition)
Sets the overlay position.
-
-
-
Method Detail
-
overlay
public void overlay(java.util.Map<java.lang.Integer,java.lang.String> specificPageOverlayFile, boolean useNonSeqParser) throws java.io.IOException, COSVisitorException
This will add overlays to a documents.- Parameters:
specificPageOverlayFile
- map of overlay files for specific pagesuseNonSeqParser
- indicates whether the non-sequential parser is used- Throws:
java.io.IOException
- if something went wrongCOSVisitorException
- if something went wrong when savin the pdf
-
setOverlayPosition
public void setOverlayPosition(Overlay.Position overlayPosition)
Sets the overlay position.- Parameters:
overlayPosition
- the overlay position
-
setInputFile
public void setInputFile(java.lang.String inputFile)
Sets the file to be overlayed.- Parameters:
inputFile
- the file to be overlayed
-
setInputPDF
public void setInputPDF(PDDocument inputPDF)
Sets the PDF to be overlayed.- Parameters:
inputPDF
- the PDF to be overlayed
-
getInputFile
public java.lang.String getInputFile()
Returns the input file.- Returns:
- the input file
-
setOutputFile
public void setOutputFile(java.lang.String outputFile)
Sets the output file.- Parameters:
outputFile
- the output file
-
getOutputFile
public java.lang.String getOutputFile()
Returns the output file.- Returns:
- the output file
-
setDefaultOverlayFile
public void setDefaultOverlayFile(java.lang.String defaultOverlayFile)
Sets the default overlay file.- Parameters:
defaultOverlayFile
- the default overlay file
-
setDefaultOverlayPDF
public void setDefaultOverlayPDF(PDDocument defaultOverlayPDF)
Sets the default overlay PDF.- Parameters:
defaultOverlayPDF
- the default overlay PDF
-
getDefaultOverlayFile
public java.lang.String getDefaultOverlayFile()
Returns the default overlay file.- Returns:
- the default overlay file
-
setFirstPageOverlayFile
public void setFirstPageOverlayFile(java.lang.String firstPageOverlayFile)
Sets the first page overlay file.- Parameters:
firstPageOverlayFile
- the first page overlay file
-
setFirstPageOverlayPDF
public void setFirstPageOverlayPDF(PDDocument firstPageOverlayPDF)
Sets the first page overlay PDF.- Parameters:
firstPageOverlayPDF
- the first page overlay PDF
-
setLastPageOverlayFile
public void setLastPageOverlayFile(java.lang.String lastPageOverlayFile)
Sets the last page overlay file.- Parameters:
lastPageOverlayFile
- the last page overlay file
-
setLastPageOverlayPDF
public void setLastPageOverlayPDF(PDDocument lastPageOverlayPDF)
Sets the last page overlay PDF.- Parameters:
lastPageOverlayPDF
- the last page overlay PDF
-
setAllPagesOverlayFile
public void setAllPagesOverlayFile(java.lang.String allPagesOverlayFile)
Sets the all pages overlay file.- Parameters:
allPagesOverlayFile
- the all pages overlay file
-
setAllPagesOverlayPDF
public void setAllPagesOverlayPDF(PDDocument allPagesOverlayPDF)
Sets the all pages overlay PDF.- Parameters:
allPagesOverlayPDF
- the all pages overlay PDF
-
setOddPageOverlayFile
public void setOddPageOverlayFile(java.lang.String oddPageOverlayFile)
Sets the odd page overlay file.- Parameters:
oddPageOverlayFile
- the odd page overlay file
-
setOddPageOverlayPDF
public void setOddPageOverlayPDF(PDDocument oddPageOverlayPDF)
Sets the odd page overlay PDF.- Parameters:
oddPageOverlayPDF
- the odd page overlay PDF
-
setEvenPageOverlayFile
public void setEvenPageOverlayFile(java.lang.String evenPageOverlayFile)
Sets the even page overlay file.- Parameters:
evenPageOverlayFile
- the even page overlay file
-
setEvenPageOverlayPDF
public void setEvenPageOverlayPDF(PDDocument evenPageOverlayPDF)
Sets the even page overlay PDF.- Parameters:
evenPageOverlayPDF
- the even page overlay PDF
-
-