Package org.openpdf.renderer

Class PDFDestination

java.lang.Object
org.openpdf.renderer.PDFDestination
public class PDFDestination extends Object
Represents a destination in a PDF file. Destinations take 3 forms:
  • An explicit destination, which contains a reference to a page as well as some stuff about how to fit it into the window.
  • A named destination, which uses the PDF file's Dests entry in the document catalog to map a name to an explicit destination
  • A string destintation, which uses the PDF file's Dests entry. in the name directory to map a string to an explicit destination.
All three of these cases are handled by the getDestination() method.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private float
    bottom
    the bottom coordinate of the fit area, if applicable
    static final int
    FIT
     
    static final int
    FITB
     
    static final int
    FITBH
     
    static final int
    FITBV
     
    static final int
    FITH
     
    static final int
    FITR
     
    static final int
    FITV
     
    private float
    left
    the left coordinate of the fit area, if applicable
    private PDFObject
    pageObj
    the page we refer to
    private float
    right
    the right coordinate of the fit area, if applicable
    private float
    top
    the top coordinate of the fit area, if applicable
    private int
    type
    the type of this destination (from the list above)
    static final int
    XYZ
    The known types of destination
    private float
    zoom
    the zoom, if applicable

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    PDFDestination(PDFObject pageObj, int type)
    Creates a new instance of PDFDestination

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    getBottom()
    Get the bottom coordinate value
    private static PDFObject
    getDestFromName(PDFObject name, PDFObject root)
    Get a destination, given a name.
    private static PDFObject
    getDestFromString(PDFObject str, PDFObject root)
    Get a destination, given a string.
    static PDFDestination
    getDestination(PDFObject obj, PDFObject root)
    Get a destination from either an array (explicit destination), a name (named destination) or a string (name tree destination).
    float
    getLeft()
    Get the left coordinate value
    PDFObject
    getPage()
    Get the PDF Page object associated with this destination
    float
    getRight()
    Get the right coordinate value
    float
    getTop()
    Get the top coordinate value
    int
    getType()
    Get the type of this destination
    float
    getZoom()
    Get the zoom value
    void
    setBottom(float bottom)
    Set the bottom coordinate value
    void
    setLeft(float left)
    Set the left coordinate value
    void
    setRight(float right)
    Set the right coordinate value
    void
    setTop(float top)
    Set the top coordinate value
    void
    setZoom(float zoom)
    Set the zoom value

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • XYZ

      public static final int XYZ
      The known types of destination
      See Also:

    • FIT

      public static final int FIT
      See Also:

    • FITH

      public static final int FITH
      See Also:

    • FITV

      public static final int FITV
      See Also:

    • FITR

      public static final int FITR
      See Also:

    • FITB

      public static final int FITB
      See Also:

    • FITBH

      public static final int FITBH
      See Also:

    • FITBV

      public static final int FITBV
      See Also:

    • type

      private int type
      the type of this destination (from the list above)

    • pageObj

      private PDFObject pageObj
      the page we refer to

    • left

      private float left
      the left coordinate of the fit area, if applicable

    • top

      private float top
      the top coordinate of the fit area, if applicable

    • bottom

      private float bottom
      the bottom coordinate of the fit area, if applicable

    • zoom

      private float zoom
      the zoom, if applicable

  • Constructor Details

    • PDFDestination

      protected PDFDestination(PDFObject pageObj, int type)
      Creates a new instance of PDFDestination
      Parameters:
      pageObj - the page object this destination refers to
      type - the type of page this object refers to

  • Method Details

    • getDestination

      public static PDFDestination getDestination(PDFObject obj, PDFObject root) throws IOException
      Get a destination from either an array (explicit destination), a name (named destination) or a string (name tree destination).
      Parameters:
      obj - the PDFObject representing this destination
      root - the root of the PDF object tree
      Throws:
      IOException

    • getType

      public int getType()
      Get the type of this destination

    • getPage

      public PDFObject getPage()
      Get the PDF Page object associated with this destination

    • getLeft

      public float getLeft()
      Get the left coordinate value

    • setLeft

      public void setLeft(float left)
      Set the left coordinate value

    • getRight

      public float getRight()
      Get the right coordinate value

    • setRight

      public void setRight(float right)
      Set the right coordinate value

    • getTop

      public float getTop()
      Get the top coordinate value

    • setTop

      public void setTop(float top)
      Set the top coordinate value

    • getBottom

      public float getBottom()
      Get the bottom coordinate value

    • setBottom

      public void setBottom(float bottom)
      Set the bottom coordinate value

    • getZoom

      public float getZoom()
      Get the zoom value

    • setZoom

      public void setZoom(float zoom)
      Set the zoom value

    • getDestFromName

      private static PDFObject getDestFromName(PDFObject name, PDFObject root) throws IOException
      Get a destination, given a name. This means the destination is in the root node's dests dictionary.
      Throws:
      IOException

    • getDestFromString

      private static PDFObject getDestFromString(PDFObject str, PDFObject root) throws IOException
      Get a destination, given a string. This means the destination is in the root node's names dictionary.
      Throws:
      IOException