org.pdfbox.pdmodel.interactive.action.type

Class PDWindowsLaunchParams

Implemented Interfaces:
COSObjectable

public class PDWindowsLaunchParams
extends java.lang.Object
implements COSObjectable

Launch paramaters for the windows OS.
Version:
$Revision: 1.2 $
Author:
Ben Litchfield

Field Summary

static String
OPERATION_OPEN
The open operation for the launch.
static String
OPERATION_PRINT
The print operation for the lanuch.
protected COSDictionary
params
The params dictionary.

Constructor Summary

PDWindowsLaunchParams()
Default constructor.
PDWindowsLaunchParams(COSDictionary p)
Constructor.

Method Summary

COSDictionary
getCOSDictionary()
Convert this standard java object to a COS object.
COSBase
getCOSObject()
Convert this standard java object to a COS object.
String
getDirectory()
The dir to launch from.
String
getExecuteParam()
A parameter to pass the executable.
String
getFilename()
The file to launch.
String
getOperation()
Get the operation to perform on the file.
void
setDirectory(String dir)
Set the dir to launch from.
void
setExecuteParam(String param)
Set the parameter to pass the executable.
void
setFilename(String file)
Set the file to launch.
void
setOperation(String op)
Set the operation to perform..

Field Details

OPERATION_OPEN

public static final String OPERATION_OPEN
The open operation for the launch.

OPERATION_PRINT

public static final String OPERATION_PRINT
The print operation for the lanuch.

params

protected COSDictionary params
The params dictionary.

Constructor Details

PDWindowsLaunchParams

public PDWindowsLaunchParams()
Default constructor.

PDWindowsLaunchParams

public PDWindowsLaunchParams(COSDictionary p)
Constructor.
Parameters:
p - The params dictionary.

Method Details

getCOSDictionary

public COSDictionary getCOSDictionary()
Convert this standard java object to a COS object.
Returns:
The cos object that matches this Java object.

getCOSObject

public COSBase getCOSObject()
Convert this standard java object to a COS object.
Specified by:
getCOSObject in interface COSObjectable
Returns:
The cos object that matches this Java object.

getDirectory

public String getDirectory()
The dir to launch from.
Returns:
The dir of the executable/document to launch.

getExecuteParam

public String getExecuteParam()
A parameter to pass the executable.
Returns:
The parameter to pass the executable.

getFilename

public String getFilename()
The file to launch.
Returns:
The executable/document to launch.

getOperation

public String getOperation()
Get the operation to perform on the file. This method will not return null, OPERATION_OPEN is the default.
Returns:
The operation to perform for the file.

setDirectory

public void setDirectory(String dir)
Set the dir to launch from.
Parameters:
dir - The dir of the executable/document to launch.

setExecuteParam

public void setExecuteParam(String param)
Set the parameter to pass the executable.
Parameters:
param - The parameter for the executable.

setFilename

public void setFilename(String file)
Set the file to launch.
Parameters:
file - The executable/document to launch.

setOperation

public void setOperation(String op)
Set the operation to perform..
Parameters:
op - The operation to perform on the file.