Package com.itextpdf.kernel.pdf.navigation

Class PdfExplicitDestination

java.lang.Object
com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfObject>
com.itextpdf.kernel.pdf.navigation.PdfDestination
com.itextpdf.kernel.pdf.navigation.PdfExplicitDestination
public class PdfExplicitDestination extends PdfDestination
This class shall be used for creation of destinations, associated with outline items, annotations or actions within current document. If you need to create a destination, associated with an object in another PDF (e.g. Remote Go-To actions or Embedded Go-To actions), you should use PdfExplicitRemoteGoToDestination class instead. Note that despite methods with integer value for page parameter are deprecated in this class, Adobe Acrobat handles such destinations correctly, but removes them completely from a PDF, when it is saved as an optimized pdf with the "discard-invalid-links" option. Therefore it is strongly recommended to use methods accepting pdfPage instance, if the destination is inside of the current document.

  • Constructor Details

    • PdfExplicitDestination

      public PdfExplicitDestination()

    • PdfExplicitDestination

      public PdfExplicitDestination (PdfArray pdfObject)

  • Method Details

    • getDestinationPage

      public PdfObject getDestinationPage (Map<String,PdfObject> names)
      Specified by:
      getDestinationPage in class PdfDestination

    • createXYZ

      public static PdfExplicitDestination createXYZ (PdfPage page, float left, float top, float zoom)
      Creates PdfExplicitDestination. The designated page will be displayed with its contents magnified by the factor zoom and positioned at the upper-left corner of the window.
      Parameters:
      page - the destination page
      left - the X coordinate of the left edge of the destination rectangle
      top - the Y coordinate of the upper edge of the destination rectangle
      zoom - zoom factor
      Returns:
      newly created PdfExplicitDestination

    • createFit

      public static PdfExplicitDestination createFit (PdfPage page)
      Creates PdfExplicitDestination. The designated page will be displayed with its contents magnified just enough to fit the entire page within the window both horizontally and vertically.
      Parameters:
      page - the destination page
      Returns:
      newly created PdfExplicitDestination

    • createFitH

      public static PdfExplicitDestination createFitH (PdfPage page, float top)
      Creates PdfExplicitDestination. The designated page will be displayed with its contents magnified just enough to fit the entire width of the page within the window.
      Parameters:
      page - the destination page
      top - the Y coordinate of the upper edge of the destination rectangle
      Returns:
      newly created PdfExplicitDestination

    • createFitV

      public static PdfExplicitDestination createFitV (PdfPage page, float left)
      Creates PdfExplicitDestination. The designated page will be displayed with its contents magnified just enough to fit the entire height of the page within the window.
      Parameters:
      page - the destination page
      left - the X coordinate of the left edge of the destination rectangle
      Returns:
      newly created PdfExplicitDestination

    • createFitR

      public static PdfExplicitDestination createFitR (PdfPage page, float left, float bottom, float right, float top)
      Creates PdfExplicitDestination. The designated page will be displayed with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically.
      Parameters:
      page - the destination page
      left - the X coordinate of the left edge of the destination rectangle
      bottom - the Y coordinate of the lower edge of the destination rectangle
      right - the X coordinate of the right edge of the destination rectangle
      top - the Y coordinate of the upper edge of the destination rectangle
      Returns:
      newly created PdfExplicitDestination

    • createFitB

      public static PdfExplicitDestination createFitB (PdfPage page)
      Creates PdfExplicitDestination. The designated page will be displayed with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically.
      Parameters:
      page - the destination page
      Returns:
      newly created PdfExplicitDestination

    • createFitBH

      public static PdfExplicitDestination createFitBH (PdfPage page, float top)
      Creates PdfExplicitDestination. The designated page will be displayed with its contents magnified just enough to fit the entire width of its bounding box within the window.
      Parameters:
      page - the destination page
      top - the Y coordinate of the upper edge of the destination rectangle
      Returns:
      newly created PdfExplicitDestination

    • createFitBV

      public static PdfExplicitDestination createFitBV (PdfPage page, float left)
      Creates PdfExplicitDestination. The designated page will be displayed with its contents magnified just enough to fit the entire height of its bounding box within the window.
      Parameters:
      page - the destination page
      left - the X coordinate of the left edge of the destination rectangle
      Returns:
      newly created PdfExplicitDestination

    • create

      public static PdfExplicitDestination create (PdfPage page, PdfName type, float left, float bottom, float right, float top, float zoom)
      Creates a PdfExplicitDestination associated with an object inside current PDF document.
      Parameters:
      page - the destination page
      type - a PdfName specifying one of the possible ways to define the area to be displayed. See ISO 32000-1, section 12.3.2.2 "Explicit Destinations", Table 151 – Destination syntax
      left - the X coordinate of the left edge of the destination rectangle
      bottom - the Y coordinate of the lower edge of the destination rectangle
      right - the X coordinate of the right edge of the destination rectangle
      top - the Y coordinate of the upper edge of the destination rectangle
      zoom - zoom factor
      Returns:
      newly created PdfExplicitDestination

    • isWrappedObjectMustBeIndirect

      protected boolean isWrappedObjectMustBeIndirect()
      Description copied from class: PdfObjectWrapper
      Defines if the object behind this wrapper must be an indirect object in the resultant document.

      If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

      Return value of this method shouldn't depend on any logic, it should return always true or false.
      Specified by:
      isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfObject>
      Returns:
      true if in the resultant document the object behind the wrapper must be indirect, otherwise false.