Class PDActionGoTo
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.interactive.action.PDAction
-
- org.apache.pdfbox.pdmodel.interactive.action.PDActionGoTo
-
- All Implemented Interfaces:
COSObjectable,PDDestinationOrAction
public class PDActionGoTo extends PDAction
This represents a go-to action that can be executed in a PDF document.- Author:
- Ben Litchfield, Panagiotis Toumasis
-
-
Constructor Summary
Constructors Constructor Description PDActionGoTo()Default constructor.PDActionGoTo(COSDictionary a)Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PDDestinationgetDestination()This will get the destination to jump to.voidsetDestination(PDDestination d)This will set the destination to jump to.-
Methods inherited from class org.apache.pdfbox.pdmodel.interactive.action.PDAction
getCOSObject, getNext, getSubType, getType, setNext, setSubType, setType
-
-
-
-
Field Detail
-
SUB_TYPE
public static final java.lang.String SUB_TYPE
This type of action this object represents.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PDActionGoTo
public PDActionGoTo()
Default constructor.
-
PDActionGoTo
public PDActionGoTo(COSDictionary a)
Constructor.- Parameters:
a- The action dictionary.
-
-
Method Detail
-
getDestination
public PDDestination getDestination() throws java.io.IOException
This will get the destination to jump to.- Returns:
- The D entry of the specific go-to action dictionary.
- Throws:
java.io.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:
java.lang.IllegalArgumentException- if the destination is not a page dictionary object.
-
-