ViewDestination Class Documentation

class ViewDestination

Namespace:com::datalogics::PDFL

Detailed Description

Represents a particular view of a page in a document. A destination describes a place in the PDF document where the user will be taken in response to clicking a hyperlink. The destination defines where a bookmark or hyperlink points to.

The ViewDestination contains a reference to a page, a place (rectangle) on that page, and information specifying how to adjust the view to fit the window's size and shape.

Referenced by

BookmarkGoToActionLinkAnnotationViewDestination

Constructor & Destructor Documentation

ViewDestination

ViewDestination(Document doc, int pageNum, String fitType, Rect r, double zoom)

Parameters

doc: Document

Containing document

pageNum: int

Target page number

fitType: String

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

r: Rect

Target rectangle

zoom: double

Zoom level

General purpose constructor: construct with all elements

Field Documentation

CViewDestination_NullValue

static CViewDestination_NullValue

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

NULL_VALUE

static NULL_VALUE

NullValue

static NullValue

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

equals

boolean equals(Object rhs)

Parameters

rhs: Object

Returns:

boolean

finalize

void finalize()

Returns:

void

getDestRect

Rect getDestRect()

Returns:

Rect

The destination rectangle.

getFitType

String getFitType()

Returns:

String

The fit type.

getPDFArray

PDFArray getPDFArray()

Returns:

PDFArray

Retrieve the PDFObject representation of this object

getPageNumber

int getPageNumber()

Returns:

int

The page number of the destination

getZoom

double getZoom()

Returns:

double

The zoom factor for the destination.

setDestRect

void setDestRect(Rect ViewDestRect)

Parameters

ViewDestRect: Rect

Returns:

void

Set the destination rectangle of the view.

setFitType

void setFitType(String ViewDestFitType)

Parameters

ViewDestFitType: String

Returns:

void

Set the fit type for the view

setPageNumber

void setPageNumber(int ViewDestPageNum)

Parameters

ViewDestPageNum: int

Returns:

void

Set the page number of the destination starting at 0

setZoom

void setZoom(double ViewDestZoomFactor)

Parameters

ViewDestZoomFactor: double

Returns:

void

Set the zoom factor for the destination.

toString

String toString()

Returns:

String