GoToAction Class Documentation
class GoToAction : ActionNamespace:com::datalogics::PDFL
- Inherits from:
Action
Detailed Description
A go-to action can be executed in a PDF document. A go-to action includes a hyperlink that, when clicked, takes the reader to a different place within the same document.
The action is linked to a bookmark within the document.
A remote go-to action includes a hyperlink that takes the reader to a destination in a separate document.
Uses types
Constructor & Destructor Documentation
GoToAction
GoToAction(Document doc, String namedDestination)Parameters
doc: DocumentDocument in which the action is created.
namedDestination: StringThe destination name to store in the action's /D entry.
Construct a GoTo action that refers to a named destination.
The named destination is not resolved at construction time; the viewer looks it up in the document's /Names/Dests name tree (or /Dests dict) when the action fires.
GoToAction
GoToAction(ViewDestination dest)Parameters
dest: ViewDestinationThe ViewDestination contained in this class.
General constructor
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:
voidgetDestination
ViewDestination getDestination()Returns:
ViewDestinationThe ViewDestination for this action.
The ViewDestination that this go-to action navigates to.
getPDFDict
PDFDict getPDFDict()Returns:
PDFDictThe underlying PDF dictionary for this Action.
Retrieve the PDFObject representation of this object.
getSubtype
String getSubtype()Returns:
StringThe subtype string for this action, such as "GoTo", "URI", "Launch", or "GoToR".
The action's subtype.
setDestination
void setDestination(ViewDestination dest)Parameters
dest: ViewDestinationThe ViewDestination to set, or null to remove.
Returns:
voidThe ViewDestination that this go-to action navigates to. Setting the destination to null removes the destination entry from the action dictionary.
toString
String toString()Returns:
StringA string describing this Action.
Returns a string representation of this Action. The string includes the action's subtype.