Class PDPageFitWidthDestination
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
- All Implemented Interfaces:
COSObjectable
,PDDestinationOrAction
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
FieldsModifier and TypeFieldDescriptionprotected static final String
The type of this destination.protected static final String
The type of this destination.Fields inherited from class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
array
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Constructor from an existing destination array. -
Method Summary
Modifier and TypeMethodDescriptionboolean
A flag indicating if this page destination should just fit bounding box of the PDF.int
getTop()
Get the top y coordinate.void
setFitBoundingBox
(boolean fitBoundingBox) Set if this page destination should just fit the bounding box.void
setTop
(int y) Set the top y-coordinate, a value of -1 implies that the current y-coordinate will be used.Methods inherited from class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
findPageNumber, getCOSObject, getPage, getPageNumber, retrievePageNumber, setPage, setPageNumber
Methods inherited from class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
create
-
Field Details
-
TYPE
The type of this destination.- See Also:
-
TYPE_BOUNDED
The type of this destination.- See Also:
-
-
Constructor Details
-
PDPageFitWidthDestination
public PDPageFitWidthDestination()Default constructor. -
PDPageFitWidthDestination
Constructor from an existing destination array.- Parameters:
arr
- The destination array.
-
-
Method Details
-
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.
-
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.
-
fitBoundingBox
public boolean fitBoundingBox()A flag indicating if this page destination should just fit bounding box of the PDF.- Returns:
- true If the destination should fit just the bounding box.
-
setFitBoundingBox
public void setFitBoundingBox(boolean fitBoundingBox) Set if this page destination should just fit the bounding box. The default is false.- Parameters:
fitBoundingBox
- A flag indicating if this should fit the bounding box.
-