org.apache.fop.pdf

## Class PDFGoToRemote

- java.lang.Object
- - org.apache.fop.pdf.PDFObject
  - - org.apache.fop.pdf.PDFAction
    - - org.apache.fop.pdf.PDFGoToRemote

- All Implemented Interfaces:
    PDFWritable

      public class PDFGoToRemote
      extends PDFAction

  Class representing a /GoToR object.

- - ### Field Summary

    - ### Fields inherited from class org.apache.fop.pdf.PDFObject

      `log`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `PDFGoToRemote(PDFFileSpec pdfFileSpec, boolean newWindow)` Create an GoToR object.
    `PDFGoToRemote(PDFFileSpec pdfFileSpec, int page, boolean newWindow)` Create an GoToR object.
    `PDFGoToRemote(PDFFileSpec pdfFileSpec, String dest, boolean newWindow)` create an GoToR object.
    `PDFGoToRemote(PDFReference pdfFileSpec, int page, boolean newWindow)` Create an GoToR object.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected boolean` | `contentEquals(PDFObject obj)` Check if the other PDFObject has the same content as the current object.
    `String` | `getAction()` return the action string which will reference this object
    `String` | `toPDFString()` This method returns a String representation of the PDF object.

    - ### Methods inherited from class org.apache.fop.pdf.PDFAction

      `encodeScript`

    - ### Methods inherited from class org.apache.fop.pdf.PDFObject

      `encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getChildren, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, output, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, toPDF`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### PDFGoToRemote

          public PDFGoToRemote(PDFFileSpec pdfFileSpec,
                               boolean newWindow)

      Create an GoToR object.
      Parameters:
        `pdfFileSpec` - the fileSpec associated with the action
        `newWindow` - boolean indicating whether the target should be displayed in a new window

    - #### PDFGoToRemote

          public PDFGoToRemote(PDFFileSpec pdfFileSpec,
                               int page,
                               boolean newWindow)

      Create an GoToR object.
      Parameters:
        `pdfFileSpec` - the fileSpec associated with the action
        `page` - a page reference within the remote document
        `newWindow` - boolean indicating whether the target should be displayed in a new window

    - #### PDFGoToRemote

          public PDFGoToRemote(PDFReference pdfFileSpec,
                               int page,
                               boolean newWindow)

      Create an GoToR object.
      Parameters:
        `pdfFileSpec` - the fileSpec associated with the action
        `page` - a page reference within the remote document
        `newWindow` - boolean indicating whether the target should be displayed in a new window

    - #### PDFGoToRemote

          public PDFGoToRemote(PDFFileSpec pdfFileSpec,
                               String dest,
                               boolean newWindow)

      create an GoToR object.
      Parameters:
        `pdfFileSpec` - the fileSpec associated with the action
        `dest` - a named destination within the remote document
        `newWindow` - boolean indicating whether the target should be displayed in a new window

  - ### Method Detail

    - #### getAction

          public String getAction()

      return the action string which will reference this object
      Specified by:
        `getAction` in class `PDFAction`
      Returns:
        the action String

    - #### toPDFString

          public String toPDFString()

      This method returns a String representation of the PDF object. The result is normally converted/encoded to a byte array by toPDF(). Only use this method to implement the serialization if the object can be fully represented as text. If the PDF representation of the object contains binary content use toPDF() or output(OutputStream) instead. This applies to any object potentially containing a string object because string object are encrypted and therefore need to be binary.
      Overrides:
        `toPDFString` in class `PDFObject`
      Returns:
        String the String representation

    - #### contentEquals

          protected boolean contentEquals(PDFObject obj)

      Check if the other PDFObject has the same content as the current object.

      Note: This function has a contract which is less binding than `Object.equals(Object)`. Whereas equals would require all values to be identical, this method is not required to check everything. In the case of PDFObjects, this means that the overriding function does not have to check for `PDFObject.getObjectID()`.

      Overrides:
        `contentEquals` in class `PDFObject`
      Parameters:
        `obj` - object to compare to.
      Returns:
        true if the other object has the same content.

Copyright © 2023 Apache Software Foundation. All rights reserved.