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

public Class PDActionEmbeddedGoTo

extends PDAction
Class Inheritance
Imports
java.io.IOException, org.apache.pdfbox.cos.COSArray, .COSBase, .COSBoolean, .COSDictionary, .COSInteger, .COSName, org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification, org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination, .PDPageDestination
This represents a embedded go-to action that can be executed in a PDF document.
Authors
Ben Litchfield, Panagiotis Toumasis, Tilman Hausherr

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
PDActionEmbeddedGoTo()

Default constructor.

public
PDActionEmbeddedGoTo(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 PDFileSpecification

Returns:

The F entry of the specific embedded go-to action dictionary.
getFile()

This will get the file in which the destination is located.

public OpenMode

Returns:

A flag specifying how to open the destination document.
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.

public PDTargetDirectory

Returns:

the target directory or null if there is none.
getTargetDirectory()

Get the target directory.

public void
setDestination(PDDestination
The destination.
d)

This will set the destination to jump to.

public void
setFile(PDFileSpecification
The file specification.
fs)

This will set the file in which the destination is located.

public void
setOpenInNewWindow(OpenMode
The flag value.
value)

This will specify whether to open the destination document in a new window.

public void
setTargetDirectory(PDTargetDirectory
the target directory
targetDirectory)

Sets the target directory.

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

PDActionEmbeddedGoToback to summary
public PDActionEmbeddedGoTo()

Default constructor.

PDActionEmbeddedGoToback to summary
public PDActionEmbeddedGoTo(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.
getFileback to summary
public PDFileSpecification getFile() throws IOException

This will get the file in which the destination is located.

Returns:PDFileSpecification

The F entry of the specific embedded go-to action dictionary.

Exceptions
IOException:
If there is an error creating the file spec.
getOpenInNewWindowback to summary
public OpenMode 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:OpenMode

A flag specifying how to open the destination document.

getTargetDirectoryback to summary
public PDTargetDirectory getTargetDirectory()

Get the target directory.

Returns:PDTargetDirectory

the target directory or null if there is none.

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.
setFileback to summary
public void setFile(PDFileSpecification fs)

This will set the file in which the destination is located.

Parameters
fs:PDFileSpecification

The file specification.

setOpenInNewWindowback to summary
public void setOpenInNewWindow(OpenMode value)

This will specify whether to open the destination document in a new window.

Parameters
value:OpenMode

The flag value.

setTargetDirectoryback to summary
public void setTargetDirectory(PDTargetDirectory targetDirectory)

Sets the target directory.

Parameters
targetDirectory:PDTargetDirectory

the target directory