com.cete.dynamicpdf
Class PageList

java.lang.Object
  com.cete.dynamicpdf.PageList

public class PageList
extends java.lang.Object

Represents a collection of pages associated with a document.

Licensing:
This class is a DynamicPDF Generator Community Edition feature.

Constructor Summary

PageList()
Initializes a new instance of the PageList class.

Method Summary

void	add(int index, Page page) Inserts a Page into the PageList at the specified index.
int	add(Page page) Adds a Page to the end of the PageList.
java.util.Iterator	getIterator() Returns an iterator that can iterate through the PageList.
Page	getPage(int index) Gets the page at the given index.
int	size() Gets the number of pages in the collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageList

public PageList()

Initializes a new instance of the PageList class.

Method Detail

getPage

public Page getPage(int index)

Gets the page at the given index.

Parameters:

index - the integer specifying the index value of the Page stored in the ArrayList.

Returns:

the Page at the given index.

See Also:

ArrayList

size

public int size()

Gets the number of pages in the collection.

Returns:

the int value specifying the number of pages in the ArrayList.

add

public int add(Page page)

Adds a Page to the end of the PageList.

Parameters:

page - The Page to be added to the end of the PageList.

Returns:

The PageList index at which the page has been added.

See Also:

Page, PageList

add

public void add(int index,
                Page page)

Inserts a Page into the PageList at the specified index.

Parameters:

index - The zero-based index value at which Page should be inserted.

page - The Page to insert.

See Also:

Page, PageList

getIterator

public java.util.Iterator getIterator()

Returns an iterator that can iterate through the PageList.

Returns:

An Iterator for the entire PageList.

See Also:

PageList, Iterator