Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams

Field Summary

Modifier and Type	Field and Description
public static final String	OPERATION_OPEN The open operation for the launch.
public static final String	OPERATION_PRINT The print operation for the launch.
protected final COSDictionary	params The params dictionary.

Constructor Summary

Access	Constructor and Description
public	PDWindowsLaunchParams() Default constructor.
public	PDWindowsLaunchParams(COSDictionary The params dictionary. p) Constructor.

Method Summary

Modifier and Type	Method and Description
public COSDictionary	Returns: The cos object that matches this Java object. getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object.
public String	Returns: The dir of the executable/document to launch. getDirectory() The dir to launch from.
public String	Returns: The parameter to pass the executable. getExecuteParam() A parameter to pass the executable.
public String	Returns: The executable/document to launch. getFilename() The file to launch.
public String	Returns: The operation to perform for the file. getOperation() Get the operation to perform on the file.
public void	setDirectory(String The dir of the executable/document to launch. dir) Set the dir to launch from.
public void	setExecuteParam(String The parameter for the executable. param) Set the parameter to pass the executable.
public void	setFilename(String The executable/document to launch. file) Set the file to launch.
public void	setOperation(String The operation to perform on the file. op) Set the operation to perform..

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

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

OPERATION_PRINT	back to summary
public static final String OPERATION_PRINT The print operation for the launch.

params	back to summary
protected final COSDictionary params The params dictionary.

Constructor Detail

PDWindowsLaunchParams	back to summary
public PDWindowsLaunchParams() Default constructor.

PDWindowsLaunchParams	back to summary
public PDWindowsLaunchParams(COSDictionary p) Constructor. Parameters p:COSDictionary The params dictionary.

PDWindowsLaunchParams

back to summary

public PDWindowsLaunchParams(COSDictionary p)

Constructor.

Parameters

p:COSDictionary: The params dictionary.

Method Detail

getCOSObject	back to summary
public COSDictionary getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object. Returns:COSDictionary The cos object that matches this Java object. Annotations @Override

getCOSObject

back to summary

public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations

@Override

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

getDirectory

back to summary

public String getDirectory()

The dir to launch from.

Returns:String: The dir of the executable/document to launch.

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

getExecuteParam

back to summary

public String getExecuteParam()

A parameter to pass the executable.

Returns:String: The parameter to pass the executable.

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

getFilename

back to summary

public String getFilename()

The file to launch.

Returns:String: The executable/document to launch.

getOperation back to summary

getOperation	back to summary
public String getOperation() Get the operation to perform on the file. This method will not return null, OPERATION_OPEN is the default. Returns:String The operation to perform for the file. See Also `PDWindowsLaunchParams#OPERATION_OPEN`, `PDWindowsLaunchParams#OPERATION_PRINT`

public String getOperation()

Get the operation to perform on the file. This method will not return null, OPERATION_OPEN is the default.

Returns:String: The operation to perform for the file.
See Also: PDWindowsLaunchParams#OPERATION_OPEN, PDWindowsLaunchParams#OPERATION_PRINT

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

setDirectory

back to summary

public void setDirectory(String dir)

Set the dir to launch from.

Parameters

dir:String: The dir of the executable/document to launch.

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

setExecuteParam

back to summary

public void setExecuteParam(String param)

Set the parameter to pass the executable.

Parameters

param:String: The parameter for the executable.

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

setFilename

back to summary

public void setFilename(String file)

Set the file to launch.

Parameters

file:String: The executable/document to launch.

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

setOperation

back to summary

public void setOperation(String op)

Set the operation to perform..

Parameters

op:String: The operation to perform on the file.

public Class PDWindowsLaunchParams

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail