Uses of Class org.apache.fop.pdf.PDFDocument (Apache FOP Core 2.11 API)
Date: 2025-04-24

## Uses of Class
org.apache.fop.pdf.PDFDocument

- Packages that use PDFDocument
  Package | Description
  --- | ---
  org.apache.fop.pdf | Classes for handling the low-level creation of PDF documents.
  org.apache.fop.pdf.xref |
  org.apache.fop.render.pdf | PDF Renderer
  org.apache.fop.svg | Classes that add SVG support to FOP and SVG->PDF conversion for Batik.

- - ### Uses of PDFDocument in org.apache.fop.pdf

    Methods in org.apache.fop.pdf that return PDFDocument
    Modifier and Type | Method and Description
    --- | ---
    `PDFDocument` | PDFObject.`getDocument()` Returns the parent PDFDocument if assigned.
    `PDFDocument` | PDFFactory.`getDocument()` Returns the parent PDFDocument associated with this factory.
    `PDFDocument` | PDFProfile.`getDocument()`
    `PDFDocument` | PDFObject.`getDocumentSafely()` Returns the parent PDFDocument, but unlike `getDocument()` it throws an informative Exception if the parent document is unavailable instead of having a NullPointerException somewhere without a message.

    Methods in org.apache.fop.pdf with parameters of type PDFDocument
    Modifier and Type | Method and Description
    --- | ---
    `void` | PDFResources.`addFonts(PDFDocument doc, FontInfo fontInfo)` Add the fonts in the font info to this PDF document's Font Resources.
    `static org.apache.xmlgraphics.xmp.Metadata` | PDFMetadata.`createXMPFromPDFDocument(PDFDocument pdfDoc)` Creates an XMP document based on the settings on the PDF Document.
    `static VersionController` | VersionController.`getDynamicVersionController(Version initialVersion, PDFDocument doc)` Returns a controller that allows subsequent changes to the document's version.
    `static PDFEncryption` | PDFEncryptionJCE.`make(PDFObjectNumber objectNumber, PDFEncryptionParams params, PDFDocument pdf)` Creates and returns an encryption object.
    `static PDFEncryption` | PDFEncryptionManager.`newInstance(PDFEncryptionParams params, PDFDocument pdf)` Creates a new PDFEncryption instance if PDF encryption is available.
    `void` | PDFObject.`setDocument(PDFDocument doc)` Sets the parent PDFDocument.
    `void` | PDFObjectNumber.`setDocument(PDFDocument doc)`
    `void` | AbstractPDFStream.`setDocument(PDFDocument doc)`
    `void` | PDFObject.`setObjectNumber(PDFDocument document)` Sets the object number
    `void` | PDFImage.`setup(PDFDocument doc)` Setup the PDF image for the current document.
    `void` | AlphaRasterImage.`setup(PDFDocument doc)` Setup the PDF image for the current document.
    `void` | BitmapImage.`setup(PDFDocument doc)` Setup this image with the pdf document.
    `static void` | PDFEncryptionManager.`setupPDFEncryption(PDFEncryptionParams params, PDFDocument pdf)` Sets up PDF encryption if PDF encryption is requested by registering a `PDFEncryptionParams` object with the user agent and if the necessary cryptographic support is available.
    `static PDFICCBasedColorSpace` | PDFICCBasedColorSpace.`setupsRGBAsDefaultRGBColorSpace(PDFDocument pdfDoc)` Sets sRGB as the DefaultRGB color space in the PDF document.
    `static PDFICCStream` | PDFICCBasedColorSpace.`setupsRGBColorProfile(PDFDocument pdfDoc)` Sets up the sRGB color profile in the PDF document.
    `static PDFICCBasedColorSpace` | PDFICCBasedColorSpace.`setupsRGBColorSpace(PDFDocument pdfDoc)` Installs the sRGB color space in the PDF document.

    Constructors in org.apache.fop.pdf with parameters of type PDFDocument
    Constructor and Description
    `PDFDPartRoot(PDFDocument document)`
    `PDFFactory(PDFDocument document)` Creates a new PDFFactory.
    `PDFLinearization(PDFDocument doc)`
    `PDFPages(PDFDocument document)` create a /Pages object.
    `PDFProfile(PDFDocument doc)` Main constructor
    `PDFResources(PDFDocument doc)` create a /Resources object.
    `PDFRoot(PDFDocument document, PDFPages pages)` create a Root (/Catalog) object.

  - ### Uses of PDFDocument in org.apache.fop.pdf.xref

    Constructors in org.apache.fop.pdf.xref with parameters of type PDFDocument
    Constructor and Description
    `CrossReferenceStream(PDFDocument document, int objectNumber, TrailerDictionary trailerDictionary, long startxref, List<Long> uncompressedObjectReferences, List<CompressedObjectReference> compressedObjectReferences)`
    `CrossReferenceStream(PDFDocument document, TrailerDictionary trailerDictionary, long startxref, List<Long> uncompressedObjectReferences, List<CompressedObjectReference> compressedObjectReferences)`
    `TrailerDictionary(PDFDocument pdfDocument)`

  - ### Uses of PDFDocument in org.apache.fop.render.pdf

    Fields in org.apache.fop.render.pdf declared as PDFDocument
    Modifier and Type | Field and Description
    --- | ---
    `PDFDocument` | PDFSVGHandler.PDFInfo.`pdfDoc` see PDF_DOCUMENT

    Methods in org.apache.fop.render.pdf that return PDFDocument
    Modifier and Type | Method and Description
    --- | ---
    `PDFDocument` | PDFContentGenerator.`getDocument()` Returns the applicable resource context for the generator.

    Methods in org.apache.fop.render.pdf with parameters of type PDFDocument
    Modifier and Type | Method and Description
    --- | ---
    `void` | AbstractImageAdapter.`setup(PDFDocument doc)` Setup the PDF image for the current document.
    `void` | ImageRawJPEGAdapter.`setup(PDFDocument doc)` Setup the PDF image for the current document.
    `void` | ImageRenderedAdapter.`setup(PDFDocument doc)` Setup the PDF image for the current document.
    `void` | ImageRawCCITTFaxAdapter.`setup(PDFDocument doc)` Setup the PDF image for the current document.
    `void` | ImageRawPNGAdapter.`setup(PDFDocument doc)` Setup the PDF image for the current document.

    Constructors in org.apache.fop.render.pdf with parameters of type PDFDocument
    Constructor and Description
    `PDFContentGenerator(PDFDocument document, OutputStream out, PDFResourceContext resourceContext)` Main constructor.
    `PDFContentGenerator(PDFDocument document, OutputStream out, PDFResourceContext resourceContext, IFContext context)`

  - ### Uses of PDFDocument in org.apache.fop.svg

    Fields in org.apache.fop.svg declared as PDFDocument
    Modifier and Type | Field and Description
    --- | ---
    `protected PDFDocument` | PDFGraphics2D.`pdfDoc` the PDF Document being created

    Methods in org.apache.fop.svg that return PDFDocument
    Modifier and Type | Method and Description
    --- | ---
    `PDFDocument` | PDFDocumentGraphics2D.`getPDFDocument()` Get the pdf document created by this class.

    Constructors in org.apache.fop.svg with parameters of type PDFDocument
    Constructor and Description
    `PDFGraphics2D(boolean textAsShapes, FontInfo fi, PDFDocument doc, PDFResourceContext page, PDFReference pref, String font, float size, PDFGraphics2D.TransparencyIgnoredEventListener listener)` Create a new PDFGraphics2D with the given pdf document info.

Copyright © 2025 Apache Software Foundation. All rights reserved.