Overlay (Apache PDFBox 2.0.0 API)

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

```
public class Overlay
extends 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 and Description

static class Overlay.Position
Possible location of the overlayed pages: foreground or background.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Overlay.Position` Possible location of the overlayed pages: foreground or background.

Constructor Summary

Constructors
Constructor and Description

Overlay()

Constructors
Constructor and Description
`Overlay()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Close all input pdfs which were used for the overlay.
`String`	`getDefaultOverlayFile()` Returns the default overlay file.
`String`	`getInputFile()` Returns the input file.
`PDDocument`	`overlay(Map<Integer,String> specificPageOverlayFile)` This will add overlays to a documents.
`void`	`setAllPagesOverlayFile(String allPagesOverlayFile)` Sets the all pages overlay file.
`void`	`setAllPagesOverlayPDF(PDDocument allPagesOverlayPDF)` Sets the all pages overlay PDF.
`void`	`setDefaultOverlayFile(String defaultOverlayFile)` Sets the default overlay file.
`void`	`setDefaultOverlayPDF(PDDocument defaultOverlayPDF)` Sets the default overlay PDF.
`void`	`setEvenPageOverlayFile(String evenPageOverlayFile)` Sets the even page overlay file.
`void`	`setEvenPageOverlayPDF(PDDocument evenPageOverlayPDF)` Sets the even page overlay PDF.
`void`	`setFirstPageOverlayFile(String firstPageOverlayFile)` Sets the first page overlay file.
`void`	`setFirstPageOverlayPDF(PDDocument firstPageOverlayPDF)` Sets the first page overlay PDF.
`void`	`setInputFile(String inputFile)` Sets the file to be overlayed.
`void`	`setInputPDF(PDDocument inputPDF)` Sets the PDF to be overlayed.
`void`	`setLastPageOverlayFile(String lastPageOverlayFile)` Sets the last page overlay file.
`void`	`setLastPageOverlayPDF(PDDocument lastPageOverlayPDF)` Sets the last page overlay PDF.
`void`	`setOddPageOverlayFile(String oddPageOverlayFile)` Sets the odd page overlay file.
`void`	`setOddPageOverlayPDF(PDDocument oddPageOverlayPDF)` Sets the odd page overlay PDF.
`void`	`setOverlayPosition(Overlay.Position overlayPosition)` Sets the overlay position.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Overlay
```
public Overlay()
```
- Method Detail
  - overlay
```
public PDDocument overlay(Map<Integer,String> specificPageOverlayFile)
                   throws IOException
```
    This will add overlays to a documents.
    
    Parameters:
    specificPageOverlayFile - map of overlay files for specific pages
    
    Returns:
    the resulting pdf, which has to be saved and closed be the caller
    
    Throws:
    
    IOException - if something went wrong
  - close
```
public void close()
           throws IOException
```
    Close all input pdfs which were used for the overlay.
    
    Throws:
    
    IOException - if something went wrong
  - 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
  - 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

Class Overlay

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Overlay

Method Detail

overlay

close

setOverlayPosition

setInputFile

setInputPDF

getInputFile

setDefaultOverlayFile

setDefaultOverlayPDF

getDefaultOverlayFile

setFirstPageOverlayFile

setFirstPageOverlayPDF

setLastPageOverlayFile

setLastPageOverlayPDF

setAllPagesOverlayFile

setAllPagesOverlayPDF

setOddPageOverlayFile

setOddPageOverlayPDF

setEvenPageOverlayFile

setEvenPageOverlayPDF