| java.lang.Object
 gnu.jpdf.PDFObject
gnu.jpdf.PDFOutline
| PDFOutline | | public class PDFOutline extends PDFObject implements Serializable(Code) | | This class manages the documents outlines (also known as bookmarks).
author:
Peter T Mount http://www.retep.org.uk/pdf/
author:
Eric Z. Beard, ericzbeard@hotmail.com
author:
$Author: ezb $
version:
$Revision: 1.1.1.1 $, $Date: 2001/10/29 19:51:08 $ |
| Method Summary | |
| 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. | | 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. | | 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. | | protected int | descendants()
Returns the total number of descendants below this one. | | public Enumeration | elements()
Returns all outlines directly below this one. | | protected int | getIndex(PDFOutline outline)
This is called by children to find their position in this outlines
tree. | | protected int | getLast()
| | protected PDFOutline | getNode(int i)
Returns the outline at a specified position. | | public void | write(OutputStream os)
|
| FITPAGE | | final static boolean FITPAGE(Code) | | When jumping to the destination, display the whole page
|
| FITRECT | | final static boolean FITRECT(Code) | | When jumping to the destination, display the specified region
|
| destMode | | boolean destMode(Code) | | How the destination is handled
|
| lbrt | | int lbrt(Code) | | The region on the destination page
|
| parent | | protected PDFOutline parent(Code) | | For subentries, this points to it's parent outline
|
| PDFOutline | | protected PDFOutline()(Code) | | Constructs a PDF Outline object. This method is used internally only.
|
| PDFOutline | | public PDFOutline(String title, PDFPage dest)(Code) | | Constructs a PDF Outline object. When selected, the whole page is
displayed.
Parameters:
title - Title of the outline
Parameters:
dest - The destination page |
| PDFOutline | | public PDFOutline(String title, PDFPage dest, int l, int b, int r, int t)(Code) | | Constructs a PDF Outline object. When selected, the specified region
is displayed.
Parameters:
title - Title of the outline
Parameters:
dest - The destination page
Parameters:
l - left coordinate
Parameters:
b - bottom coordinate
Parameters:
r - right coordinate
Parameters:
t - top coordinate |
| add | | public PDFOutline add(String title, PDFPage dest)(Code) | | 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
Parameters:
dest - The destination page PDFOutline object created, for creating sub-outlines |
| add | | public PDFOutline add(String title, PDFPage dest, int x, int y, int w, int h)(Code) | | 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
Parameters:
dest - The destination page
Parameters:
x - coordinate of region in Java space
Parameters:
y - coordinate of region in Java space
Parameters:
w - width of region in Java space
Parameters:
h - height of region in Java space PDFOutline object created, for creating sub-outlines |
| add | | public void add(PDFOutline outline)(Code) | | 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:
page - PDFOutline to add |
| descendants | | protected int descendants()(Code) | | Returns the total number of descendants below this one.
the number of descendants below this one |
| elements | | public Enumeration elements()(Code) | | Returns all outlines directly below this one.
Enumeration of child elements |
| getIndex | | protected int getIndex(PDFOutline outline)(Code) | | This is called by children to find their position in this outlines
tree.
Parameters:
outline - PDFOutline to search for index within Vector |
| getLast | | protected int getLast()(Code) | | Returns the last index in this outline
last index in outline |
| getNode | | protected PDFOutline getNode(int i)(Code) | | Returns the outline at a specified position.
Parameters:
i - index the node at index i |
|
|