com.compdfkit.core.document.action

Class CPDFGoToRAction

java.lang.Object

com.compdfkit.core.document.action.CPDFAction

com.compdfkit.core.document.action.CPDFGoToRAction

public class CPDFGoToRAction
extends CPDFAction

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.

Nested Class Summary

Nested classes/interfaces inherited from class com.compdfkit.core.document.action.CPDFAction

CPDFAction.ActionType

Constructor Summary

Constructors

Constructor and Description
CPDFGoToRAction()

Method Summary

Modifier and Type	Method and Description
CPDFDestination	getDestination(CPDFDocument document) Gets the destination associated with the action, more: CPDFDestination
java.lang.String	getFileSpec() Gets the file in which the destination shall be located.
boolean	setDestination(CPDFDocument document, CPDFDestination destination) Sets the destination associated with the action.
boolean	setFileSpec(java.lang.String fileSpec) Sets the file in which the destination shall be located.

Methods inherited from class com.compdfkit.core.document.action.CPDFAction

close, getActionType, isValid

Methods inherited from class java.lang.Object

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

Constructor Detail

CPDFGoToRAction

public CPDFGoToRAction()

Method Detail

getFileSpec

public java.lang.String getFileSpec()

Gets the file in which the destination shall be located.

Returns:

Returns the file in which the destination shall be located.

setFileSpec

public boolean setFileSpec(java.lang.String fileSpec)

Sets the file in which the destination shall be located.

Parameters:

fileSpec - The file in which the destination shall be located.

Returns:

Returns whether to successfully set the file in which the destination shall be located.

getDestination

public CPDFDestination getDestination(CPDFDocument document)

Gets the destination associated with the action, more: CPDFDestination

Parameters:

document - This class is about CPDFDocument, one CPDFDocument class for one document.

Returns:

Returns the destination associated with the action.

See Also:

CPDFDocument, CPDFDestination

setDestination

public boolean setDestination(CPDFDocument document,
                              CPDFDestination destination)

Sets the destination associated with the action.

Parameters:

document - This class is about CPDFDocument, one CPDFDocument class for one document.

destination - The destination associated with the action.

Returns:

Returns whether to successfully set the destination associated with the action.