Class PDPageDestination
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
- All Implemented Interfaces:
COSObjectable
,PDDestinationOrAction
- Direct Known Subclasses:
PDPageFitDestination
,PDPageFitHeightDestination
,PDPageFitRectangleDestination
,PDPageFitWidthDestination
,PDPageXYZDestination
This represents a destination to a page, see subclasses for specific parameters.
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructor to create empty page destination.protected
Constructor to create empty page destination. -
Method Summary
Modifier and TypeMethodDescriptionint
Deprecated.Convert this standard java object to a COS object.getPage()
This will get the page for this destination.int
This will get the page number for this destination.private int
indexOfPageTree
(COSDictionary pageDict) int
Returns the page number for this destination, regardless of whether this is a page number or a reference to a page.void
Set the page for a local destination.void
setPageNumber
(int pageNumber) Set the page number for a remote destination.Methods inherited from class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
create
-
Field Details
-
array
Storage for the page destination.
-
-
Constructor Details
-
PDPageDestination
protected PDPageDestination()Constructor to create empty page destination. -
PDPageDestination
Constructor to create empty page destination.- Parameters:
arr
- A page destination array.
-
-
Method Details
-
getPage
This will get the page for this destination. A page destination can either reference a page (for a local destination) or a page number (when doing a remote destination to another PDF). If this object is referencing by page number then this method will return null andgetPageNumber()
should be used.- Returns:
- The page for this destination.
-
setPage
Set the page for a local destination. For an external destination, callsetPageNumber(int pageNumber)
.- Parameters:
page
- The page for a local destination.
-
getPageNumber
public int getPageNumber()This will get the page number for this destination. A page destination can either reference a page (for a local destination) or a page number (when doing a remote destination to another PDF). If this object is referencing by page number then this method will return that number, otherwise -1 will be returned.- Returns:
- The zero-based page number for this destination.
-
findPageNumber
Deprecated.This method has inconsistent behavior (see returns), useretrievePageNumber()
instead.Returns the page number for this destination, regardless of whether this is a page number or a reference to a page.- Returns:
- page number, or -1 if the destination type is unknown. The page number is 0-based if it was in the dictionary (for remote destinations), and 1-based if it was computed from a page reference (for local destinations).
- Since:
- Apache PDFBox 1.0.0
- See Also:
-
retrievePageNumber
public int retrievePageNumber()Returns the page number for this destination, regardless of whether this is a page number or a reference to a page.- Returns:
- the 0-based page number, or -1 if the destination type is unknown.
- See Also:
-
indexOfPageTree
-
setPageNumber
public void setPageNumber(int pageNumber) Set the page number for a remote destination. For an internal destination, callsetPage(PDPage page)
.- Parameters:
pageNumber
- The page for a remote destination.
-
getCOSObject
Convert this standard java object to a COS object.- Returns:
- The cos object that matches this Java object.
-
retrievePageNumber()
instead.