Module org.sejda.sambox
Package org.sejda.sambox.pdmodel.interactive.action

Class PDActionRemoteGoTo

java.lang.Object
org.sejda.sambox.pdmodel.interactive.action.PDAction
org.sejda.sambox.pdmodel.interactive.action.PDActionRemoteGoTo
All Implemented Interfaces:
COSObjectable, PDDestinationOrAction
public class PDActionRemoteGoTo extends PDAction
This represents a remote go-to action that can be executed in a PDF document.
Author:
Ben Litchfield, Panagiotis Toumasis

  • Field Details

  • Constructor Details

    • PDActionRemoteGoTo

      public PDActionRemoteGoTo()
      Default constructor.

    • PDActionRemoteGoTo

      public PDActionRemoteGoTo(COSDictionary a)
      Constructor.
      Parameters:
      a - The action dictionary.

  • Method Details

    • getS

      @Deprecated public String getS()
      Deprecated.
      use PDAction.getSubType().
      This will get the type of action that the actions dictionary describes. It must be GoToR for a remote go-to action.
      Returns:
      The S entry of the specific remote go-to action dictionary.

    • setS

      @Deprecated public void setS(String s)
      Deprecated.
      use PDAction.getSubType().
      This will set the type of action that the actions dictionary describes. It must be GoToR for a remote go-to action.
      Parameters:
      s - The remote go-to action.

    • getFile

      public PDFileSpecification getFile()
      This will get the file in which the destination is located.
      Returns:
      The F entry of the specific remote go-to action dictionary.

    • setFile

      public void setFile(PDFileSpecification fs)
      This will set the file in which the destination is located.
      Parameters:
      fs - The file specification.

    • getD

      public COSBase getD()
      This will get the destination to jump to. If the value is an array defining an explicit destination, its first element must be a page number within the remote document rather than an indirect reference to a page object in the current document. The first page is numbered 0.
      Returns:
      The D entry of the specific remote go-to action dictionary.

    • setD

      public void setD(COSBase d)
      This will set the destination to jump to. If the value is an array defining an explicit destination, its first element must be a page number within the remote document rather than an indirect reference to a page object in the current document. The first page is numbered 0.
      Parameters:
      d - The destination.

    • getOpenInNewWindow

      public OpenMode getOpenInNewWindow()
      This will specify whether to open the destination document in a new window, in the same window, or behave in accordance with the current user preference.
      Returns:
      A flag specifying how to open the destination document.

    • setOpenInNewWindow

      public void setOpenInNewWindow(OpenMode value)
      This will specify whether to open the destination document in a new window.
      Parameters:
      value - The flag value.