com.crionics.jpdf.outline
Class Outline

java.lang.Object
  PdfObjectContainer
      com.crionics.jpdf.outline.Outline

public class Outline
extends PdfObjectContainer

This object allows the creation of an outline prior to its insertion in a document.

Method Summary

void	addItem(AbstractOutlineItem item) Adds an Item and all its tree to the current tree present in this outline.
AbstractOutlineItem	getItemFromTitle(java.lang.String title) Returns the first Outline item with the requested title
AbstractOutlineItem	getRootItem() Returns the first Item present in this outline.

Methods inherited from class java.lang.Object

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

Method Detail

addItem

public void addItem(AbstractOutlineItem item)
             throws PdfException,
                    java.io.IOException

Adds an Item and all its tree to the current tree present in this outline.

Parameters:

item -

Throws:

PdfException - If a problem occured while parsing the document.

java.io.IOException - If a problem occured while parsing the file.

getItemFromTitle

public AbstractOutlineItem getItemFromTitle(java.lang.String title)
                                     throws PdfException,
                                            java.io.IOException

Returns the first Outline item with the requested title

Parameters:

title - The title to search for

Returns:

the outline item or null if none were detected.

Throws:

PdfException - If a problem occured while parsing the document.

java.io.IOException - If a problem occured while parsing the file.

getRootItem

public AbstractOutlineItem getRootItem()
                                throws PdfException,
                                       java.io.IOException

Returns the first Item present in this outline.

Returns:

The First Item of the Outline.

Throws:

PdfException - If a problem occured while parsing the document.

java.io.IOException - If a problem occured while parsing the file.