Class PDActionRemoteGoTo
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.action.PDAction
org.apache.pdfbox.pdmodel.interactive.action.PDActionRemoteGoTo
- All Implemented Interfaces:
COSObjectable
,PDDestinationOrAction
This represents a remote go-to action that can be executed in a PDF document.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Constructor. -
Method Summary
Modifier and TypeMethodDescriptiongetD()
This 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.getS()
Deprecated.void
This will set the destination to jump to.void
This will set the file in which the destination is located.void
setOpenInNewWindow
(boolean value) Deprecated.void
setOpenInNewWindow
(OpenMode value) This will specify whether to open the destination document in a new window.void
Deprecated.boolean
Deprecated.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
-
PDActionRemoteGoTo
public PDActionRemoteGoTo()Default constructor. -
PDActionRemoteGoTo
Constructor.- Parameters:
a
- The action dictionary.
-
-
Method Details
-
getS
Deprecated.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.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
This will get the file in which the destination is located.- Returns:
- The F entry of the specific remote 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.
-
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
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.
-
shouldOpenInNewWindow
Deprecated.This will specify whether to open the destination document in a new window. If this flag is false, the destination document will replace the current document in the same window. If this entry is absent, the viewer application should behave in accordance with the current user preference.- Returns:
- A flag specifying whether to open the destination document in a new window.
-
setOpenInNewWindow
Deprecated.This will specify the destination document to open in a new window.- Parameters:
value
- The flag value.
-
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.
-
PDAction.getSubType()
.