Skip navigation links

oracle.xdo.template.pdf.book
Class PDFOverlay

java.lang.Object
oracle.xdo.template.pdf.book.PDFOverlay

public class PDFOverlay

extends java.lang.Object

PDFOverlay is a tool useful for overlaying one PDF template on top of another PDF document, as a transparent background. If you have Adobe Acrobat Professional, it is very simliar to the 'Document->Add Watermark & Background' functionality.

The PDFOverlay class can be used as a Java API or from the command-line when specifying the following parameters:
-out <file>: Filename of output pdf
-template <file>: Filename of the overlay pdf template
-document <file>: Filename of document pdf for which the template gets applied
-tmp <path to directory>: Used to specify a temp directory for better memory management (Optional)
-transparency <value between 0 and 1>: Used to specify a transparency value for the template appearing in the background (Optional, default value is 1)
-startPage <number>: starting page number in the document to start applying the overlay template to. The page numbering starts from 1 (Optional, default value is 1)
-endPage <number>: ending page number in the document to start applying the overlay template to. The page numbering starts from 1 (Optional, default value is automatically set to ending page number of pdf document)
-overlayOnTop <boolean value>: specify whether or not to overlay the template page on the top or bottom of the page content (Optional, default value is true)
-rotate <0, 90, 180, or 270>: used for rotating the template before applying it to document (Optional, default value is 0)
-interweave <true or false>: page 1 of template gets overlayed on top of page 1 of content, page 2 of template gets overlayed on top of page 2 of content, etc... (Optional, default value is false)

Field Summary

static java.lang.String

RCS_ID

Constructor Summary

PDFOverlay()

PDFOverlay(java.io.InputStream mainDocument, java.io.InputStream overlayTemplate, java.io.OutputStream outputStream)

PDFOverlay(PDFParser pdfParserForContent, java.io.InputStream overlayTemplate)
Deprecated. since 11.1.1.8.0

Method Summary

static void	main(java.lang.String[] args)
PDFParser	process() Deprecated. since 11.1.1.8.0
void	setConfig(java.util.Properties prop)
void	setEndPage(int page)
void	setInterweave(boolean flag)
void	setMainDocument(java.io.InputStream inStream)
void	setMainPDFParser(PDFParser pdfParser) Deprecated. since 11.1.1.8.0
void	setOutputStream(java.io.OutputStream outStream)
void	setOverlayOnTop(boolean flag)
void	setOverlayTemplate(java.io.InputStream inStream)
void	setRotation(int rotation)
void	setStartPage(int page)
void	setTransparency(double trans)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RCS_ID

public static final java.lang.String RCS_ID

See Also:

Constant Field Values

Constructor Detail

PDFOverlay

public PDFOverlay()

PDFOverlay

public PDFOverlay(PDFParser pdfParserForContent,
                  java.io.InputStream overlayTemplate)

Deprecated. since 11.1.1.8.0

Parameters:

pdfParserForContent -

overlayTemplate -

PDFOverlay

public PDFOverlay(java.io.InputStream mainDocument,
                  java.io.InputStream overlayTemplate,
                  java.io.OutputStream outputStream)

Method Detail

setConfig

public void setConfig(java.util.Properties prop)

setOverlayTemplate

public void setOverlayTemplate(java.io.InputStream inStream)

setMainPDFParser

public void setMainPDFParser(PDFParser pdfParser)

Deprecated. since 11.1.1.8.0

Parameters:

pdfParser -

setMainDocument

public void setMainDocument(java.io.InputStream inStream)

setOutputStream

public void setOutputStream(java.io.OutputStream outStream)

setTransparency

public void setTransparency(double trans)

setRotation

public void setRotation(int rotation)

setStartPage

public void setStartPage(int page)

setEndPage

public void setEndPage(int page)

setOverlayOnTop

public void setOverlayOnTop(boolean flag)

setInterweave

public void setInterweave(boolean flag)

process

public PDFParser process()
                  throws java.lang.Exception

Deprecated. since 11.1.1.8.0

Returns:

Throws:

java.lang.Exception

main

public static void main(java.lang.String[] args)

Skip navigation links