Class 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
    • Field Detail

      • SUB_TYPE

        public static final java.lang.String SUB_TYPE
        The type of annotation.
        See Also:
        Constant Field Values
    • Constructor Detail

      • 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 object to represent as a field.
    • Method Detail

      • setOpen

        public void setOpen​(boolean open)
        This will set the initial 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.