RemoteDestination Class Documentation

classRemoteDestination

Namespace:com::datalogics::PDFL

Detailed Description

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.

Referenced by

RemoteDestinationRemoteGoToAction

Constructor & Destructor Documentation

RemoteDestination

RemoteDestination(Documentdoc, intpageNum, StringfitType, Rectr, doublezoom)

Parameters

doc: Document

Document that the RemoteDestination will be created in.

pageNum: int

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

fitType: String

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

r: Rect

Target Rectangle

zoom: double

Zoom level

Construct a RemoteDestination.

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

equals

booleanequals(Objectrhs)

Parameters

rhs: Object

Returns:

boolean

finalize

voidfinalize()

Returns:

void

getDestRect

RectgetDestRect()

Returns:

The rectangle defining the area of the page to display. Fields not applicable to the current fit type will contain NullValue.

The destination rectangle.

getFitType

StringgetFitType()

Returns:

The fit type string (e.g., "XYZ", "Fit", "FitH", "FitV", "FitR", "FitB", "FitBH", or "FitBV").

The fit type for the destination.

getNULL_VALUE

static doublegetNULL_VALUE()

Returns:

double

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

getPDFObject

PDFObjectgetPDFObject()

Returns:

The underlying PDFObject for this RemoteDestination.

Retrieve the PDFObject representation of this Remote Destination.

getPageNumber

intgetPageNumber()

Returns:

The zero-based page number for this destination in the remote document.

The page number of the destination.

getZoom

doublegetZoom()

Returns:

The zoom level for the destination, or NullValue if not specified.

The zoom factor for the destination.

setDestRect

voidsetDestRect(RectdestRect)

Parameters

destRect: Rect

Returns:

void

Set the rectangle for the destination.

setFitType

voidsetFitType(StringremoteDestFitType)

Parameters

remoteDestFitType: String

Returns:

void

Set the fit type for the destination.

setPageNumber

voidsetPageNumber(intremoteDestPageNum)

Parameters

remoteDestPageNum: int

Returns:

void

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

setZoom

voidsetZoom(doublezoomFactor)

Parameters

zoomFactor: double

Returns:

void

Set the zoom factor for the destination.

toString

StringtoString()

Returns:

A string describing the page number, fit type, destination rectangle, and zoom factor.

Returns a string representation of this RemoteDestination.