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

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

- Packages that use PDFReference
  Package | Description
  --- | ---
  org.apache.fop.pdf | Classes for handling the low-level creation of PDF documents.
  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 PDFReference in org.apache.fop.pdf

    Fields in org.apache.fop.pdf with type parameters of type PDFReference
    Modifier and Type | Field and Description
    --- | ---
    `protected Map<String,PDFReference>` | PDFResources.`properties` Named properties

    Methods in org.apache.fop.pdf that return PDFReference
    Modifier and Type | Method and Description
    --- | ---
    `PDFReference` | PDFResources.`getProperty(String name)` Get a named property.
    `PDFReference` | PDFImage.`getSoftMaskReference()` Get the PDF reference for a soft mask.
    `PDFReference` | AlphaRasterImage.`getSoftMaskReference()` Get the PDF reference for a soft mask.
    `PDFReference` | BitmapImage.`getSoftMaskReference()` Get the PDF reference for a soft mask.
    `PDFReference` | PDFSeparationColorSpace.`getTintFunction()` Returns a reference to the tint function that is used as a fallback if the colorant is not available.
    `PDFReference` | PDFObject.`makeReference()` Creates and returns a reference to this object.
    `PDFReference` | PDFDocument.`resolveExtensionReference(String id)`

    Methods in org.apache.fop.pdf with parameters of type PDFReference
    Modifier and Type | Method and Description
    --- | ---
    `PDFFormXObject` | PDFDocument.`addFormXObject(PDFResourceContext res, PDFStream cont, PDFReference formres, String key)` Add a form XObject to the PDF document.
    `void` | PDFResources.`addProperty(String name, PDFReference property)` Add a named property.
    `PDFOutline` | PDFFactory.`makeOutline(PDFOutline parent, String label, PDFReference actionRef, boolean showSubItems)` Make an outline object and add it to the given parent
    `void` | PDFPage.`setContents(PDFReference contents)` set this page contents
    `void` | PDFGoTo.`setPageReference(PDFReference pageReference)` Sets page reference after object has been created

    Constructors in org.apache.fop.pdf with parameters of type PDFReference
    Constructor and Description
    `BitmapImage(String k, int width, int height, byte[] data, PDFReference mask)` Create a bitmap image.
    `PDFFormXObject(int xnumber, PDFStream contents, PDFReference resources)` create a FormXObject with the given number and name and load the image in the object
    `PDFGoToRemote(PDFReference pdfFileSpec, int page, boolean newWindow)` Create an GoToR object.
    `PDFLaunch(PDFReference fileSpec)` Creates a new /Launch action.
    `PDFOutline(String title, PDFReference action, boolean openItem)` Create a PDF outline with the title and action.

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

    Methods in org.apache.fop.render.pdf that return PDFReference
    Modifier and Type | Method and Description
    --- | ---
    `PDFReference` | AbstractImageAdapter.`getSoftMaskReference()` Get the PDF reference for a soft mask.
    `PDFReference` | ImageRenderedAdapter.`getSoftMaskReference()` Get the PDF reference for a soft mask.
    `PDFReference` | ImageRawPNGAdapter.`getSoftMaskReference()` Get the PDF reference for a soft mask.

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

    Fields in org.apache.fop.svg declared as PDFReference
    Modifier and Type | Field and Description
    --- | ---
    `protected PDFReference` | PDFGraphics2D.`pageRef` The PDF reference of the current page.

    Methods in org.apache.fop.svg that return PDFReference
    Modifier and Type | Method and Description
    --- | ---
    `PDFReference` | PDFGraphics2D.`getPageReference()` Gets the PDF reference of the current page.

    Constructors in org.apache.fop.svg with parameters of type PDFReference
    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.