Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination

Modifier and Type	Field and Description
protected final COSArray	array Storage for the page destination.

Access	Constructor and Description
protected	PDPageDestination() Constructor to create empty page destination.
protected	PDPageDestination(COSArray A page destination array. arr) Constructor to create empty page destination.

Method Summary

Modifier and Type	Method and Description
public COSArray	Returns: The cos object that matches this Java object. getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object.
public PDPage	Returns: The page for this destination. getPage() This will get the page for this destination.
public int	Returns: The zero-based page number for this destination. getPageNumber() This will get the page number for this destination.
private int	indexOfPageTree(COSDictionary pageDict)
public int	Returns: the 0-based page number, or -1 if the destination type is unknown. retrievePageNumber() Returns the page number for this destination, regardless of whether this is a page number or a reference to a page.
public void	setPage(PDPage The page for a local destination. page) Set the page for a local destination.
public void	setPageNumber(int The page for a remote destination. pageNumber) Set the page number for a remote destination.

Inherited from org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination:: create

array	back to summary
protected final COSArray array Storage for the page destination.

PDPageDestination	back to summary
protected PDPageDestination() Constructor to create empty page destination.

PDPageDestination	back to summary
protected PDPageDestination(COSArray arr) Constructor to create empty page destination. Parameters arr:COSArray A page destination array.

Method Detail

getCOSObject	back to summary
public COSArray getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object. Returns:COSArray The cos object that matches this Java object. Annotations @Override

getCOSObject

back to summary

public COSArray getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSArray

The cos object that matches this Java object.

Annotations

@Override

getPage back to summary

getPage	back to summary
public PDPage 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 and `getPageNumber()` should be used. Returns:PDPage The page for this destination.

public PDPage 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 and getPageNumber() should be used.

Returns:PDPage: The page for this destination.

getPageNumber	back to summary
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:int The zero-based page number for this destination.

getPageNumber

back to summary

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:int: The zero-based page number for this destination.

indexOfPageTree	back to summary
private int indexOfPageTree(COSDictionary pageDict)

retrievePageNumber back to summary

retrievePageNumber	back to summary
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:int the 0-based page number, or -1 if the destination type is unknown. See Also `org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem`

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:int: the 0-based page number, or -1 if the destination type is unknown.
See Also: org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem

setPage back to summary

setPage	back to summary
public void setPage(PDPage page) Set the page for a local destination. For an external destination, call `setPageNumber(int pageNumber)`. Parameters page:PDPage The page for a local destination.

public void setPage(PDPage page)

Set the page for a local destination. For an external destination, call setPageNumber(int pageNumber).

Parameters

page:PDPage: The page for a local destination.

setPageNumber back to summary

setPageNumber	back to summary
public void setPageNumber(int pageNumber) Set the page number for a remote destination. For an internal destination, call `setPage(PDPage page)`. Parameters pageNumber:int The page for a remote destination.

public void setPageNumber(int pageNumber)

Set the page number for a remote destination. For an internal destination, call setPage(PDPage page).

Parameters

pageNumber:int: The page for a remote destination.

public abstract Class PDPageDestination

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail