org.pdfclown.documents.interaction.navigation.document
Class Bookmarks

java.lang.Object
  org.pdfclown.objects.PdfObjectWrapper<PdfDictionary>
      org.pdfclown.documents.interaction.navigation.document.Bookmarks

All Implemented Interfaces:

Cloneable, Iterable<Bookmark>, Collection<Bookmark>, List<Bookmark>, IPdfObjectWrapper

@PDF(value=PDF10)
public final class Bookmarks
extends PdfObjectWrapper<PdfDictionary>
implements List<Bookmark>

Collection of bookmarks [PDF:1.6:8.2.2].

Version:

0.1.2, 12/28/12

Author:

Stefano Chizzolini (http://www.stefanochizzolini.it)

Constructor Summary

Bookmarks(Document context)

Method Summary

boolean	add(Bookmark bookmark)
void	add(int index, Bookmark bookmark)
boolean	addAll(Collection<? extends Bookmark> bookmarks)
boolean	addAll(int index, Collection<? extends Bookmark> bookmarks)
void	clear()
Bookmarks	clone(Document context) Gets a clone of the object, registered inside the given document context.
boolean	contains(Object bookmark)
boolean	containsAll(Collection<?> bookmarks)
protected PdfInteger	ensureCountObject() Gets the count object, forcing its creation if it doesn't exist.
boolean	equals(Object object)
Bookmark	get(int index)
int	hashCode()
int	indexOf(Object bookmark)
boolean	isEmpty()
Iterator<Bookmark>	iterator()
int	lastIndexOf(Object bookmark)
ListIterator<Bookmark>	listIterator()
ListIterator<Bookmark>	listIterator(int index)
Bookmark	remove(int index)
boolean	remove(Object bookmark)
boolean	removeAll(Collection<?> bookmarks)
boolean	retainAll(Collection<?> bookmarks)
Bookmark	set(int index, Bookmark bookmark)
int	size()
List<Bookmark>	subList(int fromIndex, int toIndex)
Bookmark[]	toArray()
<T> T[]	toArray(T[] values)
static Bookmarks	wrap(PdfDirectObject baseObject)

Methods inherited from class org.pdfclown.objects.PdfObjectWrapper

checkCompatibility, delete, exists, getBaseDataObject, getBaseObject, getBaseObject, getContainer, getDataContainer, getDocument, getFile, getMetadata, retrieveName, retrieveNamedBaseObject, setBaseObject, setMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

Bookmarks

public Bookmarks(Document context)

Method Detail

wrap

public static Bookmarks wrap(PdfDirectObject baseObject)

clone

public Bookmarks clone(Document context)

Description copied from class: PdfObjectWrapper

Gets a clone of the object, registered inside the given document context.

Overrides:

clone in class PdfObjectWrapper<PdfDictionary>

Parameters:

context - Which document the clone has to be registered in.

add

public void add(int index,
                Bookmark bookmark)

Specified by:

add in interface List<Bookmark>

addAll

public boolean addAll(int index,
                      Collection<? extends Bookmark> bookmarks)

Specified by:

addAll in interface List<Bookmark>

get

public Bookmark get(int index)

Specified by:

get in interface List<Bookmark>

indexOf

public int indexOf(Object bookmark)

Specified by:

indexOf in interface List<Bookmark>

lastIndexOf

public int lastIndexOf(Object bookmark)

Specified by:

lastIndexOf in interface List<Bookmark>

listIterator

public ListIterator<Bookmark> listIterator()

Specified by:

listIterator in interface List<Bookmark>

listIterator

public ListIterator<Bookmark> listIterator(int index)

Specified by:

listIterator in interface List<Bookmark>

remove

public Bookmark remove(int index)

Specified by:

remove in interface List<Bookmark>

set

public Bookmark set(int index,
                    Bookmark bookmark)

Specified by:

set in interface List<Bookmark>

subList

public List<Bookmark> subList(int fromIndex,
                              int toIndex)

Specified by:

subList in interface List<Bookmark>

add

public boolean add(Bookmark bookmark)

Specified by:

add in interface Collection<Bookmark>

Specified by:

add in interface List<Bookmark>

addAll

public boolean addAll(Collection<? extends Bookmark> bookmarks)

Specified by:

addAll in interface Collection<Bookmark>

Specified by:

addAll in interface List<Bookmark>

clear

public void clear()

Specified by:

clear in interface Collection<Bookmark>

Specified by:

clear in interface List<Bookmark>

contains

public boolean contains(Object bookmark)

Specified by:

contains in interface Collection<Bookmark>

Specified by:

contains in interface List<Bookmark>

containsAll

public boolean containsAll(Collection<?> bookmarks)

Specified by:

containsAll in interface Collection<Bookmark>

Specified by:

containsAll in interface List<Bookmark>

equals

public boolean equals(Object object)

Specified by:

equals in interface Collection<Bookmark>

Specified by:

equals in interface List<Bookmark>

Overrides:

equals in class PdfObjectWrapper<PdfDictionary>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<Bookmark>

Specified by:

hashCode in interface List<Bookmark>

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Bookmark>

Specified by:

isEmpty in interface List<Bookmark>

remove

public boolean remove(Object bookmark)

Specified by:

remove in interface Collection<Bookmark>

Specified by:

remove in interface List<Bookmark>

removeAll

public boolean removeAll(Collection<?> bookmarks)

Specified by:

removeAll in interface Collection<Bookmark>

Specified by:

removeAll in interface List<Bookmark>

retainAll

public boolean retainAll(Collection<?> bookmarks)

Specified by:

retainAll in interface Collection<Bookmark>

Specified by:

retainAll in interface List<Bookmark>

size

public int size()

Specified by:

size in interface Collection<Bookmark>

Specified by:

size in interface List<Bookmark>

toArray

public Bookmark[] toArray()

Specified by:

toArray in interface Collection<Bookmark>

Specified by:

toArray in interface List<Bookmark>

toArray

public <T> T[] toArray(T[] values)

Specified by:

toArray in interface Collection<Bookmark>

Specified by:

toArray in interface List<Bookmark>

iterator

public Iterator<Bookmark> iterator()

Specified by:

iterator in interface Iterable<Bookmark>

Specified by:

iterator in interface Collection<Bookmark>

Specified by:

iterator in interface List<Bookmark>

ensureCountObject

protected PdfInteger ensureCountObject()

Gets the count object, forcing its creation if it doesn't exist.