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(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.
int	getCount() Gets the number of outlines in the 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.

Methods inherited from class java.lang.Object

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

Method Detail

getCount

public int getCount()

Gets the number of outlines in the list.

getOutline

public Outline getOutline(int index)

Gets the Outline object at the specified 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(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