com.spire.pdf.bookmarks
Class PdfBookmarkCollection

java.lang.Object
  com.spire.pdf.bookmarks.PdfBookmarkCollection

All Implemented Interfaces:

com.spire.ms.System.Collections.IEnumerable, IPdfWrapper, java.lang.Iterable

Direct Known Subclasses:

PdfBookmark

public class PdfBookmarkCollection
extends java.lang.Object
implements IPdfWrapper, com.spire.ms.System.Collections.IEnumerable

This class plays two roles: it's a base class for all bookmarks and it's a root of a bookmarks tree.

Constructor Summary

PdfBookmarkCollection()

PdfBookmarkCollection(PdfDictionary dictionary, PdfCrossTable crossTable)

Method Summary

PdfBookmark	add(java.lang.String title) Creates and adds an outline.
void	clear() Removes all the bookmark from the document.
boolean	contains(PdfBookmark outline) Determines whether the specified outline is a direct descendant of the outline base.
PdfBookmark	get(int index) Gets the at the specified index.
int	getCount() Gets number of the elements in the collection.
PdfBookmark	insert(int index, java.lang.String title) Inserts a new outline at the specified index.
void	remove(java.lang.String title) Removes the specified bookmark from the document.
void	removeAt(int index) Removes the specified bookmark from the document at the specified index.

Constructor Detail

PdfBookmarkCollection

public PdfBookmarkCollection()

PdfBookmarkCollection

public PdfBookmarkCollection(PdfDictionary dictionary,
                             PdfCrossTable crossTable)

Method Detail

getCount

public int getCount()

Gets number of the elements in the collection.

get

public PdfBookmark get(int index)

Gets the at the specified index.

add

public PdfBookmark add(java.lang.String title)

Creates and adds an outline.

Parameters:

title - The title of the new outline.

Returns:

The outline created.

contains

public boolean contains(PdfBookmark outline)

Determines whether the specified outline is a direct descendant of the outline base.

Parameters:

outline - The outline. true if the specified outline is a direct descendant of the outline base; otherwise, false.

remove

public void remove(java.lang.String title)

Removes the specified bookmark from the document.

Parameters:

title - The title of the outline.

removeAt

public void removeAt(int index)

Removes the specified bookmark from the document at the specified index.

Parameters:

index - The index.

clear

public void clear()

Removes all the bookmark from the document.

insert

public PdfBookmark insert(int index,
                          java.lang.String title)

Inserts a new outline at the specified index.

Parameters:

index - The index.

title - The title of the new outline.

Returns:

The new outline.