com.qoppa.pdf.actions

Class LaunchAction

java.lang.Object

com.qoppa.pdf.actions.Action

com.qoppa.pdf.actions.LaunchAction

public class LaunchAction
extends Action

Action that tells the viewer to go to 'launch' a given file. The default behavior is to let the operating system launch the file. This should behave in the same way as if double-clicking on the file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_TYPE_DESCRIPTION

Fields inherited from class com.qoppa.pdf.actions.Action

OPEN_EXISTING_WINDOW, OPEN_NEW_WINDOW, OPEN_USER_PREFERENCE

Constructor Summary

Constructors

Constructor and Description
LaunchAction(String fileName) Constructs the action with the given file name.
LaunchAction(String fileName, int newWindow) Constructs the action with the given file name.

Method Summary

Modifier and Type	Method and Description
String	getActionType() Returns the action type.
String	getActionTypeDesc() Returns the action type description
String	getFileName() Returns the name of the file to launch in the PDF file specification format.
int	getNewWindow() A flag specifying whether to open the destination document in a new window.
Boolean	isNewWindow() Deprecated. Use getNewWindow()
void	setNewWindow(boolean newWindow) Deprecated. Use setNewWindow(int)
void	setNewWindow(int newWindow) A flag specifying whether to open the destination document in a new window.
String	toString() Returns the description of the action.

Methods inherited from class com.qoppa.pdf.actions.Action

getNextAction, setNextAction

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_TYPE_DESCRIPTION

public static String ACTION_TYPE_DESCRIPTION

Constructor Detail

LaunchAction

public LaunchAction(String fileName)

Constructs the action with the given file name. By default, the file will be opened in a new window.

Parameters:

fileName - The name of the file to launch following the PDF file specification format.

• /r/pdfdocs/spec.pdf for OS path name r:\pdfdocs\spec.pdf
• //pdfdocs/spec.pdf for OS path name \pdfdocs\spec.pdf
• any path not starting with / is a path relative to the PDF document file path

LaunchAction

public LaunchAction(String fileName,
                    int newWindow)

Constructs the action with the given file name. By default, the file will be opened in a new window.

Parameters:

fileName - The name of the file to launch following the PDF file specification format.

• /r/pdfdocs/spec.pdf for OS path name r:\pdfdocs\spec.pdf
• //pdfdocs/spec.pdf for OS path name \pdfdocs\spec.pdf
• any path not starting with / is a path relative to the PDF document file path

newWindow - The value of the new window flag. One of Action.OPEN_EXISTING_WINDOW, Action.OPEN_NEW_WINDOW, Action.OPEN_USER_PREFERENCE.

Method Detail

getFileName

public String getFileName()

Returns the name of the file to launch in the PDF file specification format.

Returns:

The name of the file to launch.

getActionType

public String getActionType()

Returns the action type.

Specified by:

getActionType in class Action

Returns:

The action type.

getActionTypeDesc

public String getActionTypeDesc()

Returns the action type description

Specified by:

getActionTypeDesc in class Action

toString

public String toString()

Returns the description of the action.

Overrides:

toString in class Object

setNewWindow

public void setNewWindow(boolean newWindow)

Deprecated. Use setNewWindow(int)

A flag specifying whether to open the destination document in a new window. If this flag is false, the destination document replaces the current document in the same window.

Parameters:

newWindow - The value of the new window flag.

isNewWindow

public Boolean isNewWindow()

Deprecated. Use getNewWindow()

A flag specifying whether to open the destination document in a new window. If this flag is false, the destination document replaces the current document in the same window. If this flag is null the viewer application should behave in accordance with the current user preference.

Returns:

The value of the new window flag.

setNewWindow

public void setNewWindow(int newWindow)

A flag specifying whether to open the destination document in a new window. The document can be opened in a new window, replace the current document in the same window, or behave in accordance with the current user preference.

Parameters:

newWindow - The value of the new window flag. One of Action.OPEN_EXISTING_WINDOW, Action.OPEN_NEW_WINDOW, Action.OPEN_USER_PREFERENCE.

getNewWindow

public int getNewWindow()

A flag specifying whether to open the destination document in a new window. The document can be opened in a new window, replace the current document in the same window, or behave in accordance with the current user preference.

Returns:

The value of the new window flag. One of Action.OPEN_EXISTING_WINDOW, Action.OPEN_NEW_WINDOW, Action.OPEN_USER_PREFERENCE.