Class PdfTextAnnotation

    • Method Detail

      • getSubtype

        public PdfName getSubtype()
        Description copied from class: PdfAnnotation
        Gets a PdfName which value is a subtype of this annotation. See ISO-320001 12.5.6, "Annotation Types" for the reference to the possible types.
        Specified by:
        getSubtype in class PdfAnnotation
        Returns:
        subtype of this annotation.
      • getStateModel

        public PdfString getStateModel()
      • getOpen

        public boolean getOpen()
        A flag specifying whether the annotation shall initially be displayed open. This flag has affect to not all kinds of annotations.
        Returns:
        true if annotation is initially open, false - if closed.
      • setOpen

        public PdfTextAnnotation setOpen​(boolean open)
        Sets a flag specifying whether the annotation shall initially be displayed open. This flag has affect to not all kinds of annotations.
        Parameters:
        open - true if annotation shall initially be open, false - if closed.
        Returns:
        this PdfTextAnnotation instance.
      • getIconName

        public PdfName getIconName()
        The name of an icon that is used in displaying the annotation. Possible values are described in setIconName(PdfName).
        Returns:
        a PdfName that specifies the icon for displaying annotation, or null if icon name is not specified.
      • setIconName

        public PdfTextAnnotation setIconName​(PdfName name)
        The name of an icon that is used in displaying the annotation.
        Parameters:
        name - a PdfName that specifies the icon for displaying annotation. Possible values are:
        • Comment
        • Key
        • Note
        • Help
        • NewParagraph
        • Paragraph
        • Insert
        Returns:
        this PdfTextAnnotation instance.