Package org.apache.fop.pdf

Class PDFOutline

java.lang.Object

org.apache.fop.pdf.PDFObject

org.apache.fop.pdf.PDFOutline

All Implemented Interfaces:

CompressedObject, 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.

This work was authored by Kelly A. Campbell.

Field Summary

Fields

Modifier and Type	Field	Description
private PDFReference	actionRef
private int	count
private PDFOutline	first
private PDFOutline	last
private PDFOutline	next
private boolean	openItem
private PDFOutline	parent	parent outline object.
private PDFOutline	prev
private java.util.List	subentries	list of sub-entries (outline objects)
private java.lang.String	title	title to display for the bookmark entry

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

log

Constructor Summary

Constructors

Constructor	Description
PDFOutline(java.lang.String title, PDFReference action, boolean openItem)	Create a PDF outline with the title and action.

Method Summary

Modifier and Type	Method	Description
void	addOutline(PDFOutline outline)	Add a sub element to this outline.
void	getChildren(java.util.Set<PDFObject> children)
private void	incrementCount()	Increment the number of subentries and descendants.
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, setObjectNumber, setObjectNumber, setParent, supportsObjectStream, toPDFString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

subentries

private java.util.List subentries

list of sub-entries (outline objects)

parent

private PDFOutline parent

parent outline object. Root Outlines parent is null

prev

private PDFOutline prev

next

private PDFOutline next

first

private PDFOutline first

last

private PDFOutline last

count

private int count

openItem

private boolean openItem

title

private java.lang.String title

title to display for the bookmark entry

actionRef

private PDFReference actionRef

Constructor Detail

PDFOutline

public PDFOutline(java.lang.String title,
                  PDFReference 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 Detail

setTitle

public void setTitle(java.lang.String t)

Set the title of this Outline object.

Parameters:

t - the title of the outline

addOutline

public void addOutline(PDFOutline outline)

Add a sub element to this outline.

Parameters:

outline - a sub outline

incrementCount

private void incrementCount()

Increment the number of subentries and descendants.

toPDF

protected byte[] toPDF()

Encodes the object as a byte array for output to a PDF file.

Overrides:

toPDF in class PDFObject

Returns:

PDF string

getChildren

public void getChildren(java.util.Set<PDFObject> children)

Overrides:

getChildren in class PDFObject