org.pdfbox.pdmodel.interactive.action.type

Class PDActionGoTo

Implemented Interfaces:
COSObjectable, PDDestinationOrAction

public class PDActionGoTo
extends PDAction

This represents a go-to action that can be executed in a PDF document.
Version:
$Revision: 1.2 $
Authors:
Ben Litchfield
Panagiotis Toumasis (ptoumasis@mail.gr)

Field Summary

static String
SUB_TYPE
This type of action this object represents.

Fields inherited from class org.pdfbox.pdmodel.interactive.action.type.PDAction

TYPE, action

Constructor Summary

PDActionGoTo()
Default constructor.
PDActionGoTo(COSDictionary a)
Constructor.

Method Summary

PDDestination
getDestination()
This will get the destination to jump to.
void
setDestination(PDDestination d)
This will set the destination to jump to.

Methods inherited from class org.pdfbox.pdmodel.interactive.action.type.PDAction

getCOSDictionary, getCOSObject, getNext, getSubType, getType, setNext, setSubType, setType

Field Details

SUB_TYPE

public static final String SUB_TYPE
This type of action this object represents.

Constructor Details

PDActionGoTo

public PDActionGoTo()
Default constructor.

PDActionGoTo

public PDActionGoTo(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.

setDestination

public void setDestination(PDDestination d)
This will set the destination to jump to.
Parameters:
d - The destination.