public final class

GoToEmbeddedAction

extends Action
java.lang.Object
   ↳ com.pspdfkit.annotations.actions.Action
     ↳ com.pspdfkit.annotations.actions.GoToEmbeddedAction

Class Overview

Action that allows jumping to a PDF file that is embedded in the document.

See Also

Summary

Public Constructors
GoToEmbeddedAction(EmbeddedFile targetFile, boolean openInNewWindow)
Creates action instance.
GoToEmbeddedAction(EmbeddedFile targetFile, boolean openInNewWindow, List<Action> subActions)
Creates action instance.
Public Methods
boolean equals(Object o)
int getPageIndex()
Page index in the target document to skip to once the action is executed.
String getPdfPath()
Relative path to the embedded PDF document.
ActionType getType()
Returns type of action to make down-casting easier.
int hashCode()
boolean isNewWindow()
String toString()
[Expand]
Inherited Methods
From class com.pspdfkit.annotations.actions.Action
From class java.lang.Object

Public Constructors

public GoToEmbeddedAction (EmbeddedFile targetFile, boolean openInNewWindow)

Creates action instance.

Parameters
targetFile Target embedded file, action will be no-op if the embedded file won't be present in the document once the action is executed.
openInNewWindow true to open embedded file in a new activity (works only when executed from within PdfActivity), false to replace currently opened file.

public GoToEmbeddedAction (EmbeddedFile targetFile, boolean openInNewWindow, List<Action> subActions)

Creates action instance.

Parameters
targetFile Target embedded file, action will be no-op if the embedded file won't be present in the document once the action is executed.
openInNewWindow true to open embedded file in a new activity (works only when executed from within PdfActivity), false to replace currently opened file.
subActions List of sub-actions of this action.

Public Methods

public boolean equals (Object o)

public int getPageIndex ()

Page index in the target document to skip to once the action is executed.

Returns
  • 0-indexed page number.

public String getPdfPath ()

Relative path to the embedded PDF document.

Returns
  • Relative path to the target document. null if path to embedded file could not be resolved.

public ActionType getType ()

Returns type of action to make down-casting easier.

Returns
  • Type of this action.

public int hashCode ()

public boolean isNewWindow ()

Returns
  • true if a new window should be created for displayed document.

public String toString ()