Uses of Class
org.apache.pdfbox.pdmodel.PDDocument

Packages that use PDDocument

Package	Description
org.apache.pdfbox	This package holds executable classes that interact with the PDFBox application.
org.apache.pdfbox.encryption	These classes deal with encryption algorithms that are used in the PDF Document.
org.apache.pdfbox.pdfparser	The pdfparser package contains classes to parse PDF documents and objects within the document.
org.apache.pdfbox.pdfviewer	The pdfviewer package contains classes to graphically display information about a PDF document.
org.apache.pdfbox.pdfwriter	This is the persistence layer used to write the PDFBox documents to a stream.
org.apache.pdfbox.pdmodel	The PDModel package represents a high level API for creating and manipulating PDF documents.
org.apache.pdfbox.pdmodel.common	High level PD classes that are used throughout several packages are placed in the PDModel common package.
org.apache.pdfbox.pdmodel.common.filespecification	The file specification package defines classes that are used for the PDF File Specification logic.
org.apache.pdfbox.pdmodel.edit	The PDModel edit package will be used to store classes for creating page content.
org.apache.pdfbox.pdmodel.encryption	The encryption package will handle the PDF document security handlers and the functionality of pluggable security handlers.
org.apache.pdfbox.pdmodel.font	Classes to deal with font functionality in a PDF Document.
org.apache.pdfbox.pdmodel.graphics.color	This package deals with colors that are stored in a PDF document.
org.apache.pdfbox.pdmodel.graphics.xobject	This package deals with images that are stored in a PDF document.
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible	This is the visual signature part that help creating the visual representation for the digital signature.
org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline	The outline package allows for a PDF outline(bookmarks) to be created.
org.apache.pdfbox.pdmodel.interactive.form	The interactive package contains classes that deal with interactive annotations such as textfields and buttons.
org.apache.pdfbox.util	This package contains utility classes that are used by the PDFBox project.

Uses of PDDocument in org.apache.pdfbox

Methods in org.apache.pdfbox that return PDDocument

Modifier and Type	Method	Description
PDDocument	TextToPDF.createPDFFromText(java.io.Reader text)	Create a PDF document with some text.
PDDocument	Overlay.overlay(PDDocument overlay, PDDocument destination)	This will overlay two documents onto each other.

Methods in org.apache.pdfbox with parameters of type PDDocument

Modifier and Type	Method	Description
void	ExportFDF.close(PDDocument doc)	Close the document.
void	ExportXFDF.close(PDDocument doc)	Close the document.
void	ImportFDF.close(PDDocument doc)	Close the document.
void	ImportXFDF.close(PDDocument doc)	Close the document.
void	TextToPDF.createPDFFromText(PDDocument doc, java.io.Reader text)	Create a PDF document with some text.
void	ImportFDF.importFDF(PDDocument pdfDocument, FDFDocument fdfDocument)	This will takes the values from the fdf document and import them into the PDF document.
void	ImportXFDF.importFDF(PDDocument pdfDocument, FDFDocument fdfDocument)	This will takes the values from the fdf document and import them into the PDF document.
PDDocument	Overlay.overlay(PDDocument overlay, PDDocument destination)	This will overlay two documents onto each other.

Uses of PDDocument in org.apache.pdfbox.encryption

Constructors in org.apache.pdfbox.encryption with parameters of type PDDocument

Constructor	Description
DocumentEncryption(PDDocument doc)	Deprecated. Constructor.

Uses of PDDocument in org.apache.pdfbox.pdfparser

Methods in org.apache.pdfbox.pdfparser that return PDDocument

Modifier and Type	Method	Description
PDDocument	ConformingPDFParser.getPDDocument()	This will get the PD document that was parsed.
PDDocument	NonSequentialPDFParser.getPDDocument()	This will get the PD document that was parsed.
PDDocument	PDFParser.getPDDocument()	This will get the PD document that was parsed.

Uses of PDDocument in org.apache.pdfbox.pdfviewer

Methods in org.apache.pdfbox.pdfviewer with parameters of type PDDocument

Modifier and Type	Method	Description
void	PDFTreeModel.setDocument(PDDocument doc)	Set the document to display in the tree.

Constructors in org.apache.pdfbox.pdfviewer with parameters of type PDDocument

Constructor	Description
PDFTreeModel(PDDocument doc)	Constructor to take a document.

Uses of PDDocument in org.apache.pdfbox.pdfwriter

Methods in org.apache.pdfbox.pdfwriter with parameters of type PDDocument

Modifier and Type	Method	Description
void	COSWriter.write(PDDocument doc)	This will write the pdf document.

Uses of PDDocument in org.apache.pdfbox.pdmodel

Subclasses of PDDocument in org.apache.pdfbox.pdmodel

Modifier and Type	Class	Description
class	ConformingPDDocument

Methods in org.apache.pdfbox.pdmodel that return PDDocument

Modifier and Type	Method	Description
static PDDocument	ConformingPDDocument.load(java.io.File input)	This will load a document from an input stream.
static PDDocument	PDDocument.load(java.io.File file)	This will load a document from a file.
static PDDocument	PDDocument.load(java.io.File file, RandomAccess scratchFile)	This will load a document from a file.
static PDDocument	PDDocument.load(java.io.InputStream input)	This will load a document from an input stream.
static PDDocument	PDDocument.load(java.io.InputStream input, boolean force)	This will load a document from an input stream.
static PDDocument	PDDocument.load(java.io.InputStream input, RandomAccess scratchFile)	This will load a document from an input stream.
static PDDocument	PDDocument.load(java.io.InputStream input, RandomAccess scratchFile, boolean force)	This will load a document from an input stream.
static PDDocument	PDDocument.load(java.lang.String filename)	This will load a document from a file.
static PDDocument	PDDocument.load(java.lang.String filename, boolean force)	This will load a document from a file.
static PDDocument	PDDocument.load(java.lang.String filename, RandomAccess scratchFile)	This will load a document from a file.
static PDDocument	PDDocument.load(java.net.URL url)	This will load a document from a url.
static PDDocument	PDDocument.load(java.net.URL url, boolean force)	This will load a document from a url.
static PDDocument	PDDocument.load(java.net.URL url, RandomAccess scratchFile)	This will load a document from a url.
static PDDocument	PDDocument.loadNonSeq(java.io.File file, RandomAccess scratchFile)	Parses PDF with the new non sequential parser and an empty password.
static PDDocument	PDDocument.loadNonSeq(java.io.File file, RandomAccess scratchFile, java.lang.String password)	Parses PDF with the new non sequential parser and an empty password.
static PDDocument	PDDocument.loadNonSeq(java.io.InputStream input, RandomAccess scratchFile)	Parses PDF with the new non sequential parser.
static PDDocument	PDDocument.loadNonSeq(java.io.InputStream input, RandomAccess scratchFile, java.lang.String password)	Parses PDF with the new non sequential parser.

Constructors in org.apache.pdfbox.pdmodel with parameters of type PDDocument

Constructor	Description
PDDocumentCatalog(PDDocument doc)	Constructor.
PDDocumentCatalog(PDDocument doc, COSDictionary rootDictionary)	Constructor.
PDPageable(PDDocument document)	Creates a Pageable adapter for the given PDF document using a default printer job returned by PrinterJob.getPrinterJob().
PDPageable(PDDocument document, java.awt.print.PrinterJob printerJob)	Creates a Pageable adapter for the given PDF document and printer job.

Uses of PDDocument in org.apache.pdfbox.pdmodel.common

Methods in org.apache.pdfbox.pdmodel.common with parameters of type PDDocument

Modifier and Type	Method	Description
static PDObjectStream	PDObjectStream.createStream(PDDocument document)	This will create a new PDStream object.

Constructors in org.apache.pdfbox.pdmodel.common with parameters of type PDDocument

Constructor	Description
PDMetadata(PDDocument document)	This will create a new PDMetadata object.
PDMetadata(PDDocument doc, java.io.InputStream str, boolean filtered)	Constructor.
PDPageLabels(PDDocument document)	Creates an empty page label dictionary for the given document.
PDPageLabels(PDDocument document, COSDictionary dict)	Creates an page label dictionary for a document using the information in the given COS dictionary.
PDStream(PDDocument document)	This will create a new empty PDStream object.
PDStream(PDDocument doc, java.io.InputStream str)	Constructor.
PDStream(PDDocument doc, java.io.InputStream str, boolean filtered)	Constructor.

Uses of PDDocument in org.apache.pdfbox.pdmodel.common.filespecification

Constructors in org.apache.pdfbox.pdmodel.common.filespecification with parameters of type PDDocument

Constructor	Description
PDEmbeddedFile(PDDocument document)	Constructor.
PDEmbeddedFile(PDDocument doc, java.io.InputStream str)	Constructor.
PDEmbeddedFile(PDDocument doc, java.io.InputStream str, boolean filtered)	Constructor.

Uses of PDDocument in org.apache.pdfbox.pdmodel.edit

Constructors in org.apache.pdfbox.pdmodel.edit with parameters of type PDDocument

Constructor	Description
PDPageContentStream(PDDocument document, PDPage sourcePage)	Create a new PDPage content stream.
PDPageContentStream(PDDocument document, PDPage sourcePage, boolean appendContent, boolean compress)	Create a new PDPage content stream.
PDPageContentStream(PDDocument document, PDPage sourcePage, boolean appendContent, boolean compress, boolean resetContext)	Create a new PDPage content stream.

Uses of PDDocument in org.apache.pdfbox.pdmodel.encryption

Fields in org.apache.pdfbox.pdmodel.encryption declared as PDDocument

Modifier and Type	Field	Description
protected PDDocument	SecurityHandler.document	The document whose security is handled by this security handler.

Methods in org.apache.pdfbox.pdmodel.encryption with parameters of type PDDocument

Modifier and Type	Method	Description
void	PublicKeySecurityHandler.decryptDocument(PDDocument doc, DecryptionMaterial decryptionMaterial)	Decrypt the document.
abstract void	SecurityHandler.decryptDocument(PDDocument doc, DecryptionMaterial mat)	Prepare the document for decryption.
void	StandardSecurityHandler.decryptDocument(PDDocument doc, DecryptionMaterial decryptionMaterial)	Decrypt the document.
void	PublicKeySecurityHandler.prepareDocumentForEncryption(PDDocument doc)	Prepare the document for encryption.
abstract void	SecurityHandler.prepareDocumentForEncryption(PDDocument doc)	Prepare the document for encryption.
void	StandardSecurityHandler.prepareDocumentForEncryption(PDDocument doc)	Prepare document for encryption.

Uses of PDDocument in org.apache.pdfbox.pdmodel.font

Methods in org.apache.pdfbox.pdmodel.font with parameters of type PDDocument

Modifier and Type	Method	Description
static PDTrueTypeFont	PDTrueTypeFont.loadTTF(PDDocument doc, java.io.File file)	This will load a TTF to be embedded into a document.
static PDTrueTypeFont	PDTrueTypeFont.loadTTF(PDDocument doc, java.io.InputStream stream)	This will load a TTF to be embedded into a document.
static PDTrueTypeFont	PDTrueTypeFont.loadTTF(PDDocument doc, java.io.InputStream stream, Encoding enc)	This will load a TTF to be embedded into a document.
static PDTrueTypeFont	PDTrueTypeFont.loadTTF(PDDocument doc, java.lang.String file)	This will load a TTF font from a font file.

Constructors in org.apache.pdfbox.pdmodel.font with parameters of type PDDocument

Constructor	Description
PDType1AfmPfbFont(PDDocument doc, java.io.InputStream afm, java.io.InputStream pfb)	Create a new object.
PDType1AfmPfbFont(PDDocument doc, java.lang.String afmname)	Create a new object.

Uses of PDDocument in org.apache.pdfbox.pdmodel.graphics.color

Methods in org.apache.pdfbox.pdmodel.graphics.color with parameters of type PDDocument

Modifier and Type	Method	Description
static PDColorSpace	PDColorSpaceFactory.createColorSpace(PDDocument doc, java.awt.color.ColorSpace cs)	This will create the correct color space from a java colorspace.

Constructors in org.apache.pdfbox.pdmodel.graphics.color with parameters of type PDDocument

Constructor	Description
PDICCBased(PDDocument doc)	Default constructor, creates empty stream.
PDOutputIntent(PDDocument doc, java.io.InputStream colorProfile)

Uses of PDDocument in org.apache.pdfbox.pdmodel.graphics.xobject

Constructors in org.apache.pdfbox.pdmodel.graphics.xobject with parameters of type PDDocument

Constructor	Description
PDCcitt(PDDocument doc, RandomAccess raf)	Construct from a tiff file.
PDCcitt(PDDocument doc, RandomAccess raf, int number)	Construct from a tiff file.
PDJpeg(PDDocument doc, java.awt.image.BufferedImage bi)	Construct from a buffered image.
PDJpeg(PDDocument doc, java.awt.image.BufferedImage bi, float compressionQuality)	Construct from a buffered image.
PDJpeg(PDDocument doc, java.io.InputStream is)	Construct from a stream.
PDPixelMap(PDDocument doc, java.awt.image.BufferedImage bi)	Construct a pixel map image from an AWT image.
PDXObject(PDDocument doc)	Standard constuctor.
PDXObjectImage(PDDocument doc, java.lang.String fileSuffix)	Standard constuctor.

Uses of PDDocument in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible

Methods in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible that return PDDocument

Modifier and Type	Method	Description
PDDocument	PDFTemplateStructure.getTemplate()	Gets PDDocument template.

Methods in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible with parameters of type PDDocument

Modifier and Type	Method	Description
void	PDFTemplateBuilder.closeTemplate(PDDocument template)	Closes template
void	PDVisibleSigBuilder.closeTemplate(PDDocument template)
void	PDFTemplateBuilder.createAcroForm(PDDocument template)	Creates Acro forms in the template
void	PDVisibleSigBuilder.createAcroForm(PDDocument template)
void	PDFTemplateBuilder.createHolderFormStream(PDDocument template)
void	PDVisibleSigBuilder.createHolderFormStream(PDDocument template)
void	PDFTemplateBuilder.createImageFormStream(PDDocument template)
void	PDVisibleSigBuilder.createImageFormStream(PDDocument template)
void	PDFTemplateBuilder.createInnerFormStream(PDDocument template)
void	PDVisibleSigBuilder.createInnerFormStream(PDDocument template)
void	PDFTemplateBuilder.createSignatureImage(PDDocument template, java.io.InputStream InputStream)	Creates signature image
void	PDVisibleSigBuilder.createSignatureImage(PDDocument template, java.io.InputStream inputStream)
void	PDFTemplateBuilder.createVisualSignature(PDDocument template)	just to create visible signature
void	PDVisibleSigBuilder.createVisualSignature(PDDocument template)
void	PDFTemplateStructure.setTemplate(PDDocument template)	Wets PDDocument template.

Constructors in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible with parameters of type PDDocument

Constructor	Description
PDVisibleSignDesigner(PDDocument doc, java.io.InputStream imageStream, int page)

Uses of PDDocument in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline

Methods in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline with parameters of type PDDocument

Modifier and Type	Method	Description
PDPage	PDOutlineItem.findDestinationPage(PDDocument doc)	This method will attempt to find the page in this PDF document that this outline points to.

Uses of PDDocument in org.apache.pdfbox.pdmodel.interactive.form

Methods in org.apache.pdfbox.pdmodel.interactive.form that return PDDocument

Modifier and Type	Method	Description
PDDocument	PDAcroForm.getDocument()	This will get the document associated with this form.

Constructors in org.apache.pdfbox.pdmodel.interactive.form with parameters of type PDDocument

Constructor	Description
PDAcroForm(PDDocument doc)	Constructor.
PDAcroForm(PDDocument doc, COSDictionary form)	Constructor.

Uses of PDDocument in org.apache.pdfbox.util

Fields in org.apache.pdfbox.util declared as PDDocument

Modifier and Type	Field	Description
protected PDDocument	Splitter.currentDocument	The current PDF document that contains the splitted page.
protected PDDocument	PDFTextStripper.document	The document to read.
protected PDDocument	Splitter.pdfDocument	The source PDF document.
protected PDDocument	PageExtractor.sourceDocument

Methods in org.apache.pdfbox.util that return PDDocument

Modifier and Type	Method	Description
PDDocument	PageExtractor.extract()	This will take a document and extract the desired pages into a new document.
PDDocument	PDFCloneUtility.getDestination()	Returns the destination PDF document this cloner instance is set up for.
PDDocument	LayerUtility.getDocument()	Returns the PDF document we work on.

Methods in org.apache.pdfbox.util that return types with arguments of type PDDocument

Modifier and Type	Method	Description
java.util.List<PDDocument>	Splitter.split(PDDocument document)	This will take a document and split into several other documents.

Methods in org.apache.pdfbox.util with parameters of type PDDocument

Modifier and Type	Method	Description
void	PDFMergerUtility.appendDocument(PDDocument destination, PDDocument source)	append all pages from source to destination.
void	PDFText2HTML.endDocument(PDDocument pdf)	This method is available for subclasses of this class.
protected void	PDFTextStripper.endDocument(PDDocument pdf)	This method is available for subclasses of this class.
void	PDFHighlighter.generateXMLHighlight(PDDocument pdDocument, java.lang.String[] sWords, java.io.Writer xmlOutput)	Generate an XML highlight string based on the PDF.
void	PDFHighlighter.generateXMLHighlight(PDDocument pdDocument, java.lang.String highlightWord, java.io.Writer xmlOutput)	Generate an XML highlight string based on the PDF.
java.lang.String	PDFTextStripper.getText(PDDocument doc)	This will return the text of a document.
PDXObjectForm	LayerUtility.importPageAsForm(PDDocument sourceDoc, int pageNumber)	Imports a page from some PDF file as a Form XObject so it can be placed on another page in the target document.
PDXObjectForm	LayerUtility.importPageAsForm(PDDocument sourceDoc, PDPage page)	Imports a page from some PDF file as a Form XObject so it can be placed on another page in the target document.
void	Overlay.setAllPagesOverlayPDF(PDDocument allPagesOverlayPDF)	Sets the all pages overlay PDF.
void	Overlay.setDefaultOverlayPDF(PDDocument defaultOverlayPDF)	Sets the default overlay PDF.
void	Overlay.setEvenPageOverlayPDF(PDDocument evenPageOverlayPDF)	Sets the even page overlay PDF.
void	Overlay.setFirstPageOverlayPDF(PDDocument firstPageOverlayPDF)	Sets the first page overlay PDF.
void	Overlay.setInputPDF(PDDocument inputPDF)	Sets the PDF to be overlayed.
void	Overlay.setLastPageOverlayPDF(PDDocument lastPageOverlayPDF)	Sets the last page overlay PDF.
void	Overlay.setOddPageOverlayPDF(PDDocument oddPageOverlayPDF)	Sets the odd page overlay PDF.
java.util.List<PDDocument>	Splitter.split(PDDocument document)	This will take a document and split into several other documents.
protected void	PDFTextStripper.startDocument(PDDocument pdf)	This method is available for subclasses of this class.
boolean	PDFImageWriter.writeImage(PDDocument document, java.lang.String imageFormat, java.lang.String password, int startPage, int endPage, java.lang.String outputPrefix)	Converts a given page range of a PDF document to bitmap images by calling PDFImageWriter.writeImage(PDDocument document, String imageFormat, String password, int startPage, int endPage, String outputPrefix, int imageType, int resolution) with imageType BufferedImage.TYPE_INT_RGB and screen resolution, or 96dpi if screen resolution is unavailable.
boolean	PDFImageWriter.writeImage(PDDocument document, java.lang.String imageFormat, java.lang.String password, int startPage, int endPage, java.lang.String outputPrefix, int imageType, int resolution)	Converts a given page range of a PDF document to bitmap images.
void	PDFTextStripper.writeText(PDDocument doc, java.io.Writer outputStream)	This will take a PDDocument and write the text of that document to the print writer.

Constructors in org.apache.pdfbox.util with parameters of type PDDocument

Constructor	Description
LayerUtility(PDDocument document)	Creates a new instance.
PageExtractor(PDDocument sourceDocument)	Creates a new instance of PageExtractor
PageExtractor(PDDocument sourceDocument, int startPage, int endPage)	Creates a new instance of PageExtractor
PDFCloneUtility(PDDocument dest)	Creates a new instance for the given target document.