Class Overlay


  • public class Overlay
    extends java.lang.Object
    Overlay on document with another one.
    e.g. Overlay an invoice with your company layout

    How it (should) work:
    If the document has 10 pages, and the layout 2 the following is the result:
     Document: 1234567890
     Layout  : 1212121212
     

    Version:
    $Revision: 1.7 $
    Author:
    Mario Ivankovits (mario@ops.co.at), Ben Litchfield
    • Constructor Detail

      • Overlay

        public Overlay()
    • Method Detail

      • main

        public static void main​(java.lang.String[] args)
                         throws java.io.IOException,
                                COSVisitorException
        This will overlay a document and write out the results.

        usage: java org.apache.pdfbox.Overlay <overlay.pdf> <document.pdf> <result.pdf>
        Parameters:
        args - The command line arguments.
        Throws:
        java.io.IOException - If there is an error reading/writing the document.
        COSVisitorException - If there is an error writing the document.
      • overlay

        public PDDocument overlay​(PDDocument overlay,
                                  PDDocument destination)
                           throws java.io.IOException
        This will overlay two documents onto each other. The overlay document is repeatedly overlayed onto the destination document for every page in the destination.
        Parameters:
        overlay - The document to copy onto the destination
        destination - The file that the overlay should be placed on.
        Returns:
        The destination pdf, same as argument passed in.
        Throws:
        java.io.IOException - If there is an error accessing data.