Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.pdfbox.pdmodel.interactive.documentnavigation.destination

Class PDPageXYZDestination

Implemented Interfaces:
COSObjectable, PDDestinationOrAction
public class PDPageXYZDestination
extends PDPageDestination
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.
Version:
$Revision: 1.2 $
Author:
Ben Litchfield

Field Summary

protected static String
TYPE
The type of this destination.

Fields inherited from class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination

array

Constructor Summary

PDPageXYZDestination()
Default constructor.
PDPageXYZDestination(COSArray arr)
Constructor from an existing destination array.

Method Summary

int
getLeft()
Get the left x coordinate.
int
getTop()
Get the top y coordinate.
int
getZoom()
Get the zoom value.
void
setLeft(int x)
Set the left x-coordinate, a value of -1 implies that the current x-coordinate will be used.
void
setTop(int y)
Set the top y-coordinate, a value of -1 implies that the current y-coordinate will be used.
void
setZoom(int zoom)
Set the zoom value for the page, a value of -1 implies that the current zoom will be used.

Methods inherited from class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination

getCOSArray, getCOSObject, getPage, getPageNumber, setPage, setPageNumber

Methods inherited from class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination

create, toString

Field Details

TYPE

protected static final String TYPE
The type of this destination.

Constructor Details

PDPageXYZDestination

public PDPageXYZDestination()
Default constructor.

PDPageXYZDestination

public PDPageXYZDestination(COSArray arr)
Constructor from an existing destination array.
Parameters:
arr - The destination array.

Method Details

getLeft

public int getLeft()
Get the left x coordinate. A return value of -1 implies that the current x-coordinate will be used.
Returns:
The left x coordinate.

getTop

public int getTop()
Get the top y coordinate. A return value of -1 implies that the current y-coordinate will be used.
Returns:
The top y coordinate.

getZoom

public int getZoom()
Get the zoom value. A return value of -1 implies that the current zoom will be used.
Returns:
The zoom value for the page.

setLeft

public void setLeft(int x)
Set the left x-coordinate, a value of -1 implies that the current x-coordinate will be used.
Parameters:
x - The left x coordinate.

setTop

public void setTop(int y)
Set the top y-coordinate, a value of -1 implies that the current y-coordinate will be used.
Parameters:
y - The top ycoordinate.

setZoom

public void setZoom(int zoom)
Set the zoom value for the page, a value of -1 implies that the current zoom will be used.
Parameters:
zoom - The zoom value.

Overview Package Class Use Tree Index Deprecated About