Module org.sejda.sambox

Package org.sejda.sambox.pdmodel.interactive.documentnavigation.destination

Interface WithActionOrDestination

All Superinterfaces:

COSObjectable

All Known Implementing Classes:

PDAnnotationLink, PDOutlineItem

public interface WithActionOrDestination
extends COSObjectable

Author:

Andrea Vacondio

Method Summary

Modifier and Type	Method	Description
PDAction	getAction()
PDDestination	getDestination()
default Optional<PDPageDestination>	resolveToPageDestination(PDDocumentCatalog catalog)

Methods inherited from interface org.sejda.sambox.cos.COSObjectable

getCOSObject

Method Details

getDestination

PDDestination getDestination()
                      throws IOException

Returns:

The destination to be displayed when the annotation is activated. Shall not be present if an A entry is present getAction()

Throws:

IOException - If there is an error creating the destination.

getAction

PDAction getAction()

Returns:

The action that shall be performed when this item is activated

resolveToPageDestination

default Optional<PDPageDestination> resolveToPageDestination(PDDocumentCatalog catalog)
                                                      throws IOException

Parameters:

catalog - Catalog used to possibly resolve named destinations

Returns:

the PDPageDestination or an empty Optional if the destination cannot be resolved to a PDPageDestination. If necessary, It resolves GoTo action destinations and named destination to return the actual PDPageDestination

Throws:

IOException