com.itextpdf.kernel.pdf

Class PdfOutline

java.lang.Object

com.itextpdf.kernel.pdf.PdfOutline

All Implemented Interfaces:

Serializable

public class PdfOutline
extends Object
implements Serializable

Document outline object See ISO-320001, 12.3.3 Document Outline.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_BOLD A flag for displaying the outline item’s text with bold font.
static int	FLAG_ITALIC A flag for displaying the outline item’s text with italic font.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PdfOutline(PdfDocument doc) Deprecated. Use PdfCatalog.getOutlines(boolean) instead.
	PdfOutline(String title, PdfDictionary content, PdfDocument pdfDocument) Deprecated. Use PdfCatalog.getOutlines(boolean) instead.
	PdfOutline(String title, PdfDictionary content, PdfOutline parent) Deprecated. Use PdfCatalog.getNextItem(PdfDictionary, PdfOutline, Map), addOutline(String, int) and addOutline(String) instead.

Method Summary

Modifier and Type	Method and Description
void	addAction(PdfAction action) Adds PdfAction for the outline, A key.
void	addDestination(PdfDestination destination) Adds PdfDestination for the outline, Dest key.
PdfOutline	addOutline(PdfOutline outline) Adds an PdfOutline as a child to existing PdfOutline and put it to the end of the existing PdfOutline children list.
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 a new PdfOutline with specified parameters as a child to existing PdfOutline and put it to specified position in the existing PdfOutline children list.
List<PdfOutline>	getAllChildren() Gets list of children outlines.
PdfDictionary	getContent() Gets content dictionary.
PdfDestination	getDestination() Gets PdfDestination.
PdfOutline	getParent() Gets parent outline.
String	getTitle() Gets title of the outline.
void	setColor(Color color) Sets color for the outline entry’s text, C key.
void	setOpen(boolean open) Defines if the outline needs to be closed or not.
void	setStyle(int style) Sets text style for the outline entry’s text, F key.
void	setTitle(String title) Sets title of the outline with PdfEncodings.UNICODE_BIG encoding, Title key.

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

A flag for displaying the outline item’s text with italic font.

FLAG_BOLD

public static int FLAG_BOLD

A flag for displaying the outline item’s text with bold font.

Constructor Detail

PdfOutline

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

Deprecated. Use PdfCatalog.getOutlines(boolean) instead.

Create instance of document outline.

Parameters:

title - the text that shall be displayed on the screen for this item.

content - Outline dictionary

pdfDocument - PdfDocument the outline belongs to.

PdfOutline

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

Deprecated. Use PdfCatalog.getNextItem(PdfDictionary, PdfOutline, Map), addOutline(String, int) and addOutline(String) instead.

Create instance of document outline.

Parameters:

title - the text that shall be displayed on the screen for this item.

content - Outline dictionary

parent - parent outline.

PdfOutline

@Deprecated
protected PdfOutline(PdfDocument doc)

Deprecated. Use PdfCatalog.getOutlines(boolean) instead.

This constructor creates root outline in the document.

Parameters:

doc - PdfDocument

Method Detail

getTitle

public String getTitle()

Gets title of the outline.

Returns:

String value.

setTitle

public void setTitle(String title)

Sets title of the outline with PdfEncodings.UNICODE_BIG encoding, Title key.

Parameters:

title - String value.

setColor

public void setColor(Color color)

Sets color for the outline entry’s text, C key.

Parameters:

color - Color

setStyle

public void setStyle(int style)

Sets text style for the outline entry’s text, F key.

Parameters:

style - Could be either FLAG_BOLD or FLAG_ITALIC. Default value is 0.

getContent

public PdfDictionary getContent()

Gets content dictionary.

Returns:

PdfDictionary.

getAllChildren

public List<PdfOutline> getAllChildren()

Gets list of children outlines.

Returns:

List of PdfOutline.

getParent

public PdfOutline getParent()

Gets parent outline.

Returns:

PdfOutline.

getDestination

public PdfDestination getDestination()

Gets PdfDestination.

Returns:

PdfDestination.

addDestination

public void addDestination(PdfDestination destination)

Adds PdfDestination for the outline, Dest key.

Parameters:

destination - instance of PdfDestination.

addAction

public void addAction(PdfAction action)

Adds PdfAction for the outline, A key.

Parameters:

action - instance of PdfAction.

setOpen

public void setOpen(boolean open)

Defines if the outline needs to be closed or not. By default, outlines are open.

Parameters:

open - if false, the outline will be closed by default

addOutline

public PdfOutline addOutline(String title,
                             int position)

Adds a new PdfOutline with specified parameters 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:

just created outline

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:

just created outline

addOutline

public PdfOutline addOutline(PdfOutline outline)

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

Parameters:

outline - an outline to add.

Returns:

just created outline