Uses of Class
org.apache.pdfbox.pdmodel.PDDocument
Packages that use PDDocument
Package
Description
The pdfparser package contains classes to parse PDF documents and objects within the document.
This is the persistence layer used to write the PDFBox documents to a stream.
The PDModel package represents a high level API for creating and manipulating PDF documents.
High level PD classes that are used throughout several packages are placed in the PDModel common package.
The file specification package defines classes that are used for the PDF File Specification logic.
The encryption package will handle the PDF document security handlers and the functionality of pluggable security handlers.
Classes to deal with font functionality in a PDF Document.
The PDModel graphics package deals with graphics states, operations, and parameters within the PDF document.
This package deals with colors that are stored in a PDF document.
This package deals with Form XObjects that are stored in a PDF document.
This package deals with images that are stored in a PDF document.
The annotation package contains classes that work with PDF annotation elements.
This is the visual signature part that help creating the visual representation for the digital signature.
The outline package allows for a PDF outline(bookmarks) to be created.
The interactive package contains classes for handling Interactive Forms, also known as "AcroForms".
-
Uses of PDDocument in org.apache.pdfbox.debugger
Fields in org.apache.pdfbox.debugger declared as PDDocumentMethods in org.apache.pdfbox.debugger that return PDDocumentModifier and TypeMethodDescription(package private) abstract PDDocument
PDFDebugger.DocumentOpener.open()
Override to load the actual input type (File, URL, stream), don't call it directly!(package private) final PDDocument
PDFDebugger.DocumentOpener.parse()
Call this!Methods in org.apache.pdfbox.debugger with parameters of type PDDocumentModifier and TypeMethodDescriptionstatic String
PDFDebugger.getPageLabel
(PDDocument document, int pageIndex) Convenience method to get the page label if available. -
Uses of PDDocument in org.apache.pdfbox.debugger.flagbitspane
Fields in org.apache.pdfbox.debugger.flagbitspane declared as PDDocumentModifier and TypeFieldDescriptionprivate final PDDocument
FlagBitsPane.document
private final PDDocument
SigFlag.document
Constructors in org.apache.pdfbox.debugger.flagbitspane with parameters of type PDDocumentModifierConstructorDescriptionFlagBitsPane
(PDDocument document, COSDictionary dictionary, COSName flagType) Constructor.(package private)
SigFlag
(PDDocument document, COSDictionary acroFormDictionary) Constructor -
Uses of PDDocument in org.apache.pdfbox.debugger.pagepane
Fields in org.apache.pdfbox.debugger.pagepane declared as PDDocumentConstructors in org.apache.pdfbox.debugger.pagepane with parameters of type PDDocumentModifierConstructorDescriptionPagePane
(PDDocument document, COSDictionary pageDict, JLabel statuslabel) -
Uses of PDDocument in org.apache.pdfbox.debugger.ui
Fields in org.apache.pdfbox.debugger.ui declared as PDDocumentMethods in org.apache.pdfbox.debugger.ui with parameters of type PDDocumentModifier and TypeMethodDescriptionboolean
FileOpenSaveDialog.saveDocument
(PDDocument document, String extension) Saves document into a .pdf file after the user is prompted to choose the destination.Constructors in org.apache.pdfbox.debugger.ui with parameters of type PDDocumentModifierConstructorDescriptionDocumentEntry
(PDDocument doc, String filename) PDFTreeModel
(PDDocument doc) Constructor to take a document. -
Uses of PDDocument in org.apache.pdfbox.multipdf
Fields in org.apache.pdfbox.multipdf declared as PDDocumentModifier and TypeFieldDescriptionprivate PDDocument
Overlay.allPagesOverlay
private PDDocument
Splitter.currentDestinationDocument
private PDDocument
Overlay.defaultOverlay
private final PDDocument
PDFCloneUtility.destination
private PDDocument
Overlay.evenPageOverlay
private PDDocument
Overlay.firstPageOverlay
private PDDocument
Overlay.inputPDFDocument
private PDDocument
Overlay.lastPageOverlay
private PDDocument
Overlay.oddPageOverlay
private final PDDocument
PageExtractor.sourceDocument
private PDDocument
Splitter.sourceDocument
private final PDDocument
LayerUtility.targetDoc
Fields in org.apache.pdfbox.multipdf with type parameters of type PDDocumentModifier and TypeFieldDescriptionprivate List<PDDocument>
Splitter.destinationDocuments
private final Set<PDDocument>
Overlay.openDocuments
Methods in org.apache.pdfbox.multipdf that return PDDocumentModifier and TypeMethodDescriptionprotected PDDocument
Splitter.createNewDocument()
Create a new document to write the split contents to.PageExtractor.extract()
This will take a document and extract the desired pages into a new document.PDFCloneUtility.getDestination()
Returns the destination PDF document this cloner instance is set up for.protected final PDDocument
Splitter.getDestinationDocument()
The source PDF document.LayerUtility.getDocument()
Returns the PDF document we work on.protected final PDDocument
Splitter.getSourceDocument()
The source PDF document.private PDDocument
This will add overlays to a document.Overlay.overlayDocuments
(Map<Integer, PDDocument> specificPageOverlayDocuments) This will add overlays documents to a document.Methods in org.apache.pdfbox.multipdf that return types with arguments of type PDDocumentModifier and TypeMethodDescriptionSplitter.split
(PDDocument document) This will take a document and split into several other documents.Methods in org.apache.pdfbox.multipdf with parameters of type PDDocumentModifier and TypeMethodDescriptionvoid
PDFMergerUtility.appendDocument
(PDDocument destination, PDDocument source) append all pages from source to destination.private Overlay.LayoutPage
Overlay.getLayoutPage
(PDDocument doc) private Map<Integer,
Overlay.LayoutPage> Overlay.getLayoutPages
(PDDocument doc) private void
LayerUtility.importOcProperties
(PDDocument srcDoc) Imports OCProperties from source document to target document so hidden layers can still be hidden after import.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.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.private void
Overlay.processPages
(PDDocument 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 overlaid.void
Overlay.setLastPageOverlayPDF
(PDDocument lastPageOverlayPDF) Sets the last page overlay PDF.void
Overlay.setOddPageOverlayPDF
(PDDocument oddPageOverlayPDF) Sets the odd page overlay PDF.Splitter.split
(PDDocument document) This will take a document and split into several other documents.Method parameters in org.apache.pdfbox.multipdf with type arguments of type PDDocumentModifier and TypeMethodDescriptionOverlay.overlayDocuments
(Map<Integer, PDDocument> specificPageOverlayDocuments) This will add overlays documents to a document.Constructors in org.apache.pdfbox.multipdf with parameters of type PDDocumentModifierConstructorDescriptionLayerUtility
(PDDocument document) Creates a new instance.PageExtractor
(PDDocument sourceDocument) Creates a new instance of PageExtractorPageExtractor
(PDDocument sourceDocument, int startPage, int endPage) Creates a new instance of PageExtractorPDFCloneUtility
(PDDocument dest) Creates a new instance for the given target document. -
Uses of PDDocument in org.apache.pdfbox.pdfparser
Methods in org.apache.pdfbox.pdfparser that return PDDocumentModifier and TypeMethodDescriptionPDFParser.getPDDocument()
This will get the PD document that was parsed. -
Uses of PDDocument in org.apache.pdfbox.pdfwriter
Fields in org.apache.pdfbox.pdfwriter declared as PDDocumentMethods in org.apache.pdfbox.pdfwriter with parameters of type PDDocumentModifier and TypeMethodDescriptionprivate void
COSWriter.prepareIncrement
(PDDocument doc) void
COSWriter.write
(PDDocument doc) This will write the pdf document.void
COSWriter.write
(PDDocument doc, SignatureInterface signInterface) This will write the pdf document. -
Uses of PDDocument in org.apache.pdfbox.pdmodel
Fields in org.apache.pdfbox.pdmodel declared as PDDocumentModifier and TypeFieldDescriptionprotected final PDDocument
PDAbstractContentStream.document
private final PDDocument
PDDocumentCatalog.document
private final PDDocument
PDPageContentStream.document
private final PDDocument
PDPageTree.document
Methods in org.apache.pdfbox.pdmodel that return PDDocumentModifier and TypeMethodDescriptionstatic PDDocument
PDDocument.load
(byte[] input) Parses a PDF.static PDDocument
Parses a PDF.static PDDocument
PDDocument.load
(byte[] input, String password, InputStream keyStore, String alias) Parses a PDF.static PDDocument
PDDocument.load
(byte[] input, String password, InputStream keyStore, String alias, MemoryUsageSetting memUsageSetting) Parses a PDF.static PDDocument
Parses a PDF.static PDDocument
Parses a PDF.static PDDocument
PDDocument.load
(File file, String password, InputStream keyStore, String alias) Parses a PDF.static PDDocument
PDDocument.load
(File file, String password, InputStream keyStore, String alias, MemoryUsageSetting memUsageSetting) Parses a PDF.static PDDocument
PDDocument.load
(File file, String password, MemoryUsageSetting memUsageSetting) Parses a PDF.static PDDocument
PDDocument.load
(File file, MemoryUsageSetting memUsageSetting) Parses a PDF.static PDDocument
PDDocument.load
(InputStream input) Parses a PDF.static PDDocument
PDDocument.load
(InputStream input, String password) Parses a PDF.static PDDocument
PDDocument.load
(InputStream input, String password, InputStream keyStore, String alias) Parses a PDF.static PDDocument
PDDocument.load
(InputStream input, String password, InputStream keyStore, String alias, MemoryUsageSetting memUsageSetting) Parses a PDF.static PDDocument
PDDocument.load
(InputStream input, String password, MemoryUsageSetting memUsageSetting) Parses a PDF.static PDDocument
PDDocument.load
(InputStream input, MemoryUsageSetting memUsageSetting) Parses a PDF.private static PDDocument
PDDocument.load
(RandomAccessBufferedFileInputStream raFile, String password, InputStream keyStore, String alias, MemoryUsageSetting memUsageSetting) Constructors in org.apache.pdfbox.pdmodel with parameters of type PDDocumentModifierConstructorDescription(package private)
PDAbstractContentStream
(PDDocument document, OutputStream outputStream, PDResources resources) Create a new appearance stream.Constructor.PDDocumentCatalog
(PDDocument doc, COSDictionary rootDictionary) Constructor.PDPageContentStream
(PDDocument doc, PDFormXObject form, OutputStream outputStream) Create a new appearance stream.PDPageContentStream
(PDDocument doc, PDTilingPattern pattern, OutputStream outputStream) Create a new appearance stream.PDPageContentStream
(PDDocument doc, PDAppearanceStream appearance) Create a new appearance stream.PDPageContentStream
(PDDocument doc, PDAppearanceStream appearance, OutputStream outputStream) Create a new appearance stream.PDPageContentStream
(PDDocument document, PDPage sourcePage) Create a new PDPage content stream.PDPageContentStream
(PDDocument document, PDPage sourcePage, boolean appendContent, boolean compress) Deprecated.PDPageContentStream
(PDDocument document, PDPage sourcePage, boolean appendContent, boolean compress, boolean resetContext) PDPageContentStream
(PDDocument document, PDPage sourcePage, PDPageContentStream.AppendMode appendContent, boolean compress) Create a new PDPage content stream.PDPageContentStream
(PDDocument document, PDPage sourcePage, PDPageContentStream.AppendMode appendContent, boolean compress, boolean resetContext) Create a new PDPage content stream.(package private)
PDPageTree
(COSDictionary root, PDDocument document) Constructor for reading. -
Uses of PDDocument in org.apache.pdfbox.pdmodel.common
Fields in org.apache.pdfbox.pdmodel.common declared as PDDocumentMethods in org.apache.pdfbox.pdmodel.common with parameters of type PDDocumentModifier and TypeMethodDescriptionstatic PDObjectStream
PDObjectStream.createStream
(PDDocument document) This will create a new PDObjectStream object.Constructors in org.apache.pdfbox.pdmodel.common with parameters of type PDDocumentModifierConstructorDescriptionPDMetadata
(PDDocument document) This will create a new PDMetadata object.PDMetadata
(PDDocument doc, InputStream str) 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) Creates a new empty PDStream object.PDStream
(PDDocument doc, InputStream input) Constructor.PDStream
(PDDocument doc, InputStream input, COSArray filters) Constructor.private
PDStream
(PDDocument doc, InputStream input, COSBase filters) Constructor.PDStream
(PDDocument doc, InputStream input, COSName filter) Constructor. -
Uses of PDDocument in org.apache.pdfbox.pdmodel.common.filespecification
Constructors in org.apache.pdfbox.pdmodel.common.filespecification with parameters of type PDDocumentModifierConstructorDescriptionPDEmbeddedFile
(PDDocument document) PDEmbeddedFile
(PDDocument doc, InputStream str) PDEmbeddedFile
(PDDocument doc, InputStream input, COSName filter) -
Uses of PDDocument in org.apache.pdfbox.pdmodel.encryption
Methods in org.apache.pdfbox.pdmodel.encryption with parameters of type PDDocumentModifier and TypeMethodDescriptionvoid
PublicKeySecurityHandler.prepareDocumentForEncryption
(PDDocument doc) Prepare the document for encryption.abstract void
SecurityHandler.prepareDocumentForEncryption
(PDDocument doc) Prepare the document for encryption.void
StandardSecurityHandler.prepareDocumentForEncryption
(PDDocument document) Prepare document for encryption.private void
StandardSecurityHandler.prepareEncryptionDictRev2345
(String ownerPassword, String userPassword, PDEncryption encryptionDictionary, int permissionInt, PDDocument document, int revision, int length) -
Uses of PDDocument in org.apache.pdfbox.pdmodel.fixup
Fields in org.apache.pdfbox.pdmodel.fixup declared as PDDocumentConstructors in org.apache.pdfbox.pdmodel.fixup with parameters of type PDDocumentModifierConstructorDescriptionprotected
AbstractFixup
(PDDocument document) AcroFormDefaultFixup
(PDDocument document) -
Uses of PDDocument in org.apache.pdfbox.pdmodel.fixup.processor
Fields in org.apache.pdfbox.pdmodel.fixup.processor declared as PDDocumentConstructors in org.apache.pdfbox.pdmodel.fixup.processor with parameters of type PDDocumentModifierConstructorDescriptionprotected
AbstractProcessor
(PDDocument document) AcroFormDefaultsProcessor
(PDDocument document) AcroFormOrphanWidgetsProcessor
(PDDocument document) -
Uses of PDDocument in org.apache.pdfbox.pdmodel.font
Fields in org.apache.pdfbox.pdmodel.font declared as PDDocumentModifier and TypeFieldDescriptionprivate final PDDocument
PDCIDFontType2Embedder.document
private final PDDocument
TrueTypeEmbedder.document
Methods in org.apache.pdfbox.pdmodel.font with parameters of type PDDocumentModifier and TypeMethodDescriptionstatic PDTrueTypeFont
PDTrueTypeFont.load
(PDDocument doc, File file, Encoding encoding) Loads a TTF to be embedded into a document as a simple font.static PDTrueTypeFont
PDTrueTypeFont.load
(PDDocument doc, InputStream input, Encoding encoding) Loads a TTF to be embedded into a document as a simple font.static PDTrueTypeFont
PDTrueTypeFont.load
(PDDocument doc, TrueTypeFont ttf, Encoding encoding) Loads a TTF to be embedded into a document as a simple font.static PDType0Font
PDType0Font.load
(PDDocument doc, File file) Loads a TTF to be embedded and subset into a document as a Type 0 font.static PDType0Font
PDType0Font.load
(PDDocument doc, InputStream input) Loads a TTF to be embedded and subset into a document as a Type 0 font.static PDType0Font
PDType0Font.load
(PDDocument doc, InputStream input, boolean embedSubset) Loads a TTF to be embedded into a document as a Type 0 font.static PDType0Font
PDType0Font.load
(PDDocument doc, TrueTypeFont ttf, boolean embedSubset) Loads a TTF to be embedded into a document as a Type 0 font.static PDTrueTypeFont
PDTrueTypeFont.loadTTF
(PDDocument doc, File file) Deprecated.UsePDType0Font.load(PDDocument, File)
instead.static PDTrueTypeFont
PDTrueTypeFont.loadTTF
(PDDocument doc, InputStream input) Deprecated.UsePDType0Font.load(PDDocument, InputStream)
instead.static PDType0Font
PDType0Font.loadVertical
(PDDocument doc, File file) Loads a TTF to be embedded into a document as a vertical Type 0 font.static PDType0Font
PDType0Font.loadVertical
(PDDocument doc, InputStream input) Loads a TTF to be embedded into a document as a vertical Type 0 font.static PDType0Font
PDType0Font.loadVertical
(PDDocument doc, InputStream input, boolean embedSubset) Loads a TTF to be embedded into a document as a vertical Type 0 font.static PDType0Font
PDType0Font.loadVertical
(PDDocument doc, TrueTypeFont ttf, boolean embedSubset) Loads a TTF to be embedded into a document as a vertical Type 0 font.Constructors in org.apache.pdfbox.pdmodel.font with parameters of type PDDocumentModifierConstructorDescription(package private)
PDCIDFontType2Embedder
(PDDocument document, COSDictionary dict, TrueTypeFont ttf, boolean embedSubset, PDType0Font parent, boolean vertical) Creates a new TrueType font embedder for the given TTF as a PDCIDFontType2.private
PDTrueTypeFont
(PDDocument document, TrueTypeFont ttf, Encoding encoding, boolean closeTTF) Creates a new TrueType font for embedding.(package private)
PDTrueTypeFontEmbedder
(PDDocument document, COSDictionary dict, TrueTypeFont ttf, Encoding encoding) Creates a new TrueType font embedder for the given TTF as a PDTrueTypeFont.private
PDType0Font
(PDDocument document, TrueTypeFont ttf, boolean embedSubset, boolean closeTTF, boolean vertical) Private.PDType1Font
(PDDocument doc, InputStream pfbIn) Creates a new Type 1 font for embedding.PDType1Font
(PDDocument doc, InputStream pfbIn, Encoding encoding) Creates a new Type 1 font for embedding.(package private)
PDType1FontEmbedder
(PDDocument doc, COSDictionary dict, InputStream pfbStream, Encoding encoding) This will load a PFB to be embedded into a document.(package private)
TrueTypeEmbedder
(PDDocument document, COSDictionary dict, TrueTypeFont ttf, boolean embedSubset) Creates a new TrueType font for embedding. -
Uses of PDDocument in org.apache.pdfbox.pdmodel.graphics
Constructors in org.apache.pdfbox.pdmodel.graphics with parameters of type PDDocumentModifierConstructorDescriptionprotected
PDXObject
(PDDocument document, COSName subtype) Creates a new XObject of the given subtype for writing. -
Uses of PDDocument in org.apache.pdfbox.pdmodel.graphics.color
Methods in org.apache.pdfbox.pdmodel.graphics.color with parameters of type PDDocumentModifier and TypeMethodDescriptionprivate PDStream
PDOutputIntent.configureOutputProfile
(PDDocument doc, InputStream colorProfile) Constructors in org.apache.pdfbox.pdmodel.graphics.color with parameters of type PDDocumentModifierConstructorDescriptionPDICCBased
(PDDocument doc) Creates a new ICC color space with an empty stream.PDOutputIntent
(PDDocument doc, InputStream colorProfile) -
Uses of PDDocument in org.apache.pdfbox.pdmodel.graphics.form
Constructors in org.apache.pdfbox.pdmodel.graphics.form with parameters of type PDDocumentModifierConstructorDescriptionPDFormXObject
(PDDocument document) Creates a Form Image XObject for writing, in the given document.PDTransparencyGroup
(PDDocument document) Creates a Transparency Group for writing, in the given document. -
Uses of PDDocument in org.apache.pdfbox.pdmodel.graphics.image
Fields in org.apache.pdfbox.pdmodel.graphics.image declared as PDDocumentModifier and TypeFieldDescriptionprivate final PDDocument
LosslessFactory.PredictorEncoder.document
Methods in org.apache.pdfbox.pdmodel.graphics.image with parameters of type PDDocumentModifier and TypeMethodDescriptionprivate static PDImageXObject
PNGConverter.buildImageObject
(PDDocument document, PNGConverter.PNGConverterState state) Build the base image object from the IDATs and profile informationprivate static PDImageXObject
PNGConverter.buildIndexImage
(PDDocument doc, PNGConverter.PNGConverterState state) Build a indexed imageprivate static PDImageXObject
PNGConverter.buildTransparencyMaskFromIndexedData
(PDDocument doc, PDImageXObject image, PNGConverter.PNGConverterState state) private static PDImageXObject
PNGConverter.convertPng
(PDDocument doc, PNGConverter.PNGConverterState state) Convert the image using the state.(package private) static PDImageXObject
PNGConverter.convertPNGImage
(PDDocument doc, byte[] imageData) Try to convert a PNG into a PDImageXObject.private static COSStream
PNGConverter.createCOSStreamwithIccProfile
(PDDocument document, PDColorSpace colorSpace, PNGConverter.PNGConverterState state) static PDImageXObject
CCITTFactory.createFromByteArray
(PDDocument document, byte[] byteArray) Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored in a byte array.static PDImageXObject
CCITTFactory.createFromByteArray
(PDDocument document, byte[] byteArray, int number) Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored in a byte array.static PDImageXObject
JPEGFactory.createFromByteArray
(PDDocument document, byte[] byteArray) Creates a new JPEG Image XObject from a byte array containing JPEG data.static PDImageXObject
PDImageXObject.createFromByteArray
(PDDocument document, byte[] byteArray, String name) Create a PDImageXObject from bytes of an image file.static PDImageXObject
CCITTFactory.createFromFile
(PDDocument document, File file) Creates a new CCITT Fax compressed image XObject from the first image of a TIFF file.static PDImageXObject
CCITTFactory.createFromFile
(PDDocument document, File file, int number) Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file.static PDImageXObject
PDImageXObject.createFromFile
(String imagePath, PDDocument doc) Create a PDImageXObject from an image file, seePDImageXObject.createFromFileByExtension(File, PDDocument)
for more details.static PDImageXObject
PDImageXObject.createFromFileByContent
(File file, PDDocument doc) Create a PDImageXObject from an image file.static PDImageXObject
PDImageXObject.createFromFileByExtension
(File file, PDDocument doc) Create a PDImageXObject from an image file.private static PDImageXObject
LosslessFactory.createFromGrayImage
(BufferedImage image, PDDocument document) static PDImageXObject
CCITTFactory.createFromImage
(PDDocument document, BufferedImage image) Creates a new CCITT group 4 (T6) compressed image XObject from a b/w BufferedImage.static PDImageXObject
JPEGFactory.createFromImage
(PDDocument document, BufferedImage image) Creates a new JPEG PDImageXObject from a BufferedImage.static PDImageXObject
JPEGFactory.createFromImage
(PDDocument document, BufferedImage image, float quality) Creates a new JPEG PDImageXObject from a BufferedImage and a given quality.static PDImageXObject
JPEGFactory.createFromImage
(PDDocument document, BufferedImage image, float quality, int dpi) Creates a new JPEG Image XObject from a BufferedImage, a given quality and dpi metadata.static PDImageXObject
LosslessFactory.createFromImage
(PDDocument document, BufferedImage image) Creates a new lossless encoded image XObject from a BufferedImage.static PDImageXObject
CCITTFactory.createFromRandomAccess
(PDDocument document, RandomAccess reader) Deprecated.UseCCITTFactory.createFromFile(PDDocument, File)
instead.static PDImageXObject
CCITTFactory.createFromRandomAccess
(PDDocument document, RandomAccess reader, int number) Deprecated.UseCCITTFactory.createFromFile(PDDocument, File, int)
instead.private static PDImageXObject
CCITTFactory.createFromRandomAccessImpl
(PDDocument document, RandomAccess reader, int number) Creates a new CCITT Fax compressed image XObject from a TIFF file.private static PDImageXObject
LosslessFactory.createFromRGBImage
(BufferedImage image, PDDocument document) static PDImageXObject
JPEGFactory.createFromStream
(PDDocument document, InputStream stream) Creates a new JPEG Image XObject from an input stream containing JPEG data.private static PDImageXObject
JPEGFactory.createJPEG
(PDDocument document, BufferedImage image, float quality, int dpi) private static COSStream
PDImageXObject.createRawStream
(PDDocument document, InputStream rawInput) Creates a COS stream from raw (encoded) data.private static PDImageXObject
CCITTFactory.prepareImageXObject
(PDDocument document, byte[] byteArray, int width, int height, PDColorSpace initColorSpace) (package private) static PDImageXObject
LosslessFactory.prepareImageXObject
(PDDocument document, byte[] byteArray, int width, int height, int bitsPerComponent, PDColorSpace initColorSpace) Create a PDImageXObject using the Flate filter.private static void
PNGConverter.setupIndexedColorSpace
(PDDocument doc, PNGConverter.Chunk lookupTable, PDImageXObject image, int highVal) Constructors in org.apache.pdfbox.pdmodel.graphics.image with parameters of type PDDocumentModifierConstructorDescriptionPDImageXObject
(PDDocument document) Creates an Image XObject in the given document.PDImageXObject
(PDDocument document, InputStream encodedStream, COSBase cosFilter, int width, int height, int bitsPerComponent, PDColorSpace initColorSpace) Creates an Image XObject in the given document using the given filtered stream.(package private)
PredictorEncoder
(PDDocument document, BufferedImage image) Initialize the encoder and set all final fields -
Uses of PDDocument in org.apache.pdfbox.pdmodel.interactive.annotation
Methods in org.apache.pdfbox.pdmodel.interactive.annotation with parameters of type PDDocumentModifier and TypeMethodDescriptionvoid
PDAnnotation.constructAppearances
(PDDocument document) Create the appearance entry for this annotation.void
PDAnnotationLine.constructAppearances
(PDDocument document) void
PDAnnotationLink.constructAppearances
(PDDocument document) void
PDAnnotationMarkup.constructAppearances
(PDDocument document) void
PDAnnotationSquareCircle.constructAppearances
(PDDocument document) void
PDAnnotationText.constructAppearances
(PDDocument document) void
PDAnnotationTextMarkup.constructAppearances
(PDDocument document) Constructors in org.apache.pdfbox.pdmodel.interactive.annotation with parameters of type PDDocumentModifierConstructorDescriptionPDAppearanceStream
(PDDocument document) Creates a Form Image XObject for writing, in the given document. -
Uses of PDDocument in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
Fields in org.apache.pdfbox.pdmodel.interactive.annotation.handlers declared as PDDocumentConstructors in org.apache.pdfbox.pdmodel.interactive.annotation.handlers with parameters of type PDDocumentModifierConstructorDescriptionPDAbstractAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDCaretAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDCircleAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDFreeTextAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDHighlightAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDInkAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDLineAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDLinkAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDPolygonAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDPolylineAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDSoundAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDSquareAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDSquigglyAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDStrikeoutAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDTextAppearanceHandler
(PDAnnotation annotation, PDDocument document) PDUnderlineAppearanceHandler
(PDAnnotation annotation, PDDocument document) -
Uses of PDDocument in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible
Fields in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible declared as PDDocumentMethods in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible that return PDDocumentMethods in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible with parameters of type PDDocumentModifier and TypeMethodDescriptionprivate void
PDVisibleSignDesigner.calculatePageSize
(PDDocument document, int page) Each page of document can be different sizes.void
PDFTemplateBuilder.closeTemplate
(PDDocument template) Closes templatevoid
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, BufferedImage image) Creates signature image.void
PDVisibleSigBuilder.createSignatureImage
(PDDocument template, BufferedImage image) void
PDFTemplateBuilder.createVisualSignature
(PDDocument template) just to create visible signaturevoid
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 PDDocumentModifierConstructorDescriptionPDVisibleSignDesigner
(PDDocument document, BufferedImage image, int page) Constructor.PDVisibleSignDesigner
(PDDocument document, InputStream imageStream, int page) Constructor. -
Uses of PDDocument in org.apache.pdfbox.pdmodel.interactive.form
Fields in org.apache.pdfbox.pdmodel.interactive.form declared as PDDocumentMethods in org.apache.pdfbox.pdmodel.interactive.form that return PDDocumentModifier and TypeMethodDescription(package private) PDDocument
PDAcroForm.getDocument()
This will get the document associated with this form.Constructors in org.apache.pdfbox.pdmodel.interactive.form with parameters of type PDDocumentModifierConstructorDescriptionPDAcroForm
(PDDocument doc) Constructor.PDAcroForm
(PDDocument doc, COSDictionary form) Constructor. -
Uses of PDDocument in org.apache.pdfbox.preflight
Subclasses of PDDocument in org.apache.pdfbox.preflight -
Uses of PDDocument in org.apache.pdfbox.preflight.metadata
Methods in org.apache.pdfbox.preflight.metadata with parameters of type PDDocumentModifier and TypeMethodDescriptionSynchronizedMetaDataValidation.validateMetadataSynchronization
(PDDocument document, XMPMetadata metadata) Check if document information entries and XMP information are synchronizedUniquePropertiesValidation.validatePropertiesUniqueness
(PDDocument document, XMPMetadata metadata) Checks that certain metadata properties are unique. -
Uses of PDDocument in org.apache.pdfbox.preflight.parser
Methods in org.apache.pdfbox.preflight.parser that return PDDocument -
Uses of PDDocument in org.apache.pdfbox.preflight.process
Methods in org.apache.pdfbox.preflight.process with parameters of type PDDocumentModifier and TypeMethodDescriptionprotected List<ValidationResult.ValidationError>
MetadataValidationProcess.checkStreamFilterUsage
(PDDocument doc) Check if metadata dictionary has no stream filterprotected COSDictionary
TrailerValidationProcess.getLinearizedDictionary
(PDDocument document) According to the PDF Reference, A linearized PDF contain a dictionary as first object (linearized dictionary) and only this one in the first section.private static InputStream
MetadataValidationProcess.getXpacket
(PDDocument document) Return the xpacket from the dictionary's stream -
Uses of PDDocument in org.apache.pdfbox.preflight.utils
Methods in org.apache.pdfbox.preflight.utils with parameters of type PDDocumentModifier and TypeMethodDescriptionstatic void
COSUtils.closeDocumentQuietly
(PDDocument document) Close the given Document. -
Uses of PDDocument in org.apache.pdfbox.printing
Fields in org.apache.pdfbox.printing declared as PDDocumentConstructors in org.apache.pdfbox.printing with parameters of type PDDocumentModifierConstructorDescriptionPDFPageable
(PDDocument document) Creates a new PDFPageable.PDFPageable
(PDDocument document, Orientation orientation) Creates a new PDFPageable with the given page orientation.PDFPageable
(PDDocument document, Orientation orientation, boolean showPageBorder) Creates a new PDFPageable with the given page orientation and with optional page borders shown.PDFPageable
(PDDocument document, Orientation orientation, boolean showPageBorder, float dpi) Creates a new PDFPageable with the given page orientation and with optional page borders shown.PDFPrintable
(PDDocument document) Creates a new PDFPrintable.PDFPrintable
(PDDocument document, Scaling scaling) Creates a new PDFPrintable with the given page scaling.PDFPrintable
(PDDocument document, Scaling scaling, boolean showPageBorder) Creates a new PDFPrintable with the given page scaling and with optional page borders shown.PDFPrintable
(PDDocument document, Scaling scaling, boolean showPageBorder, float dpi) Creates a new PDFPrintable with the given page scaling and with optional page borders shown.PDFPrintable
(PDDocument document, Scaling scaling, boolean showPageBorder, float dpi, boolean center) Creates a new PDFPrintable with the given page scaling and with optional page borders shown.PDFPrintable
(PDDocument document, Scaling scaling, boolean showPageBorder, float dpi, boolean center, PDFRenderer renderer) Creates a new PDFPrintable with the given page scaling and with optional page borders shown. -
Uses of PDDocument in org.apache.pdfbox.rendering
Fields in org.apache.pdfbox.rendering declared as PDDocumentConstructors in org.apache.pdfbox.rendering with parameters of type PDDocument -
Uses of PDDocument in org.apache.pdfbox.text
Fields in org.apache.pdfbox.text declared as PDDocumentMethods in org.apache.pdfbox.text with parameters of type PDDocumentModifier and TypeMethodDescriptionprotected void
PDFTextStripper.endDocument
(PDDocument document) This method is available for subclasses of this class.PDFTextStripper.getText
(PDDocument doc) This will return the text of a document.protected void
PDFTextStripper.startDocument
(PDDocument document) This method is available for subclasses of this class.void
PDFTextStripper.writeText
(PDDocument doc, Writer outputStream) This will take a PDDocument and write the text of that document to the print writer. -
Uses of PDDocument in org.apache.pdfbox.tools
Methods in org.apache.pdfbox.tools that return PDDocumentModifier and TypeMethodDescriptionTextToPDF.createPDFFromText
(Reader text) Create a PDF document with some text.Methods in org.apache.pdfbox.tools with parameters of type PDDocumentModifier and TypeMethodDescriptionprivate static void
PDFToImage.changeCropBox
(PDDocument document, float a, float b, float c, float d) 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.(package private) void
ImageToPDF.createPDFFromImages
(PDDocument doc, List<String> imageFilenames) void
TextToPDF.createPDFFromText
(PDDocument doc, Reader text) Create a PDF document with some text.void
PDFText2HTML.endDocument
(PDDocument document) This method is available for subclasses of this class.private void
ExtractText.extractPages
(int startPage, int endPage, PDFTextStripper stripper, PDDocument document, Writer output, boolean rotationMagic, boolean alwaysNext) 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.protected void
PDFText2HTML.startDocument
(PDDocument document) private static void
PDFSplit.writeDocument
(PDDocument doc, String fileName)
PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean)