Package org.openpdf.text.pdf

Class PdfAction

java.lang.Object

org.openpdf.text.pdf.PdfObject

org.openpdf.text.pdf.PdfDictionary

org.openpdf.text.pdf.PdfAction

public class PdfAction
extends PdfDictionary

A PdfAction defines an action that can be triggered from a PDF file.

See Also:

• PdfDictionary

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FIRSTPAGE	A named action to go to the first page.
static final int	LASTPAGE	A named action to go to the last page.
static final int	NEXTPAGE	A named action to go to the next page.
static final int	PREVPAGE	A named action to go to the previous page.
static final int	PRINTDIALOG	A named action to open a print dialog.

Fields inherited from class org.openpdf.text.pdf.PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class org.openpdf.text.pdf.PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor	Description
PdfAction()	Create an empty action.
PdfAction(int named)	Implements name actions.
PdfAction(String url)	Constructs a new PdfAction of Subtype URI.
PdfAction(String url, boolean isMap)	Construct a new PdfAction of Subtype URI that accepts the x and y coordinate of the position that was clicked.
PdfAction(String filename, int page)	Constructs a new PdfAction of Subtype GoToR.
PdfAction(String filename, String name)	Constructs a new PdfAction of Subtype GoToR.
PdfAction(URL url)	Constructs a new PdfAction of Subtype URI.
PdfAction(URL url, boolean isMap)	Construct a new PdfAction of Subtype URI that accepts the x and y coordinate of the position that was clicked.

Method Summary

Methods inherited from class org.openpdf.text.pdf.PdfDictionary

contains, get, getAsDict, getDirectObject, getKeys, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString

Methods inherited from class org.openpdf.text.pdf.PdfObject

canBeInObjStm, getBytes, isArray, isDictionary, isName, isNull, isNumber, isString, setContent, type

Methods inherited from class java.lang.Object

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

Field Details

FIRSTPAGE

public static final int FIRSTPAGE

A named action to go to the first page.

See Also:

• Constant Field Values

PREVPAGE

public static final int PREVPAGE

A named action to go to the previous page.

See Also:

• Constant Field Values

NEXTPAGE

public static final int NEXTPAGE

A named action to go to the next page.

See Also:

• Constant Field Values

LASTPAGE

public static final int LASTPAGE

A named action to go to the last page.

See Also:

• Constant Field Values

PRINTDIALOG

public static final int PRINTDIALOG

A named action to open a print dialog.

See Also:

• Constant Field Values

Constructor Details

PdfAction

public PdfAction()

Create an empty action.

PdfAction

public PdfAction(URL url)

Constructs a new PdfAction of Subtype URI.

Parameters:

url - the Url to go to

PdfAction

public PdfAction(URL url,
 boolean isMap)

Construct a new PdfAction of Subtype URI that accepts the x and y coordinate of the position that was clicked.

Parameters:

url - the URL

isMap - true if it is a map, false otherwise

PdfAction

public PdfAction(String url)

Constructs a new PdfAction of Subtype URI.

Parameters:

url - the url to go to

PdfAction

public PdfAction(String url,
 boolean isMap)

Construct a new PdfAction of Subtype URI that accepts the x and y coordinate of the position that was clicked.

Parameters:

url - the URL

isMap - true if it is a map, false otherwise

PdfAction

public PdfAction(String filename,
 String name)

Constructs a new PdfAction of Subtype GoToR.

Parameters:

filename - the file name to go to

name - the named destination to go to

PdfAction

public PdfAction(String filename,
 int page)

Constructs a new PdfAction of Subtype GoToR.

Parameters:

filename - the file name to go to

page - the page destination to go to

PdfAction

public PdfAction(int named)

Implements name actions. The action can be FIRSTPAGE, LASTPAGE, NEXTPAGE, PREVPAGE and PRINTDIALOG.

Parameters:

named - the named action