com.itextpdf.kernel.pdf

Class PdfOutline

java.lang.Object

com.itextpdf.kernel.pdf.PdfOutline

public class PdfOutline
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_BOLD
static int	FLAG_ITALIC

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PdfOutline(PdfDocument doc) This constructor creates root outline in the document.
	PdfOutline(String title, PdfDictionary content, PdfDocument pdfDocument)
	PdfOutline(String title, PdfDictionary content, PdfOutline parent)

Method Summary

Modifier and Type	Method and Description
void	addAction(PdfAction action)
void	addDestination(PdfDestination destination)
PdfOutline	addOutline(PdfOutline outline)
PdfOutline	addOutline(String title) Adds an PdfOutline as a child to existing PdfOutline and put it in the end of the existing PdfOutline children list
PdfOutline	addOutline(String title, int position) Adds an PdfOutline as a child to existing PdfOutline and put it to specified position in the existing PdfOutline children list
List<PdfOutline>	getAllChildren()
PdfDictionary	getContent()
PdfDestination	getDestination()
PdfOutline	getParent()
String	getTitle()
void	setColor(Color color)
void	setStyle(int style)
void	setTitle(String title)

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_ITALIC

public static int FLAG_ITALIC

FLAG_BOLD

public static int FLAG_BOLD

Constructor Detail

PdfOutline

public PdfOutline(String title,
                  PdfDictionary content,
                  PdfDocument pdfDocument)

PdfOutline

public PdfOutline(String title,
                  PdfDictionary content,
                  PdfOutline parent)

PdfOutline

protected PdfOutline(PdfDocument doc)

This constructor creates root outline in the document.

Parameters:

doc -

Throws:

PdfException

Method Detail

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

setColor

public void setColor(Color color)

setStyle

public void setStyle(int style)

getContent

public PdfDictionary getContent()

getAllChildren

public List<PdfOutline> getAllChildren()

getParent

public PdfOutline getParent()

getDestination

public PdfDestination getDestination()

addDestination

public void addDestination(PdfDestination destination)

addAction

public void addAction(PdfAction action)

addOutline

public PdfOutline addOutline(String title)

Adds an PdfOutline as a child to existing PdfOutline and put it in the end of the existing PdfOutline children list

Parameters:

title - an outline title

Returns:

a created outline

Throws:

PdfException

addOutline

public PdfOutline addOutline(String title,
                             int position)

Adds an PdfOutline as a child to existing PdfOutline and put it to specified position in the existing PdfOutline children list

Parameters:

title - an outline title

position - a position in the current outline child List where a new outline should be added. If the position equals -1, then the outline will be put in the end of children list.

Returns:

created outline

Throws:

PdfException

addOutline

public PdfOutline addOutline(PdfOutline outline)