Class PDActionEmbeddedGoTo
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.action.PDAction
org.apache.pdfbox.pdmodel.interactive.action.PDActionEmbeddedGoTo
- All Implemented Interfaces:
COSObjectable
,PDDestinationOrAction
This represents a embedded go-to action that can be executed in a PDF document.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionThis will get the destination to jump to.getFile()
This will get the file in which the destination is located.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.Get the target directory.void
This will set the destination to jump to.void
This will set the file in which the destination is located.void
setOpenInNewWindow
(OpenMode value) This will specify whether to open the destination document in a new window.void
setTargetDirectory
(PDTargetDirectory targetDirectory) Sets the target directory.Methods inherited from class org.apache.pdfbox.pdmodel.interactive.action.PDAction
getCOSObject, getNext, getSubType, getType, setNext, setSubType, setType
-
Field Details
-
SUB_TYPE
This type of action this object represents.- See Also:
-
-
Constructor Details
-
PDActionEmbeddedGoTo
public PDActionEmbeddedGoTo()Default constructor. -
PDActionEmbeddedGoTo
Constructor.- Parameters:
a
- The action dictionary.
-
-
Method Details
-
getDestination
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.
-
getFile
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
This will set the file in which the destination is located.- Parameters:
fs
- The file specification.
-
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
This will specify whether to open the destination document in a new window.- Parameters:
value
- The flag value.
-
getTargetDirectory
Get the target directory.- Returns:
- the target directory or null if there is none.
-
setTargetDirectory
Sets the target directory.- Parameters:
targetDirectory
- the target directory.
-