Class PDAnnotationPopup

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
All Implemented Interfaces:
COSObjectable

public class PDAnnotationPopup extends PDAnnotation
This is the class that represents a popup annotation. Introduced in PDF 1.3 specification
Version:
$Revision: 1.2 $
Author:
Paul King
  • Field Details

  • Constructor Details

    • PDAnnotationPopup

      public PDAnnotationPopup()
      Constructor.
    • PDAnnotationPopup

      public PDAnnotationPopup(COSDictionary field)
      Creates a popup annotation from a COSDictionary, expected to be a correct object definition.
      Parameters:
      field - the PDF objet to represent as a field.
  • Method Details

    • setOpen

      public void setOpen(boolean open)
      This will set inital state of the annotation, open or closed.
      Parameters:
      open - Boolean value, true = open false = closed.
    • getOpen

      public boolean getOpen()
      This will retrieve the initial state of the annotation, open Or closed (default closed).
      Returns:
      The initial state, true = open false = closed.
    • setParent

      public void setParent(PDAnnotationMarkup annot)
      This will set the markup annotation which this popup relates to.
      Parameters:
      annot - the markup annotation.
    • getParent

      public PDAnnotationMarkup getParent()
      This will retrieve the markup annotation which this popup relates to.
      Returns:
      The parent markup annotation.