Class GoToEAction

java.lang.Object

org.openpdf.renderer.action.PDFAction

org.openpdf.renderer.action.GoToEAction

public class GoToEAction
extends PDFAction

Action directing to a location within an embedded PDF document

Since:

07.07.2009

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GoToEAction.GoToETarget	Inner class for holding the target dictionary's information

Field Summary

Fields

Modifier and Type	Field	Description
private PDFDestination	destination	the destination within the remote PDF file
private String	file	the remote file this action refers to (optional)
private boolean	newWindow	Should the remote file be opened in a new window? (optional)
private GoToEAction.GoToETarget	target	The target dictionary

Constructor Summary

Constructors

Constructor	Description
GoToEAction(PDFDestination dest, String file, boolean newWindow)	Create a new GoToEAction from the given attributes
GoToEAction(PDFObject obj, PDFObject root)	Creates a new instance of GoToEAction from an object

Method Summary

Modifier and Type	Method	Description
PDFDestination	getDestination()	Get the destination this action refers to
String	getFile()	Get the file this action refers to
GoToEAction.GoToETarget	getTarget()	Get the target dictionary
boolean	isNewWindow()	Should the remote file be opened in a new window?
private GoToEAction.GoToETarget	parseTargetDistionary(PDFObject targetObj, ArrayList<GoToEAction.GoToETarget> list)	Parse a target dictionary if available

Methods inherited from class PDFAction

getAction, getNext, getType, setNext

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

destination

private PDFDestination destination

the destination within the remote PDF file

file

private String file

the remote file this action refers to (optional)

newWindow

private boolean newWindow

Should the remote file be opened in a new window? (optional)

target

private GoToEAction.GoToETarget target

The target dictionary

Constructor Details

GoToEAction

public GoToEAction(PDFObject obj,
 PDFObject root)
            throws IOException

Creates a new instance of GoToEAction from an object

Parameters:

obj - the PDFObject with the action information

Throws:

IOException - - in case the action can not be parsed

GoToEAction

public GoToEAction(PDFDestination dest,
 String file,
 boolean newWindow)

Create a new GoToEAction from the given attributes

Parameters:

dest -

file -

newWindow -

Method Details

parseTargetDistionary

private GoToEAction.GoToETarget parseTargetDistionary(PDFObject targetObj,
 ArrayList<GoToEAction.GoToETarget> list)
                                               throws IOException

Parse a target dictionary if available

Parameters:

targetObj -

list - - a list of all already parsed targets, for not getting in an endless loop (if a target is found which is already contained, the recursive calling of this method will stop).

Throws:

IOException - - in case a value can not be parsed

getDestination

public PDFDestination getDestination()

Get the destination this action refers to

Returns:

PDFDestination

getFile

public String getFile()

Get the file this action refers to

Returns:

PDFDestination

isNewWindow

public boolean isNewWindow()

Should the remote file be opened in a new window?

Returns:

boolean

getTarget

public GoToEAction.GoToETarget getTarget()

Get the target dictionary

Returns:

GoToETarget