nutrient/com.pspdfkit.annotations.actions

Package-level declarations

Types

AbstractFormAction

abstract class AbstractFormAction : Action

Base class for form related actions.

AbstractMediaAction

abstract class AbstractMediaAction : Action

Base class for media annotation related actions.

Action

abstract class Action

Represents a PDF action used to describe what happens when annotations, bookmarks, etc. are clicked or selected.

ActionResolver

interface ActionResolver

Action resolver for running a Action. Actions can be stored in annotations or outline elements and executed for any open document. While some actions require a displayed document (e.g. GoToAction) other actions may cause the user to leave the app (e.g. UriAction).

ActionSender

class ActionSender

Object that triggered the execution of action, such as an annotation or a form element.

ActionType

enum ActionType : Enum<ActionType>

Currently supported PDF action types.

AnnotationTriggerEvent

enum AnnotationTriggerEvent : Enum<AnnotationTriggerEvent>

Type of the annotation trigger events. Annotations can define additional actions that should be executed when these events are triggered.

GoToAction

class GoToAction @JvmOverloads constructor(val pageIndex: Int, subActions: List<Action> = emptyList(), val destination: Destination = Destination( pageIndex = pageIndex, type = DestinationType.FitPage, left = 0f, top = 0f, width = 0f, height = 0f, zoom = 0f )) : Action

PDF action representing a change to another page.

GoToEmbeddedAction

class GoToEmbeddedAction(val pdfPath: String?, @IntRange(from = 0) val pageIndex: Int, val isNewWindow: Boolean, subActions: List<Action> = emptyList(), val destination: Destination = Destination( pageIndex = pageIndex, type = DestinationType.FitPage, left = 0f, top = 0f, width = 0f, height = 0f, zoom = 0f )) : Action

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

GoToRemoteAction

class GoToRemoteAction(val pdfPath: String?, @IntRange(from = 0) val pageIndex: Int, subActions: List<Action> = emptyList(), val destination: Destination = Destination( pageIndex = pageIndex, type = DestinationType.FitPage, left = 0f, top = 0f, width = 0f, height = 0f, zoom = 0f )) : Action

PDF action representing a change to page in another PDF document.

HideAction

class HideAction(val annotationReferences: List<AnnotationReference>, hideTargets: Boolean, subActions: List<Action> = emptyList()) : Action

A hide action hides or shows one or more annotations on the screen by setting or clearing their hidden flags.

ImportDataAction

class ImportDataAction(subActions: List<Action> = emptyList()) : Action

Action representing request to import data.

JavaScriptAction

class JavaScriptAction @JvmOverloads constructor(val script: String, subActions: List<Action> = emptyList()) : Action

Action that should trigger execution of JavaScript embedded in it.

LaunchAction

class LaunchAction(val path: String?, subActions: List<Action> = emptyList()) : Action

Represents an action to launch an external application or file.

MediaOptions

enum MediaOptions : Enum<MediaOptions>

Specifies options when playing media annotations.

NamedAction

class NamedAction @JvmOverloads constructor(val namedActionType: NamedAction.NamedActionType, subActions: List<Action> = emptyList()) : Action

PDF action representing a special event. Examples are: go to next page, go to previous page, etc.

RenditionAction

class RenditionAction : AbstractMediaAction

A rendition action controls the playing of multimedia content.

ResetFormAction

class ResetFormAction(fieldNames: List<String>, excludeFormFields: Boolean, subActions: List<Action> = emptyList()) : AbstractFormAction

Resets one or more form fields to their default value.

RichMediaExecuteAction

class RichMediaExecuteAction : AbstractMediaAction

Action for starting com.pspdfkit.annotations.RichMediaAnnotations.

SubmitFormAction

class SubmitFormAction(val uri: String, fieldNames: List<String>, flags: EnumSet<SubmitFormAction.SubmitFormActionFlag>, subActions: List<Action> = emptyList()) : AbstractFormAction

PDF action for sending form data to a URI.

UriAction

class UriAction @JvmOverloads constructor(val uri: String?, subActions: List<Action> = emptyList()) : Action

PDF Action representing a link to an external URI.