org.apache.fop.pdf

Class PDFOutline

Implemented Interfaces:
PDFWritable

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
Author:
Kelly A. Campbell

Field Summary

Fields inherited from class org.apache.fop.pdf.PDFObject

DATE_FORMAT, log

Constructor Summary

PDFOutline(String title, 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(String t)
Set the title of this Outline object.
protected byte[]
toPDF()

Methods inherited from class org.apache.fop.pdf.PDFObject

encode, encodeString, encodeText, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, hasObjectNumber, makeReference, output, referencePDF, setDocument, setObjectNumber, toInlinePDFString, toPDF, toPDFString

Constructor Details

PDFOutline

public PDFOutline(String title,
                  String action,
                  boolean openItem)
Create a PDF outline with the title and action.
Parameters:
title - the title of the outline entry (can only be null for root Outlines obj)
action - the action for this outline
openItem - indicator of whether child items are visible or not

Method Details

addOutline

public void addOutline(PDFOutline outline)
Add a sub element to this outline.
Parameters:
outline - a sub outline

setTitle

public void setTitle(String t)
Set the title of this Outline object.
Parameters:
t - the title of the outline

toPDF

protected byte[] toPDF()
Overrides:
toPDF in interface PDFObject

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.