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 for this view.

The destination rectangle. Coordinates with a value of NullValue indicate that the corresponding coordinate is not specified in the destination.

getFitType

String getFitType()

Returns:

String

The fit type string for this destination.

The fit type describing how the destination page is displayed. The fit type determines how the page content is fitted into the window. Valid fit types are: "XYZ", "Fit", "FitH", "FitV", "FitR", "FitB", "FitBH", and "FitBV".

getPDFArray

PDFArray getPDFArray()

Returns:

PDFArray

The underlying PDF array object for this destination.

Retrieve the PDFArray representation of this ViewDestination.

getPageNumber

int getPageNumber()

Returns:

int

The zero-based page number for this destination.

The page number of the destination.

getZoom

double getZoom()

Returns:

double

The zoom factor, or NullValue if not set.

The zoom factor for the destination. A value of NullValue indicates that the zoom factor is not specified.

setDestRect

void setDestRect(Rect ViewDestRect)

Parameters

ViewDestRect: Rect

The rectangle defining the visible area of the destination page.

Returns:

void

Set the destination rectangle of the view.

setFitType

void setFitType(String ViewDestFitType)

Parameters

ViewDestFitType: String

The fit type string. Must be one of: "XYZ", "Fit", "FitH", "FitV", "FitR", "FitB", "FitBH", or "FitBV".

Returns:

void

Set the fit type for the view.

setPageNumber

void setPageNumber(int ViewDestPageNum)

Parameters

ViewDestPageNum: int

The zero-based page number to set as the destination.

Returns:

void

Set the page number of the destination starting at 0.

setZoom

void setZoom(double ViewDestZoomFactor)

Parameters

ViewDestZoomFactor: double

The zoom level to apply when navigating to this destination.

Returns:

void

Set the zoom factor for the destination.

toString

String toString()

Returns:

String

A formatted string describing this ViewDestination.

Return a string representation of the ViewDestination. The string includes the page number, fit type, destination rectangle, and zoom factor.