Package com.pspdfkit.annotations.actions
Class GoToRemoteAction
-
- All Implemented Interfaces:
public final class GoToRemoteAction extends Action
PDF action representing a change to page in another PDF document.
-
-
Field Summary
Fields Modifier and Type Field Description public final String
pdfPath
public final int
pageIndex
public final Destination
destination
-
Constructor Summary
Constructors Constructor Description GoToRemoteAction(String pdfPath, int pageIndex)
Creates action instance. GoToRemoteAction(String pdfPath, int pageIndex, List<Action> subActions)
Creates action instance. GoToRemoteAction(String pdfPath, int pageIndex, DestinationType type, float left, float top, float width, float height, float zoom, List<Action> subActions)
Creates action instance.
-
Method Summary
Modifier and Type Method Description String
getPdfPath()
Relative path to the PDF document this action points to. int
getPageIndex()
Page this action points to. Destination
getDestination()
Destination of this action. ActionType
getType()
Returns type of action to make down-casting easier. String
toString()
boolean
equals(Object o)
int
hashCode()
-
-
Constructor Detail
-
GoToRemoteAction
GoToRemoteAction(String pdfPath, int pageIndex)
Creates action instance.- Parameters:
pdfPath
- Relative path to the target PDF document.pageIndex
- Destination page index in the target PDF file.
-
GoToRemoteAction
GoToRemoteAction(String pdfPath, int pageIndex, List<Action> subActions)
Creates action instance.- Parameters:
pdfPath
- Path of the target PDF file.pageIndex
- Destination page index in the target PDF file.subActions
- List of sub-actions of this action.
-
GoToRemoteAction
GoToRemoteAction(String pdfPath, int pageIndex, DestinationType type, float left, float top, float width, float height, float zoom, List<Action> subActions)
Creates action instance.- Parameters:
pdfPath
- Path of the target PDF file.pageIndex
- Destination page index in the target PDF file.subActions
- List of sub-actions of this action.
-
-
Method Detail
-
getPdfPath
@Nullable() String getPdfPath()
Relative path to the PDF document this action points to.
- Returns:
Relative path to the document.
-
getPageIndex
@IntRange(from = 0) int getPageIndex()
Page this action points to.
- Returns:
0-indexed page number
-
getDestination
Destination getDestination()
Destination of this action.
- Returns:
An structure that contains the page index and the particular view of the document that this action points to.
-
getType
@NonNull() ActionType getType()
Returns type of action to make down-casting easier.
- Returns:
Type of this action.
-
hashCode
int hashCode()
-
-
-
-