Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.action

public Class PDActionGoTo

extends PDAction
Class Inheritance
Imports
java.io.IOException, org.apache.pdfbox.cos.COSArray, .COSBase, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination, .PDPageDestination

This represents a go-to action that can be executed in a PDF document.
Authors
Ben Litchfield, Panagiotis Toumasis

Field Summary

Modifier and TypeField and Description
public static final String
SUB_TYPE

This type of action this object represents.

Inherited from org.apache.pdfbox.pdmodel.interactive.action.PDAction:
actionTYPE

Constructor Summary

AccessConstructor and Description
public
PDActionGoTo()

Default constructor.

public
PDActionGoTo(COSDictionary
The action dictionary.
a
)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public PDDestination

Returns:

The D entry of the specific go-to action dictionary.
getDestination
()

This will get the destination to jump to.

public void
setDestination(PDDestination
The destination.
d
)

This will set the destination to jump to.

Inherited from org.apache.pdfbox.pdmodel.interactive.action.PDAction:
getCOSObjectgetNextgetSubTypegetTypesetNextsetSubTypesetType

Field Detail

SUB_TYPEback to summary
public static final String SUB_TYPE

This type of action this object represents.

Constructor Detail

PDActionGoToback to summary
public PDActionGoTo()

Default constructor.

PDActionGoToback to summary
public PDActionGoTo(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

The action dictionary.

Method Detail

getDestinationback to summary
public PDDestination getDestination() throws IOException

This will get the destination to jump to.

Returns:PDDestination

The D entry of the specific go-to action dictionary.

Exceptions
IOException:
If there is an error creating the destination.
setDestinationback to summary
public void setDestination(PDDestination d)

This will set the destination to jump to.

Parameters
d:PDDestination

The destination.

Exceptions
IllegalArgumentException:
if the destination is not a page dictionary object.