com.datalogics.PDFL

Class RemoteGoToAction

java.lang.Object

com.datalogics.PDFL.Action

com.datalogics.PDFL.RemoteGoToAction

public class RemoteGoToAction
extends Action

A remote go-to action is an action that includes a RemoteDestination object. The action associated with this object, when selected, opens a separate PDF file, or opens a web page in a browser window.

Constructor Summary

Constructors

Constructor and Description
RemoteGoToAction(FileSpecification fileSpec, RemoteDestination remoteDest) 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.
RemoteDestination	getRemoteDestination() The RemoteDestination for this action.
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.
void	setRemoteDestination(RemoteDestination remoteDest) The RemoteDestination for this action.

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

RemoteGoToAction

public RemoteGoToAction(FileSpecification fileSpec,
                        RemoteDestination remoteDest)

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 and RemoteDestination should be associated with the same Document, and this Document should be the same Document that contains the RemoteGoToAction. (All three objects, FileSpecification, RemoteDestination, and RemoteGoToAction, are associated with a Document at creation time, and the association cannot be changed.) The RemoteGoToAction will be associated with the same Document that the RemoteDestination parameter is associated with.

When creating the RemoteGoToAction, the FileSpecification and RemoteDestination given to the constructor must be associated with the same Document, or an exception will be thrown.

Parameters:

fileSpec - A FileSpecification containing the path to the remote document.

remoteDest - A RemoteDestination representing the destination to jump in the remote document.

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 RemoteGoToAction. (Both FileSpecification and RemoteGoToAction are associated with a Document at creation time.)

Returns:

The FileSpecification associated with the RemoteGoToAction.

setFileSpecification

public void setFileSpecification(FileSpecification fileSpec)

The FileSpecification for this action.

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

Parameters:

fileSpec - The FileSpecification to associate with the RemoteGoToAction.

getRemoteDestination

public RemoteDestination getRemoteDestination()

The RemoteDestination for this action.

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

Returns:

The RemoteDestination associated with the RemoteGoToAction.

setRemoteDestination

public void setRemoteDestination(RemoteDestination remoteDest)

The RemoteDestination for this action.

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

Parameters:

remoteDest - The RemoteDestination to associate with the RemoteGoToAction.

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.