Class PDActionEmbeddedGoTo

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.action.PDAction
org.apache.pdfbox.pdmodel.interactive.action.PDActionEmbeddedGoTo
All Implemented Interfaces:
COSObjectable, PDDestinationOrAction

public class PDActionEmbeddedGoTo extends PDAction
This represents a embedded go-to action that can be executed in a PDF document.
  • Field Details

  • Constructor Details

    • PDActionEmbeddedGoTo

      public PDActionEmbeddedGoTo()
      Default constructor.
    • PDActionEmbeddedGoTo

      public PDActionEmbeddedGoTo(COSDictionary a)
      Constructor.
      Parameters:
      a - The action dictionary.
  • Method Details

    • getDestination

      public PDDestination getDestination() throws IOException
      This will get the destination to jump to.
      Returns:
      The D entry of the specific go-to action dictionary.
      Throws:
      IOException - If there is an error creating the destination.
    • setDestination

      public void setDestination(PDDestination d)
      This will set the destination to jump to.
      Parameters:
      d - The destination.
      Throws:
      IllegalArgumentException - if the destination is not a page dictionary object.
    • getFile

      public PDFileSpecification getFile() throws IOException
      This will get the file in which the destination is located.
      Returns:
      The F entry of the specific embedded go-to action dictionary.
      Throws:
      IOException - If there is an error creating the file spec.
    • setFile

      public void setFile(PDFileSpecification fs)
      This will set the file in which the destination is located.
      Parameters:
      fs - The file specification.
    • 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.
    • getTargetDirectory

      public PDTargetDirectory getTargetDirectory()
      Get the target directory.
      Returns:
      the target directory or null if there is none.
    • setTargetDirectory

      public void setTargetDirectory(PDTargetDirectory targetDirectory)
      Sets the target directory.
      Parameters:
      targetDirectory - the target directory.