Field Detail

• array

  protected COSArray array

  Storage for the page destination.

Constructor Detail

• PDPageDestination

  protected PDPageDestination()

  Constructor to create empty page destination.

• PDPageDestination

  protected PDPageDestination(COSArray arr)

  Constructor to create empty page destination.

  Parameters:

  arr - A page destination array.

Method Detail

• getPage

  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:

  The page for this destination.

• setPage

  public void setPage(PDPage page)

  Set the page for this destination.

  Parameters:

  page - The page for the 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
  public int findPageNumber()

  Deprecated. This method has inconsistent behavior (see returns), use retrievePageNumber() 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:

  PDOutlineItem

• 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:

  PDOutlineItem

• setPageNumber

  public void setPageNumber(int pageNumber)

  Set the page number for this destination.

  Parameters:

  pageNumber - The page for the destination.

• getCOSObject

  public COSArray getCOSObject()

  Convert this standard java object to a COS object.

  Returns:

  The cos object that matches this Java object.