com.datalogics.PDFL

Class RemoteDestination

java.lang.Object

com.datalogics.PDFL.RemoteDestination

public class RemoteDestination
extends java.lang.Object

A view of a page contained in a separate document. A RemoteDestination is not the same as a ViewDestination; the two objects are not interchangeable.

Field Summary

Fields

Modifier and Type	Field and Description
static double	NULL_VALUE Constant used for "null" values in destination rectangles or zoom.

Constructor Summary

Constructors

Constructor and Description
RemoteDestination(Document doc, int pageNum, java.lang.String fitType, Rect r, double zoom) Construct a RemoteDestination.

Method Summary

Modifier and Type	Method and Description
void	delete()
boolean	equals(java.lang.Object rhs)
Rect	getDestRect() The destination rectangle.
java.lang.String	getFitType() The fit type.
int	getPageNumber() The page number of the destination.
PDFObject	getPDFObject() Retrieve the PDFObject representation of this Remote Destination.
double	getZoom() The zoom factor for the destination.
void	setDestRect(Rect destRect) Set the rectangle for the destination.
void	setFitType(java.lang.String remoteDestFitType) Set the fit type for the destination.
void	setPageNumber(int remoteDestPageNum) Set the page number of the destination (page numbers start at 0)
void	setZoom(double zoomFactor) Set the zoom factor for the destination.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NULL_VALUE

public static final double NULL_VALUE

Constant used for "null" values in destination rectangles or zoom.

See Also:

Constant Field Values

Constructor Detail

RemoteDestination

public RemoteDestination(Document doc,
                         int pageNum,
                         java.lang.String fitType,
                         Rect r,
                         double zoom)

Construct a RemoteDestination.

Parameters:

doc - Document that the RemoteDestination will be created in.

pageNum - Page number of the page in the remote document to display.

fitType - Fit Type must be: "XYZ", "Fit", "FitH", "FitV", "FitR", "FitB", "FitBH", or "FitBV".

r - Target Rectangle

zoom - Zoom level

Method Detail

delete

public void delete()

equals

public boolean equals(java.lang.Object rhs)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPageNumber

public int getPageNumber()

The page number of the destination.

setPageNumber

public void setPageNumber(int remoteDestPageNum)

Set the page number of the destination (page numbers start at 0)

getFitType

public java.lang.String getFitType()

The fit type.

setFitType

public void setFitType(java.lang.String remoteDestFitType)

Set the fit type for the destination.

getDestRect

public Rect getDestRect()

The destination rectangle.

setDestRect

public void setDestRect(Rect destRect)

Set the rectangle for the destination.

getZoom

public double getZoom()

The zoom factor for the destination.

setZoom

public void setZoom(double zoomFactor)

Set the zoom factor for the destination.

getPDFObject

public PDFObject getPDFObject()

Retrieve the PDFObject representation of this Remote Destination.