com.sun.pdfview

Class PDFDestination

public class PDFDestination extends Object

Represents a destination in a PDF file. Destinations take 3 forms:

An explicit destination, which contains a reference to a page as well as some stuff about how to fit it into the window.
A named destination, which uses the PDF file's Dests entry in the document catalog to map a name to an explicit destination
A string destintation, which uses the PDF file's Dests entry. in the name directory to map a string to an explicit destination.

All three of these cases are handled by the getDestination() method.

Field Summary
static int	FIT
static int	FITB
static int	FITBH
static int	FITBV
static int	FITH
static int	FITR
static int	FITV
static int	XYZ The known types of destination

Constructor Summary
protected	PDFDestination(PDFObject pageObj, int type) Creates a new instance of PDFDestination

Method Summary
float	getBottom() Get the bottom coordinate value
static PDFDestination	getDestination(PDFObject obj, PDFObject root) Get a destination from either an array (explicit destination), a name (named destination) or a string (name tree destination).
float	getLeft() Get the left coordinate value
PDFObject	getPage() Get the PDF Page object associated with this destination
float	getRight() Get the right coordinate value
float	getTop() Get the top coordinate value
int	getType() Get the type of this destination
float	getZoom() Get the zoom value
void	setBottom(float bottom) Set the bottom coordinate value
void	setLeft(float left) Set the left coordinate value
void	setRight(float right) Set the right coordinate value
void	setTop(float top) Set the top coordinate value
void	setZoom(float zoom) Set the zoom value

Field Detail

FIT

public static final int FIT

FITB

public static final int FITB

FITBH

public static final int FITBH

FITBV

public static final int FITBV

FITH

public static final int FITH

FITR

public static final int FITR

FITV

public static final int FITV

XYZ

public static final int XYZ

The known types of destination

Constructor Detail

PDFDestination

protected PDFDestination(PDFObject pageObj, int type)

Creates a new instance of PDFDestination

Parameters: pageObj the page object this destination refers to type the type of page this object refers to

Method Detail

getBottom

public float getBottom()

Get the bottom coordinate value

getDestination

public static PDFDestination getDestination(PDFObject obj, PDFObject root)

Get a destination from either an array (explicit destination), a name (named destination) or a string (name tree destination).

Parameters: obj the PDFObject representing this destination root the root of the PDF object tree

getLeft

public float getLeft()

Get the left coordinate value

getPage

public PDFObject getPage()

Get the PDF Page object associated with this destination

getRight

public float getRight()

Get the right coordinate value

getTop

public float getTop()

Get the top coordinate value

getType

public int getType()

Get the type of this destination

getZoom

public float getZoom()

Get the zoom value

setBottom

public void setBottom(float bottom)

Set the bottom coordinate value

setLeft

public void setLeft(float left)

Set the left coordinate value

setRight

public void setRight(float right)

Set the right coordinate value

setTop

public void setTop(float top)

Set the top coordinate value

setZoom

public void setZoom(float zoom)

Set the zoom value