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

public Class PDPageFitRectangleDestination

extends PDPageDestination
Class Inheritance
Imports
org.apache.pdfbox.cos.COSArray

This represents a destination to a page at a y location and the width is magnified to just fit on the screen.
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
PDPageFitRectangleDestination()

Default constructor.

public
PDPageFitRectangleDestination(COSArray
The destination array.
arr
)

Constructor from an existing destination array.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The bottom y coordinate.
getBottom
()

Get the bottom y coordinate.

public int

Returns:

The left x coordinate.
getLeft
()

Get the left x coordinate.

public int

Returns:

The right x coordinate.
getRight
()

Get the right x coordinate.

public int

Returns:

The top y coordinate.
getTop
()

Get the top y coordinate.

public void
setBottom(int
The bottom y coordinate.
y
)

Set the bottom y-coordinate, a value of -1 implies that the current y-coordinate will be used.

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

Set the left x-coordinate, a value of -1 implies that the current x-coordinate will be used.

public void
setRight(int
The right x coordinate.
x
)

Set the right x-coordinate, a value of -1 implies that the current x-coordinate will be used.

public void
setTop(int
The top ycoordinate.
y
)

Set the top y-coordinate, a value of -1 implies that the current y-coordinate 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

PDPageFitRectangleDestinationback to summary
public PDPageFitRectangleDestination()

Default constructor.

PDPageFitRectangleDestinationback to summary
public PDPageFitRectangleDestination(COSArray arr)

Constructor from an existing destination array.

Parameters
arr:COSArray

The destination array.

Method Detail

getBottomback to summary
public int getBottom()

Get the bottom y coordinate. A return value of -1 implies that the current y-coordinate will be used.

Returns:int

The bottom y coordinate.

getLeftback to summary
public int getLeft()

Get the left x coordinate. A return value of -1 implies that the current x-coordinate will be used.

Returns:int

The left x coordinate.

getRightback to summary
public int getRight()

Get the right x coordinate. A return value of -1 implies that the current x-coordinate will be used.

Returns:int

The right x coordinate.

getTopback to summary
public int getTop()

Get the top y coordinate. A return value of -1 implies that the current y-coordinate will be used.

Returns:int

The top y coordinate.

setBottomback to summary
public void setBottom(int y)

Set the bottom y-coordinate, a value of -1 implies that the current y-coordinate will be used.

Parameters
y:int

The bottom y coordinate.

setLeftback to summary
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:int

The left x coordinate.

setRightback to summary
public void setRight(int x)

Set the right x-coordinate, a value of -1 implies that the current x-coordinate will be used.

Parameters
x:int

The right x coordinate.

setTopback to summary
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:int

The top ycoordinate.