com.crionics.jpdf.destination
Class LocalPageDestination

java.lang.Object
  PdfObjectContainer
      com.crionics.jpdf.destination.AbstractDestinationPage
          com.crionics.jpdf.destination.LocalPageDestination

public class LocalPageDestination
extends AbstractDestinationPage

A Destination Object defining the page and the zoom configuration of a page within the current PDF Document.

A description of Destination Object is presented here: AbstractDestinationPage

Method Summary

static LocalPageDestination	createInstance(PdfDocument doc) Allows the creation of a new Destination Object.
int	getPageIndex() Returns the index of the Page defined into the document containing this Destination object.
AbstractZoom	getZoom() Returns the zoom configuration defined into this Destination object.
void	setPageIndex(int index) Sets the index of the [age present in the document, to which this destination object should be referring to.
void	setZoom(AbstractZoom zoom) Sets the zoom configuration for this destination object.

Methods inherited from class java.lang.Object

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

Method Detail

createInstance

public static LocalPageDestination createInstance(PdfDocument doc)
                                           throws PdfException,
                                                  java.io.IOException

Allows the creation of a new Destination Object.

Parameters:

doc - The Document into which the Destination object is to be created.

Returns:

The Destination Object.

Throws:

PdfException - Raised if a problem occured while parsing the file.

java.io.IOException - Raised if a problem occured while reading the file.

getPageIndex

public int getPageIndex()
                 throws PdfException,
                        java.io.IOException

Returns the index of the Page defined into the document containing this Destination object.

Returns:

The index of the page (First page start at index=1 !).

Throws:

PdfException - Raised if a problem occured while parsing the file.

java.io.IOException - Raised if a problem occured while reading the file.

getZoom

public AbstractZoom getZoom()
                     throws PdfException,
                            java.io.IOException

Returns the zoom configuration defined into this Destination object.

Returns:

The zoom configuration.

Throws:

PdfException - Raised if a problem occured while parsing the file.

java.io.IOException - Raised if a problem occured while reading the file.

setPageIndex

public void setPageIndex(int index)
                  throws PdfException,
                         java.io.IOException

Sets the index of the [age present in the document, to which this destination object should be referring to.

Parameters:

index - The index of the page (First page start at index=1 !).

Throws:

PdfException - Raised if a problem occured while parsing the file.

java.io.IOException - Raised if a problem occured while reading the file.

setZoom

public void setZoom(AbstractZoom zoom)
             throws PdfException,
                    java.io.IOException

Sets the zoom configuration for this destination object.

NOTE : This destination object must contains a valid Page Index before applying a new zoom configuration.

Parameters:

zoom - The zoom configuration.

Throws:

PdfException - Raised if a problem occured while parsing the file.

java.io.IOException - Raised if a problem occured while reading the file.