GoToAction

All Implemented Interfaces:


public final class GoToAction
extends Action

PDF action representing a change to another page.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

Field Summary

Fields
Modifier and Type Field Description

public final int pageIndex

public final Destination destination

Constructor Summary

Constructors
Constructor	Description
`GoToAction(int pageIndex)`	Creates action instance.
`GoToAction(int pageIndex, List<Action> subActions)`	Creates action instance.
`GoToAction(int pageIndex, DestinationType type, float left, float top, float width, float height, float zoom, List<Action> subActions)`	Creates action instance.

Enum Constant Summary

Enum Constants
Enum Constant Description

Method Summary

Modifier and Type	Method	Description
`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()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GoToAction
```
GoToAction(int pageIndex)
```
    Creates action instance.
    
    Parameters:
    
    pageIndex - Index of the page to skip to once the action is triggered.
  - GoToAction
```
GoToAction(int pageIndex, List<Action> subActions)
```
    Creates action instance.
    
    Parameters:
    
    pageIndex - Index of the page to skip to once the action is triggered.
    
    subActions - List of sub-actions of this action.
  - GoToAction
```
GoToAction(int pageIndex, DestinationType type, float left, float top, float width, float height, float zoom, List<Action> subActions)
```
    Creates action instance.
    
    Parameters:
    
    pageIndex - Index of the page to skip to once the action is triggered.
    
    subActions - List of sub-actions of this action.
- Method Detail
  - 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.
  - toString
```
 String toString()
```
  - equals
```
 boolean equals(Object o)
```
  - hashCode
```
 int hashCode()
```