com.spire.pdf.annotations
Class PdfAnnotationCollection

java.lang.Object
  com.spire.pdf.PdfCollection
      com.spire.pdf.annotations.PdfAnnotationCollection

All Implemented Interfaces:

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

public class PdfAnnotationCollection
extends PdfCollection

Represents collection of objects.

Constructor Summary

PdfAnnotationCollection()
Initializes a new instance of the class.

PdfAnnotationCollection(PdfNewPage page)
Creates new annotation collection for the specified page.

Method Summary

int	add(PdfAnnotation annotation) Adds a new annotation to collection.
void	clear() Cleares the collection.
boolean	contains(PdfAnnotation annotation) Searches the collection for the specified annotation.
PdfAnnotation	get(int index) Gets the object at the specified position.
PdfArray	getAnnotations() Gets the annotations array.
int	indexOf(PdfAnnotation annotation) Searches the collection for the specified annotation.
void	remove(PdfAnnotation annot) Removes the element from the collection.
void	removeAt(int index) Removes the element at the specified field.

Methods inherited from class com.spire.pdf.PdfCollection

getCount, getList

Constructor Detail

PdfAnnotationCollection

public PdfAnnotationCollection()

Initializes a new instance of the class.

PdfAnnotationCollection

public PdfAnnotationCollection(PdfNewPage page)

Creates new annotation collection for the specified page.

Parameters:

page - Page which collection is created for.

Method Detail

get

public PdfAnnotation get(int index)

Gets the object at the specified position.

Parameters:

index - The index value of the annotation in the collection.

Returns:

Annotation object at the specified position.

getAnnotations

public PdfArray getAnnotations()

Gets the annotations array.

Returns:

The annotations.

add

public int add(PdfAnnotation annotation)

Adds a new annotation to collection.

Parameters:

annotation - The new annotation to be added to collection.

Returns:

Position of the annotation in collection.

clear

public void clear()

Cleares the collection.

contains

public boolean contains(PdfAnnotation annotation)

Searches the collection for the specified annotation.

Parameters:

annotation - The annotation to search for.

Returns:

True, if annotation is contained in collection. Otherwise - false.

indexOf

public int indexOf(PdfAnnotation annotation)

Searches the collection for the specified annotation.

Parameters:

annotation - The Annotation to search.

Returns:

Index of the element in the collection, if exists, or -1 if the element does not exist in the collection.

removeAt

public void removeAt(int index)

Removes the element at the specified field.

Parameters:

index - The index of the element to remove.

remove

public void remove(PdfAnnotation annot)

Removes the element from the collection.

Parameters:

annot - The element to remove.