Class PdfExplicitRemoteGoToDestination


  • public class PdfExplicitRemoteGoToDestination
    extends PdfDestination
    This class shall be used for creation of destinations, associated Remote Go-To and Embedded Go-To actions only, i.e. the destination point is in another PDF. If you need to create a destination, associated with an object inside current PDF, you should use PdfExplicitDestination class instead.
    • Constructor Detail

      • PdfExplicitRemoteGoToDestination

        public PdfExplicitRemoteGoToDestination()
      • PdfExplicitRemoteGoToDestination

        public PdfExplicitRemoteGoToDestination​(PdfArray pdfObject)
    • Method Detail

      • createXYZ

        public static PdfExplicitRemoteGoToDestination createXYZ​(int pageNum,
                                                                 float left,
                                                                 float top,
                                                                 float zoom)
        Creates PdfExplicitRemoteGoToDestination. 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:
        pageNum - 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 PdfExplicitRemoteGoToDestination
      • createFitR

        public static PdfExplicitRemoteGoToDestination createFitR​(int pageNum,
                                                                  float left,
                                                                  float bottom,
                                                                  float right,
                                                                  float top)
        Creates PdfExplicitRemoteGoToDestination. 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:
        pageNum - 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 PdfExplicitRemoteGoToDestination
      • create

        public static PdfExplicitRemoteGoToDestination create​(int pageNum,
                                                              PdfName type,
                                                              float left,
                                                              float bottom,
                                                              float right,
                                                              float top,
                                                              float zoom)
        Creates a PdfExplicitRemoteGoToDestination associated with an object in another PDF document.
        Parameters:
        pageNum - 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.