RemoteGoToAction Class Documentation
class RemoteGoToAction : ActionNamespace:com::datalogics::PDFL
- Inherits from:
Action
Detailed Description
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 & Destructor Documentation
RemoteGoToAction
RemoteGoToAction(FileSpecification fileSpec, RemoteDestination remoteDest)Parameters
fileSpec: FileSpecificationA FileSpecification containing the path to the remote document.
remoteDest: RemoteDestinationA RemoteDestination representing the destination to jump in the remote document.
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.
Member Function Documentation
delete
synchronized void delete(Boolean disposing)Parameters
disposing: Boolean
Returns:
synchronized voiddelete
synchronized void delete()Returns:
synchronized voidequals
boolean equals(Object rhs)Parameters
rhs: Object
Returns:
booleanfinalize
void finalize()Returns:
voidgetFileSpecification
FileSpecification getFileSpecification()Returns:
FileSpecificationThe FileSpecification associated with the RemoteGoToAction.
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.)
getNewWindow
boolean getNewWindow()Returns:
booleanTrue if the destination document is set to open in a new window, false otherwise.
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.
getPDFDict
PDFDict getPDFDict()Returns:
PDFDictThe underlying PDF dictionary for this Action.
Retrieve the PDFObject representation of this object.
getRemoteDestination
RemoteDestination getRemoteDestination()Returns:
RemoteDestinationThe RemoteDestination associated with the RemoteGoToAction.
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.)
getSubtype
String getSubtype()Returns:
StringThe subtype string for this action, such as "GoTo", "URI", "Launch", or "GoToR".
The action's subtype.
setFileSpecification
void setFileSpecification(FileSpecification fileSpec)Parameters
fileSpec: FileSpecificationThe FileSpecification to associate with the RemoteGoToAction.
Returns:
voidThe 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.)
setNewWindow
void setNewWindow(boolean newValue)Parameters
newValue: booleanThe new value for the flag.
Returns:
voidA 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.
setRemoteDestination
void setRemoteDestination(RemoteDestination remoteDest)Parameters
remoteDest: RemoteDestinationThe RemoteDestination to associate with the RemoteGoToAction.
Returns:
voidThe 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.)
toString
String toString()Returns:
StringA string describing this Action.
Returns a string representation of this Action. The string includes the action's subtype.