Class Overlay

java.lang.Object
org.apache.pdfbox.util.Overlay

public class Overlay extends Object
Adds an overlay to an existing PDF document. Based on code contributed by Balazs Jerk.
  • Constructor Details

    • Overlay

      public Overlay()
  • Method Details

    • overlay

      public void overlay(Map<Integer,String> specificPageOverlayFile, boolean useNonSeqParser) throws IOException, COSVisitorException
      This will add overlays to a documents.
      Parameters:
      specificPageOverlayFile - map of overlay files for specific pages
      useNonSeqParser - indicates whether the non-sequential parser is used
      Throws:
      IOException - if something went wrong
      COSVisitorException - 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(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 String getInputFile()
      Returns the input file.
      Returns:
      the input file
    • setOutputFile

      public void setOutputFile(String outputFile)
      Sets the output file.
      Parameters:
      outputFile - the output file
    • getOutputFile

      public String getOutputFile()
      Returns the output file.
      Returns:
      the output file
    • setDefaultOverlayFile

      public void setDefaultOverlayFile(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 String getDefaultOverlayFile()
      Returns the default overlay file.
      Returns:
      the default overlay file
    • setFirstPageOverlayFile

      public void setFirstPageOverlayFile(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(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(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(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(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