Class PDPageFitDestination
- java.lang.Object
-
- com.tom_roush.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
-
- com.tom_roush.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
-
- com.tom_roush.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
-
- All Implemented Interfaces:
COSObjectable,PDDestinationOrAction
public class PDPageFitDestination extends PDPageDestination
This represents a destination to a page and the page contents will be magnified to just fit on the screen.
-
-
Field Summary
Fields Modifier and Type Field Description protected static StringTYPEThe type of this destination.protected static StringTYPE_BOUNDEDThe type of this destination.-
Fields inherited from class com.tom_roush.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
array
-
-
Constructor Summary
Constructors Constructor Description PDPageFitDestination()Default constructor.PDPageFitDestination(COSArray arr)Constructor from an existing destination array.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanfitBoundingBox()A flag indicating if this page destination should just fit bounding box of the PDF.voidsetFitBoundingBox(boolean fitBoundingBox)Set if this page destination should just fit the bounding box.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from class com.tom_roush.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
create
-
Methods inherited from class com.tom_roush.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
findPageNumber, getCOSObject, getPage, getPageNumber, retrievePageNumber, setPage, setPageNumber
-
-
-
-
Field Detail
-
TYPE
protected static final String TYPE
The type of this destination.- See Also:
- Constant Field Values
-
TYPE_BOUNDED
protected static final String TYPE_BOUNDED
The type of this destination.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PDPageFitDestination
public PDPageFitDestination()
Default constructor.
-
PDPageFitDestination
public PDPageFitDestination(COSArray arr)
Constructor from an existing destination array.- Parameters:
arr- The destination array.
-
-
Method Detail
-
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.
-
-