com.icesoft.pdf.pobjects
Class Destination

java.lang.Object
  com.icesoft.pdf.pobjects.Destination

public class Destination

extends Object

The Destination class defines a particular view of a PDF document consisting of the following items:

• The page of the document to be displayed.
• The location of the document window on that page.
• The magnification (zoom) factor to use when displaying the page Destinations may be associated with outline items, annotations, or actions.

Destination can be associated with outline items, annotations, or actions. In each case the destination specifies the view of the document to be presented when one of the respective objects is activated.

The Destination class currently only supports the Destination syntaxes, [page /XYZ left top zoom], other syntax will be added in future releases. The syntax [page /XYZ left top zoom] is defined as follows:

• page - designated page to show (Reference to a page).
• /XYZ - named format of destination syntax.
• left - x value of the upper left-and coordinate.
• top - y value of the upper left-hand coordinate.
• zoom - zoom factor to magnify page by.

A null value for left, top or zoom specifies that the current view values will be unchanged when navigating to the specified page.

Since:

1.0

See Also:

Annotation, OutlineItem, Action

Constructor Summary

Destination(Library l, Object h)
Creates a new instance of a Destination.

Method Summary

float	getLeft() Gets the left offset from the top, left position of the page specified by this destination.
Reference	getPageReference() Gets the Page Reference specified by the destination.
float	getTop() Gets the top offset from the top, left position of the page specified by this destination.
float	getZoom() Gets the zoom level specifed by the destination.
String	toString() Returns a summary of the annotation dictionary values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Destination

public Destination(Library l,
                   Object h)

Creates a new instance of a Destination.

Parameters:

l - document library.

h - Destination dictionary entries.

Method Detail

getPageReference

public Reference getPageReference()

Gets the Page Reference specified by the destination.

Returns:

a Reference to the Page Object associated with this destination.

getLeft

public float getLeft()

Gets the left offset from the top, left position of the page specified by this destination.

Returns:

the left offset from the top, left position of the page. If not specified Float.NaN is returned.

getTop

public float getTop()

Gets the top offset from the top, left position of the page specified by this destination.

Returns:

the top offset from the top, left position of the page. If not specified Float.NaN is returned.

getZoom

public float getZoom()

Gets the zoom level specifed by the destination.

Returns:

the specified zoom level, Float.NaN if not specified.

toString

public String toString()

Returns a summary of the annotation dictionary values.

Returns:

dictionary values.