GoToAction
Overview
GoToAction is a class in Aspose.PDF FOSS for Java.
Inherits from: PdfAction.
Go-To action — navigate to a destination within the document (ISO 32000-1:2008, §12.6.4.2).
This class provides 12 methods for working with GoToAction objects in Java programs.
Available methods include: GoToAction, fromDictionary, getAppointment, getDestination, getNext, getPdfDictionary, getType, setDestination.
All public members are accessible to any Java application after installing the Aspose.PDF FOSS for Java package.
Properties: appointment, destination, next, pdfDictionary, type.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
destination | ExplicitDestination | Read | Returns the destination as an {@link ExplicitDestination} when one is set |
| (either inline or already resolved during construction); for a | |||
| {@link NamedDestination}, returns the lazy-resolved explicit destination, | |||
| or {@code null} if the name cannot be resolved. | |||
appointment | IAppointment | Read | Returns the raw destination ({@link ExplicitDestination} or |
| {@link NamedDestination}). | |||
pdfDictionary | PdfDictionary | Read | Returns the underlying action dictionary. |
type | String | Read | Returns the action type (/S entry). |
next | PdfAction | Read | Returns the next action (/Next), if any. |
Methods
| Signature | Description |
|---|---|
GoToAction(page: Page) | Creates a GoToAction targeting a page with default XYZ destination. |
GoToAction() | Creates a GoToAction with no preset destination — used by callers that |
| subsequently invoke {@link #setDestination(IAppointment)}. | |
GoToAction(dest: ExplicitDestination) | Creates a GoToAction with a specific destination. |
GoToAction(dest: NamedDestination) | Creates a GoToAction with a named destination. |
GoToAction(dict: PdfDictionary, doc: Document) | Parses a GoToAction from an existing dictionary. |
getDestination() → ExplicitDestination | Returns the destination as an {@link ExplicitDestination} when one is set |
| (either inline or already resolved during construction); for a | |
| {@link NamedDestination}, returns the lazy-resolved explicit destination, | |
| or {@code null} if the name cannot be resolved. | |
getAppointment() → IAppointment | Returns the raw destination ({@link ExplicitDestination} or |
| {@link NamedDestination}). | |
setDestination(dest: IAppointment) | Sets the destination (accepts both {@link ExplicitDestination} and |
| {@link NamedDestination}). | |
getPdfDictionary() → PdfDictionary | Returns the underlying action dictionary. |
getType() → String | Returns the action type (/S entry). |
getNext() → PdfAction | Returns the next action (/Next), if any. |
fromDictionary(dict: PdfDictionary, doc: Document) → PdfAction | Factory: creates the appropriate PdfAction subclass from a dictionary. |
