org.icepdf.core.pobjects.actions

Class GoToRAction

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.actions.Action

org.icepdf.core.pobjects.actions.GoToRAction

public class GoToRAction
extends Action

A remote go-to action is similar to an ordinary go-to action but jumps to a destination in another PDF file instead of the current file.

Since:

2.6

Author:

ICEsoft Technologies, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static Name	F_KEY
static Name	NEW_WINDOW_KEY

Fields inherited from class org.icepdf.core.pobjects.actions.Action

ACTION_TYPE, ACTION_TYPE_GOTO, ACTION_TYPE_GOTO_REMOTE, ACTION_TYPE_JAVA_SCRIPT, ACTION_TYPE_KEY, ACTION_TYPE_LAUNCH, ACTION_TYPE_NAMED, ACTION_TYPE_RESET_SUBMIT, ACTION_TYPE_SUBMIT_SUBMIT, ACTION_TYPE_URI, NEXT_KEY

Fields inherited from class org.icepdf.core.pobjects.Dictionary

entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
GoToRAction(Library l, java.util.HashMap h) Creates a new instance of a Action.

Method Summary

Modifier and Type	Method and Description
Destination	getDestination() Gets the destination associated with the external file path.
java.lang.String	getFile() Gets the external file path
FileSpecification	getFileSpecification() Gets the file specification of the destination file.
java.lang.Boolean	isNewWindow() Indicates if the external document should be loaded in a new window or if it should be loaded in the current.

Methods inherited from class org.icepdf.core.pobjects.actions.Action

buildAction, getType, similar

Methods inherited from class org.icepdf.core.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

F_KEY

public static final Name F_KEY

NEW_WINDOW_KEY

public static final Name NEW_WINDOW_KEY

Constructor Detail

GoToRAction

public GoToRAction(Library l,
                   java.util.HashMap h)

Creates a new instance of a Action.

Parameters:

l - document library.

h - Action dictionary entries.

Method Detail

getDestination

public Destination getDestination()

Gets the destination associated with the external file path.

Returns:

destination object if any to be resolved.

getFile

public java.lang.String getFile()

Gets the external file path

Returns:

file path of document to be opened.

getFileSpecification

public FileSpecification getFileSpecification()

Gets the file specification of the destination file. This objects should be interigated to deside what should be done

Returns:

file specification, maybe nukll if external file was specified.

isNewWindow

public java.lang.Boolean isNewWindow()

Indicates if the external document should be loaded in a new window or if it should be loaded in the current.

Returns:

true indicates a new windows should be launched for the remote document; otherwise, false.