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

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

- Packages that use PDFOutline
  Package | Description
  --- | ---
  org.apache.fop.pdf | Classes for handling the low-level creation of PDF documents.

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

    Methods in org.apache.fop.pdf that return PDFOutline
    Modifier and Type | Method and Description
    --- | ---
    `PDFOutline` | PDFDocument.`getOutlineRoot()` Get the root Outlines object.
    `PDFOutline` | PDFRoot.`getRootOutline()` Get the root PDF outline for the document.
    `PDFOutline` | PDFFactory.`makeOutline(PDFOutline parent, String label, PDFAction pdfAction, boolean showSubItems)` Make an outline object and add it to the given parent
    `PDFOutline` | PDFFactory.`makeOutline(PDFOutline parent, String label, PDFReference actionRef, boolean showSubItems)` Make an outline object and add it to the given parent
    `PDFOutline` | PDFFactory.`makeOutline(PDFOutline parent, String label, String destination, float yoffset, boolean showSubItems)` Make an outline object and add it to the given outline

    Methods in org.apache.fop.pdf with parameters of type PDFOutline
    Modifier and Type | Method and Description
    --- | ---
    `void` | PDFOutline.`addOutline(PDFOutline outline)` Add a sub element to this outline.
    `PDFOutline` | PDFFactory.`makeOutline(PDFOutline parent, String label, PDFAction pdfAction, boolean showSubItems)` Make an outline object and add it to the given parent
    `PDFOutline` | PDFFactory.`makeOutline(PDFOutline parent, String label, PDFReference actionRef, boolean showSubItems)` Make an outline object and add it to the given parent
    `PDFOutline` | PDFFactory.`makeOutline(PDFOutline parent, String label, String destination, float yoffset, boolean showSubItems)` Make an outline object and add it to the given outline
    `void` | PDFRoot.`setRootOutline(PDFOutline out)` Set the root outline for the PDF document.

Copyright © 2025 Apache Software Foundation. All rights reserved.