Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination » [javadoc | source]
org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
abstract public class: PDPageDestination [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
      org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination

All Implemented Interfaces:
    PDDestinationOrAction

Direct Known Subclasses:
    PDPageXYZDestination, PDPageFitWidthDestination, PDPageFitRectangleDestination, PDPageFitDestination, PDPageFitHeightDestination

This represents a destination to a page, see subclasses for specific parameters.
Field Summary
protected  COSArray array    Storage for the page destination. 
Constructor:
 protected PDPageDestination() 
 protected PDPageDestination(COSArray arr) 
    Constructor to create empty page destination.
    Parameters:
    arr - A page destination array.
Method from org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination Summary:
findPageNumber,   getCOSArray,   getCOSObject,   getPage,   getPageNumber,   setPage,   setPageNumber
Methods from org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination:
create,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination Detail:
 public int findPageNumber() 
    Returns the page number for this destination, regardless of whether this is a page number or a reference to a page.
 public COSArray getCOSArray() 
    Convert this standard java object to a COS object.
 public COSBase getCOSObject() 
    Convert this standard java object to a COS object.
 public PDPage getPage() 
    This will get the page for this destination. A page destination can either reference a page 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.
 public int getPageNumber() 
    This will get the page number for this destination. A page destination can either reference a page 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.
 public  void setPage(PDPage page) 
    Set the page for this destination.
 public  void setPageNumber(int pageNumber) 
    Set the page number for this destination.