gnu.apdf

Class PDFOutline

java.lang.Object

gnu.apdf.PDFObject

gnu.apdf.PDFOutline

All Implemented Interfaces:

Serializable

public class PDFOutline
extends PDFObject
implements Serializable

This class manages the documents outlines (also known as bookmarks).

Author:

Peter T Mount http://www.retep.org.uk/pdf/, Eric Z. Beard, ericzbeard@hotmail.com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PDFOutline(String title, PDFPage dest) Constructs a PDF Outline object.
PDFOutline(String title, PDFPage dest, int l, int b, int r, int t) Constructs a PDF Outline object.

Method Summary

Modifier and Type	Method and Description
void	add(PDFOutline outline) This adds an already existing outline to this one.
PDFOutline	add(String title, PDFPage dest) This method creates an outline, and attaches it to this one.
PDFOutline	add(String title, PDFPage dest, int x, int y, int w, int h) This method creates an outline, and attaches it to this one.
Enumeration<PDFOutline>	elements() Returns all outlines directly below this one.
void	write(OutputStream os) Writes the object to the output stream.

Methods inherited from class gnu.apdf.PDFObject

getGeneration, getName, getPDFDocument, getSerialID, getType, setName, toArray, toString, writeEnd, writeStart

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PDFOutline

public PDFOutline(String title,
                  PDFPage dest)

Constructs a PDF Outline object. When selected, the whole page is displayed.

Parameters:

title - Title of the outline

dest - The destination page

PDFOutline

public PDFOutline(String title,
                  PDFPage dest,
                  int l,
                  int b,
                  int r,
                  int t)

Constructs a PDF Outline object. When selected, the specified region is displayed.

Parameters:

title - Title of the outline

dest - The destination page

l - left coordinate

b - bottom coordinate

r - right coordinate

t - top coordinate

Method Detail

add

public PDFOutline add(String title,
                      PDFPage dest)

This method creates an outline, and attaches it to this one. When the outline is selected, the entire page is displayed.

This allows you to have an outline for say a Chapter, then under the chapter, one for each section. You are not really limited on how deep you go, but it's best not to go below say 6 levels, for the reader's sake.

Parameters:

title - Title of the outline

dest - The destination page

Returns:

PDFOutline object created, for creating sub-outlines

add

public PDFOutline add(String title,
                      PDFPage dest,
                      int x,
                      int y,
                      int w,
                      int h)

This method creates an outline, and attaches it to this one. When the outline is selected, the supplied region is displayed.

Note: the coordiates are in Java space. They are converted to User space.

This allows you to have an outline for say a Chapter, then under the chapter, one for each section. You are not really limited on how deep you go, but it's best not to go below say 6 levels, for the reader's sake.

Parameters:

title - Title of the outline

dest - The destination page

x - coordinate of region in Java space

y - coordinate of region in Java space

w - width of region in Java space

h - height of region in Java space

Returns:

PDFOutline object created, for creating sub-outlines

add

public void add(PDFOutline outline)

This adds an already existing outline to this one.

Note: the outline must have been added to the PDF document before calling this method. Normally the other add methods are used.

Parameters:

outline - PDFOutline to add

write

public void write(OutputStream os)
           throws IOException

Description copied from class: PDFObject

Writes the object to the output stream. This method must be overidden.

Note: It should not write any other objects, even if they are it's Kids, as they will be written by the calling routine.

Specified by:

write in class PDFObject

Parameters:

os - OutputStream to send the object to

Throws:

IOException - on error

elements

public Enumeration<PDFOutline> elements()

Returns all outlines directly below this one.

Returns:

Enumeration of child elements