com.datalogics.PDFL

Class LaunchAction

java.lang.Object

com.datalogics.PDFL.Action

com.datalogics.PDFL.LaunchAction

public class LaunchAction
extends Action

A launch action launches an application or opens or prints a document.

Constructor Summary

Constructors

Constructor and Description
LaunchAction(FileSpecification fileSpec) General constructor.

Method Summary

Modifier and Type	Method and Description
void	delete()
FileSpecification	getFileSpecification() The FileSpecification for this action.
boolean	getNewWindow() A flag specifying whether to open the destination document in a new window.
void	setFileSpecification(FileSpecification fileSpec) The FileSpecification for this action.
void	setNewWindow(boolean newValue) A flag specifying whether to open the destination document in a new window.

Methods inherited from class com.datalogics.PDFL.Action

equals, getPDFDict, getSubtype, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LaunchAction

public LaunchAction(FileSpecification fileSpec)

General constructor.

The action's target will be the path referenced in the FileSpecification parameter. If the path is absolute, the target path will also be absolute. If the path is relative, the target path will also be relative.

Generally, the FileSpecification should be associated with the same Document that contains the LaunchAction. (Both FileSpecification and LaunchAction objects are associated with a Document at creation time, and the association cannot be changed.) The LaunchAction will be associated with the same Document that the FileSpecification parameter is associated with.

If the action's FileSpecification is changed during program execution such that the FileSpecification is associated with a different Document than the LaunchAction, saving the Document that contains the action will create a copy of the FileSpecification in the Document that contains the action.

Parameters:

fileSpec - A FileSpecification representing the application to be launched or the document to be opened or printed by this action.

Method Detail

delete

public void delete()

Overrides:

delete in class Action

getFileSpecification

public FileSpecification getFileSpecification()

The FileSpecification for this action.

Generally, the FileSpecification should be associated with the same Document that contains the LaunchAction. (Both FileSpecification and LaunchAction are associated with a Document at creation time.)

Returns:

The FileSpecification associated with the LaunchAction.

setFileSpecification

public void setFileSpecification(FileSpecification fileSpec)

The FileSpecification for this action.

Generally, the FileSpecification should be associated with the same Document that contains the LaunchAction. (Both FileSpecification and LaunchAction are associated with a Document at creation time.)

Parameters:

fileSpec - The FileSpecification to associate with the LaunchAction.

getNewWindow

public boolean getNewWindow()

A flag specifying whether to open the destination document in a new window.

By default, this flag is not present.

If the action's FileSpecification is not a PDF, this flag is ignored.

Returns:

True if the destination document is set to open in a new window, false otherwise.

setNewWindow

public void setNewWindow(boolean newValue)

A flag specifying whether to open the destination document in a new window.

By default, this flag is not present.

If the action's FileSpecification is not a PDF, this flag is ignored.

Parameters:

newValue - The new value for the flag.