com.cete.dynamicpdf
Class OutlineList

java.lang.Object
  com.cete.dynamicpdf.OutlineList

public class OutlineList
extends java.lang.Object

Represents a collection of outlines. See the Outlines and Bookmarks topic for more on Outlines.

Licensing:
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Professional Edition
• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

View Example

Method Summary

Outline	add(PdfOutline outline) Adds an imported outline along with its children to the outline list.
Outline	add(PdfOutline outline, boolean addChildOutline) Adds an imported outline to the outline list.
void	add(PdfOutlineList outlines) Adds all outlines from an imported outline list to the outline list.
Outline	add(java.lang.String text) Adds an Outline object to the outline list.
Outline	add(java.lang.String text, Action action) Adds an Outline object to the outline list.
java.util.Iterator	getEnumerator() Returns an enumerator that can iterate through the OutlineList.
Outline	getOutline(int index) Gets the Outline object at the specified index.
int	size() Gets the number of outlines in the list.

Methods inherited from class java.lang.Object

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

Method Detail

size

public int size()

Gets the number of outlines in the list.

Returns:

the number of outlines in the list.

getOutline

public Outline getOutline(int index)

Gets the Outline object at the specified index.

Parameters:

index - the index of the outline.

Returns:

the outline related to the index.

add

public Outline add(java.lang.String text,
                   Action action)

Adds an Outline object to the outline list.

Parameters:

text - Text of the outline.

action - Action or destination of the outline.

Returns:

The Outline object that is created.

See Also:

Outline

add

public Outline add(PdfOutline outline)

Adds an imported outline along with its children to the outline list. Use the overloaded method with a the addChildOutline parameter set to false if you do not want to add the child outlines.

Parameters:

outline - Imported outline to add.

Returns:

The Outline object that is created.

Licensing:
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

add

public Outline add(PdfOutline outline,
                   boolean addChildOutline)

Adds an imported outline to the outline list.

Parameters:

outline - Imported outline to add.

addChildOutline - Specifies if the child outlines should be added as well.

Returns:

The Outline object that is created.

Licensing:
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

add

public void add(PdfOutlineList outlines)

Adds all outlines from an imported outline list to the outline list.

Parameters:

outlines - Imported outline list to add.

Licensing:
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

add

public Outline add(java.lang.String text)

Adds an Outline object to the outline list.

Parameters:

text - Text of the outline.

Returns:

The Outline object that is created.

See Also:

Outline

getEnumerator

public java.util.Iterator getEnumerator()

Returns an enumerator that can iterate through the OutlineList.

Returns:

An Iterator for the entire OutlineList