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

public Class PDPageFitDestination

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

This represents a destination to a page and the page contents will be 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
PDPageFitDestination()

Default constructor.

public
PDPageFitDestination(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 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.

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

PDPageFitDestinationback to summary
public PDPageFitDestination()

Default constructor.

PDPageFitDestinationback to summary
public PDPageFitDestination(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.

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.