public class PDFOutline extends PDFObject
This represents a single Outline object in a PDF, including the root Outlines object. Outlines provide the bookmark bar, usually rendered to the right of a PDF document in user agents such as Acrobat Reader.
This work was authored by Kelly A. Campbell.
Constructor and Description |
---|
PDFOutline(String title,
PDFReference action,
boolean openItem)
Create a PDF outline with the title and action.
|
Modifier and Type | Method and Description |
---|---|
void |
addOutline(PDFOutline outline)
Add a sub element to this outline.
|
void |
getChildren(Set<PDFObject> children) |
void |
setTitle(String t)
Set the title of this Outline object.
|
protected byte[] |
toPDF()
Encodes the object as a byte array for output to a PDF file.
|
contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, output, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, supportsObjectStream, toPDFString
public PDFOutline(String title, PDFReference action, boolean openItem)
title
- the title of the outline entry (can only be null for root Outlines obj)action
- the action for this outlineopenItem
- indicator of whether child items are visible or notpublic void setTitle(String t)
t
- the title of the outlinepublic void addOutline(PDFOutline outline)
outline
- a sub outlineprotected byte[] toPDF()
public void getChildren(Set<PDFObject> children)
getChildren
in class PDFObject
Copyright © 2025 Apache Software Foundation. All rights reserved.