Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination

public Class PDPageXYZDestination

extends PDPageDestination
Class Inheritance
Imports
org.apache.pdfbox.cos.COSArray, .COSBase, .COSFloat, .COSNumber
This represents a destination to a page at an x,y coordinate with a zoom setting. The default x,y,z will be whatever is the current value in the viewer application and are not required.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
protected static final String
TYPE

The type of this destination.

Inherited from org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination:
array

Constructor Summary

AccessConstructor and Description
public
PDPageXYZDestination()

Default constructor.

public
PDPageXYZDestination(COSArray
The destination array.
arr)

Constructor from an existing destination array.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The left x coordinate.
getLeft()

Get the left x coordinate.

public int

Returns:

The top y coordinate.
getTop()

Get the top y coordinate.

public float

Returns:

The zoom value for the page.
getZoom()

Get the zoom value.

public void
setLeft(int
The left x coordinate.
x)

Set the left x-coordinate, values 0 or -1 imply that the current x-coordinate will be used.

public void
setTop(int
The top ycoordinate.
y)

Set the top y-coordinate, values 0 or -1 imply that the current y-coordinate will be used.

public void
setZoom(float
The zoom value.
zoom)

Set the zoom value for the page, values 0 or -1 imply that the current zoom will be used.

Inherited from org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination:
getCOSObjectgetPagegetPageNumberretrievePageNumbersetPagesetPageNumber

Field Detail

TYPEback to summary
protected static final String TYPE

The type of this destination.

Constructor Detail

PDPageXYZDestinationback to summary
public PDPageXYZDestination()

Default constructor.

PDPageXYZDestinationback to summary
public PDPageXYZDestination(COSArray arr)

Constructor from an existing destination array.

Parameters
arr:COSArray

The destination array.

Method Detail

getLeftback to summary
public int getLeft()

Get the left x coordinate. Return values of 0 or -1 imply that the current x-coordinate will be used.

Returns:int

The left x coordinate.

getTopback to summary
public int getTop()

Get the top y coordinate. Return values of 0 or -1 imply that the current y-coordinate will be used.

Returns:int

The top y coordinate.

getZoomback to summary
public float getZoom()

Get the zoom value. Return values of 0 or -1 imply that the current zoom will be used.

Returns:float

The zoom value for the page.

setLeftback to summary
public void setLeft(int x)

Set the left x-coordinate, values 0 or -1 imply that the current x-coordinate will be used.

Parameters
x:int

The left x coordinate.

setTopback to summary
public void setTop(int y)

Set the top y-coordinate, values 0 or -1 imply that the current y-coordinate will be used.

Parameters
y:int

The top ycoordinate.

setZoomback to summary
public void setZoom(float zoom)

Set the zoom value for the page, values 0 or -1 imply that the current zoom will be used.

Parameters
zoom:float

The zoom value.