Module org.sejda.sambox
Package org.sejda.sambox.pdmodel.interactive.annotation

Class PDAnnotationLink

java.lang.Object
org.sejda.sambox.pdmodel.common.PDDictionaryWrapper
org.sejda.sambox.pdmodel.interactive.annotation.PDAnnotation
org.sejda.sambox.pdmodel.interactive.annotation.PDAnnotationLink
All Implemented Interfaces:
COSObjectable, WithActionOrDestination
public class PDAnnotationLink extends PDAnnotation implements WithActionOrDestination
This is the class that represents a link annotation.
Author:
Ben Litchfield, Paul King

  • Field Details

    • HIGHLIGHT_MODE_NONE

      public static final String HIGHLIGHT_MODE_NONE
      Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
      See Also:

    • HIGHLIGHT_MODE_INVERT

      public static final String HIGHLIGHT_MODE_INVERT
      Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
      See Also:

    • HIGHLIGHT_MODE_OUTLINE

      public static final String HIGHLIGHT_MODE_OUTLINE
      Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
      See Also:

    • HIGHLIGHT_MODE_PUSH

      public static final String HIGHLIGHT_MODE_PUSH
      Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
      See Also:

    • SUB_TYPE

      public static final String SUB_TYPE
      The type of annotation.
      See Also:

  • Constructor Details

    • PDAnnotationLink

      public PDAnnotationLink()
      Constructor.

    • PDAnnotationLink

      public PDAnnotationLink(COSDictionary field)
      Creates a Link annotation from a COSDictionary, expected to be a correct object definition.
      Parameters:
      field - the PDF objet to represent as a field.

  • Method Details

    • getAction

      public PDAction getAction()
      Get the action to be performed when this annotation is to be activated.
      Specified by:
      getAction in interface WithActionOrDestination
      Returns:
      The action to be performed when this annotation is activated.

      TODO not all annotations have an A entry

    • setAction

      public void setAction(PDAction action)
      Set the annotation action. As of PDF 1.6 this is only used for Widget Annotations
      Parameters:
      action - The annotation action. TODO not all annotations have an A entry

    • setBorderStyle

      public void setBorderStyle(PDBorderStyleDictionary bs)
      This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
      Parameters:
      bs - the border style dictionary to set. TODO not all annotations may have a BS entry

    • getBorderStyle

      public PDBorderStyleDictionary getBorderStyle()
      This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
      Returns:
      the border style dictionary.

    • getDestination

      public PDDestination getDestination() throws IOException
      Get the destination to be displayed when the annotation is activated. Either this or the A should be set but not both.
      Specified by:
      getDestination in interface WithActionOrDestination
      Returns:
      The destination for this annotation.
      Throws:
      IOException - If there is an error creating the destination.

    • setDestination

      public void setDestination(PDDestination dest)
      The new destination value.
      Parameters:
      dest - The updated destination.

    • getHighlightMode

      public String getHighlightMode()
      Set the highlight mode for when the mouse is depressed. See the HIGHLIGHT_MODE_XXX constants.
      Returns:
      The string representation of the highlight mode.

    • setHighlightMode

      public void setHighlightMode(String mode)
      Set the highlight mode. See the HIGHLIGHT_MODE_XXX constants.
      Parameters:
      mode - The new highlight mode.

    • setPreviousURI

      public void setPreviousURI(PDActionURI pa)
      This will set the previous URI action, in case it needs to be retrieved at later date.
      Parameters:
      pa - The previous URI.

    • getPreviousURI

      public PDActionURI getPreviousURI()
      This will set the previous URI action, in case it's needed.
      Returns:
      The previous URI.

    • setQuadPoints

      public void setQuadPoints(float[] quadPoints)
      This will set the set of quadpoints which encompass the areas of this annotation which will activate.
      Parameters:
      quadPoints - an array representing the set of area covered.

    • getQuadPoints

      public float[] getQuadPoints()
      This will retrieve the set of quadpoints which encompass the areas of this annotation which will activate.
      Returns:
      An array of floats representing the quad points.

    • setCustomAppearanceHandler

      public void setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)
      Set a custom appearance handler for generating the annotations appearance streams.
      Parameters:
      appearanceHandler -

    • constructAppearances

      public void constructAppearances()
      Description copied from class: PDAnnotation
      Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.
      Overrides:
      constructAppearances in class PDAnnotation