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

public Class PDPageFitWidthDestination

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.

protected static final String
TYPE_BOUNDED

The type of this destination.

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

Constructor Summary

AccessConstructor and Description
public
PDPageFitWidthDestination()

Default constructor.

public
PDPageFitWidthDestination(COSArray
The destination array.
arr)

Constructor from an existing destination array.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true If the destination should fit just the bounding box.
fitBoundingBox()

A flag indicating if this page destination should just fit bounding box of the PDF.

public int

Returns:

The top y coordinate.
getTop()

Get the top y coordinate.

public void
setFitBoundingBox(boolean
A flag indicating if this should fit the bounding box.
fitBoundingBox)

Set if this page destination should just fit the bounding box.

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.

TYPE_BOUNDEDback to summary
protected static final String TYPE_BOUNDED

The type of this destination.

Constructor Detail

PDPageFitWidthDestinationback to summary
public PDPageFitWidthDestination()

Default constructor.

PDPageFitWidthDestinationback to summary
public PDPageFitWidthDestination(COSArray arr)

Constructor from an existing destination array.

Parameters
arr:COSArray

The destination array.

Method Detail

fitBoundingBoxback to summary
public boolean fitBoundingBox()

A flag indicating if this page destination should just fit bounding box of the PDF.

Returns:boolean

true If the destination should fit just the bounding box.

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.

setFitBoundingBoxback to summary
public void setFitBoundingBox(boolean fitBoundingBox)

Set if this page destination should just fit the bounding box. The default is false.

Parameters
fitBoundingBox:boolean

A flag indicating if this should fit the bounding box.

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.