|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.fop.pdf.PDFObject
org.apache.fop.pdf.PDFOutline
public class PDFOutline
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.
| Field Summary |
|---|
| Fields inherited from class org.apache.fop.pdf.PDFObject |
|---|
log |
| Constructor Summary | |
|---|---|
PDFOutline(java.lang.String title,
java.lang.String action,
boolean openItem)
Create a PDF outline with the title and action. |
|
| Method Summary | |
|---|---|
void |
addOutline(PDFOutline outline)
Add a sub element to this outline. |
void |
setTitle(java.lang.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. |
| Methods inherited from class org.apache.fop.pdf.PDFObject |
|---|
contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, output, outputInline, referencePDF, setDocument, setObjectNumber, setParent, toPDFString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public PDFOutline(java.lang.String title,
java.lang.String 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 not| Method Detail |
|---|
public void setTitle(java.lang.String t)
t - the title of the outlinepublic void addOutline(PDFOutline outline)
outline - a sub outlineprotected byte[] toPDF()
toPDF in class PDFObject
|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||