Class LaunchAction

java.lang.Object

org.openpdf.renderer.action.PDFAction

org.openpdf.renderer.action.LaunchAction

public class LaunchAction
extends PDFAction

Action for launching an application, mostly used to open a file.

Since:

08.07.2009

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LaunchAction.FileSpec	Inner class for storing a file specification
class	LaunchAction.WinLaunchParam	Internal class for the windows specific launch parameters

Field Summary

Fields

Modifier and Type	Field	Description
private LaunchAction.FileSpec	file	the file/application to be opened (optional)
private PDFObject	macParam
private boolean	newWindow	should a new window be opened (optional)
static final String	SOLIDUS
private PDFObject	unixParam
private LaunchAction.WinLaunchParam	winParam

Constructor Summary

Constructors

Constructor	Description
LaunchAction(PDFObject obj, PDFObject root)	Creates a new instance of LaunchAction from an object

Method Summary

Modifier and Type	Method	Description
LaunchAction.FileSpec	getFileSpecification()	The file / application to be opened
PDFObject	getMacParam()	Get the mac specific launch parameters.
PDFObject	getUnixParam()	Get the unix specific launch parameters.
LaunchAction.WinLaunchParam	getWinParam()	Get the windows specific launch parameters.
static boolean	isAbsolute(String fileName)	Is the file name absolute (if not, it is relative to the path of the currently opened PDF file).
boolean	isNewWindow()	Should a new window be opened for the file/application?
private LaunchAction.FileSpec	parseFileSpecification(PDFObject fileObj)	Parse the file specification object
private LaunchAction.WinLaunchParam	parseWinDict(PDFObject winDict)	Parse the windows specific launch parameters

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

SOLIDUS

public static final String SOLIDUS

See Also:

• Constant Field Values

file

private LaunchAction.FileSpec file

the file/application to be opened (optional)

newWindow

private boolean newWindow

should a new window be opened (optional)

unixParam

private PDFObject unixParam

macParam

private PDFObject macParam

winParam

private LaunchAction.WinLaunchParam winParam

Constructor Details

LaunchAction

public LaunchAction(PDFObject obj,
 PDFObject root)
             throws IOException

Creates a new instance of LaunchAction from an object

Parameters:

obj - - the PDFObject with the action information

root - - the root object

Throws:

IOException

Method Details

isAbsolute

public static boolean isAbsolute(String fileName)

Is the file name absolute (if not, it is relative to the path of the currently opened PDF file). If the file name starts with a "/", it is considered to be absolute.

Returns:

boolean

parseFileSpecification

private LaunchAction.FileSpec parseFileSpecification(PDFObject fileObj)
                                              throws PDFParseException,
IOException

Parse the file specification object

Parameters:

fileObj -

Returns:

FileSpec - might be null in case the passed object is null

Throws:

IOException

PDFParseException

parseWinDict

private LaunchAction.WinLaunchParam parseWinDict(PDFObject winDict)
                                          throws IOException

Parse the windows specific launch parameters

Parameters:

winDict -

Throws:

IOException - - in case of a problem during parsing content

getFileSpecification

public LaunchAction.FileSpec getFileSpecification()

The file / application to be opened

Returns:

FileSpec

isNewWindow

public boolean isNewWindow()

Should a new window be opened for the file/application?

Returns:

boolean

getUnixParam

public PDFObject getUnixParam()

Get the unix specific launch parameters. Note: The dictionary is not specified yet in the PDF spec., so the PdfObject which is returned here is not parsed.

Returns:

PDFObject

getMacParam

public PDFObject getMacParam()

Get the mac specific launch parameters. Note: The dictionary is not specified yet in the PDF spec., so the PdfObject which is returned here is not parsed.

Returns:

PDFObject

getWinParam

public LaunchAction.WinLaunchParam getWinParam()

Get the windows specific launch parameters.

Returns:

WinLaunchParam