com.spire.pdf.widget
Class PdfPageCollection

java.lang.Object
  com.spire.pdf.widget.PdfPageCollection

All Implemented Interfaces:

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

public class PdfPageCollection
extends java.lang.Object
implements com.spire.ms.System.Collections.IEnumerable

Implements routines for manipulation with loaded pages.

Constructor Summary

PdfPageCollection(PdfDocumentBase document)

Method Summary

PdfPageBase	add() Creates a new page and adds it to the collection.
PdfPageBase	add(java.awt.geom.Dimension2D size) Creates a new page of the specified size and adds it to the collection.
PdfPageBase	add(java.awt.geom.Dimension2D size, PdfMargins margins) Creates a new page of the specified size and with the specified margins and adds it to the collection.
PdfPageBase	add(java.awt.geom.Dimension2D size, PdfMargins margins, PdfPageRotateAngle rotation) Creates a new page of the specified size and with the specified margins and adds it to the collection.
PdfPageBase	add(java.awt.geom.Dimension2D size, PdfMargins margins, PdfPageRotateAngle rotation, int location) Creates a new page of the specified size and with the specified margins and adds it to the collection.
PdfPageBase	add(java.awt.geom.Dimension2D size, PdfMargins margins, PdfPageRotateAngle rotation, PdfPageOrientation orientation) Creates a new page of the specified size and with the specified margins and adds it to the collection.
PdfPageBase	get(int index) Gets the at the specified index.
int	getCount() Gets the count.
int	indexOf(PdfPageBase page) Gets the index of the page in the document.
PdfPageBase	insert(int index) Creates a new page and inserts it at the specified index.
PdfPageBase	insert(int index, java.awt.geom.Dimension2D size) Creates a new page and inserts it at the specified index.
PdfPageBase	insert(int index, java.awt.geom.Dimension2D size, PdfMargins margins) Creates a new page and inserts it at the specified index.
PdfPageBase	insert(int index, java.awt.geom.Dimension2D size, PdfMargins margins, PdfPageRotateAngle rotation) Creates a new page and inserts it at the specified index.
PdfPageBase	insert(int index, java.awt.geom.Dimension2D size, PdfMargins margins, PdfPageRotateAngle rotation, PdfPageOrientation orientation, boolean existsPage) Creates a new page and inserts it at the specified index.
void	reArrange(int[] orderArray) ReArrange the Pages in the Loaded Document.
void	remove(PdfPageBase page) Removes the specified page.
void	removeAt(int index) Removes the page at the given specified index.

Constructor Detail

PdfPageCollection

public PdfPageCollection(PdfDocumentBase document)

Method Detail

get

public PdfPageBase get(int index)

Gets the at the specified index.

getCount

public int getCount()

Gets the count.

add

public PdfPageBase add()

Creates a new page and adds it to the collection.

Returns:

The created page.

add

public PdfPageBase add(java.awt.geom.Dimension2D size)

Creates a new page of the specified size and adds it to the collection.

Parameters:

size - The size of the new page.

Returns:

The created page.

add

public PdfPageBase add(java.awt.geom.Dimension2D size,
                       PdfMargins margins)

Creates a new page of the specified size and with the specified margins and adds it to the collection.

Parameters:

size - The size of the new page.

margins - The margins of the new page.

Returns:

The created page.

add

public PdfPageBase add(java.awt.geom.Dimension2D size,
                       PdfMargins margins,
                       PdfPageRotateAngle rotation)

Creates a new page of the specified size and with the specified margins and adds it to the collection.

Parameters:

size - The size of the new page.

margins - The margins of the new page.

rotation - The rotation of the new page.

Returns:

The created page.

add

public PdfPageBase add(java.awt.geom.Dimension2D size,
                       PdfMargins margins,
                       PdfPageRotateAngle rotation,
                       int location)

Creates a new page of the specified size and with the specified margins and adds it to the collection.

Parameters:

size - The size of the new page.

margins - The margins of the new page.

rotation - The rotation of the new page.

location - he location of the new page.

Returns:

The created page.

add

public PdfPageBase add(java.awt.geom.Dimension2D size,
                       PdfMargins margins,
                       PdfPageRotateAngle rotation,
                       PdfPageOrientation orientation)

Creates a new page of the specified size and with the specified margins and adds it to the collection.

Parameters:

size - The size of the page.

margins - The margins of the page.

rotation - The rotation of the new page.

orientation - The orientation of the new page.

Returns:

The created page.

insert

public PdfPageBase insert(int index)

Creates a new page and inserts it at the specified index.

Parameters:

index - The index.

Returns:

The created page.

insert

public PdfPageBase insert(int index,
                          java.awt.geom.Dimension2D size)

Creates a new page and inserts it at the specified index.

Parameters:

index - The index.

size - The size of the page.

Returns:

The created page.

insert

public PdfPageBase insert(int index,
                          java.awt.geom.Dimension2D size,
                          PdfMargins margins)

Creates a new page and inserts it at the specified index.

Parameters:

index - The index.

size - The size of the page.

margins - The margins of the page.

Returns:

The created page.

insert

public PdfPageBase insert(int index,
                          java.awt.geom.Dimension2D size,
                          PdfMargins margins,
                          PdfPageRotateAngle rotation)

Creates a new page and inserts it at the specified index.

Parameters:

index - The index.

size - The size of the page.

margins - The margins of the page.

rotation - The rotation of the new page.

Returns:

The created page.

removeAt

public void removeAt(int index)

Removes the page at the given specified index.

Parameters:

index - Index of the page.

remove

public void remove(PdfPageBase page)

Removes the specified page.

Parameters:

page - The page to be remove.

reArrange

public void reArrange(int[] orderArray)

ReArrange the Pages in the Loaded Document.

Parameters:

orderArray - The page sequence to arrange the pages.

insert

public PdfPageBase insert(int index,
                          java.awt.geom.Dimension2D size,
                          PdfMargins margins,
                          PdfPageRotateAngle rotation,
                          PdfPageOrientation orientation,
                          boolean existsPage)

Creates a new page and inserts it at the specified index.

Parameters:

index - The index.

size - The size of the page.

margins - The margins of the page.

rotation - The rotation of the new page.

orientation - The orientation of the new page.

Returns:

The created page.

indexOf

public int indexOf(PdfPageBase page)

Gets the index of the page in the document.

Parameters:

page - The current page.

Returns:

Index of the page in the document if exists, -1 otherwise.