Class PdfInkAnnotation

    • 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.
      • getBorderStyle

        public PdfDictionary getBorderStyle()
        The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry. That entry specifies a border style dictionary that has more settings than the array specified for the Border entry (see PdfAnnotation.getBorder()). If an annotation dictionary includes the BS entry, then the Border entry is ignored. If annotation includes AP (see PdfAnnotation.getAppearanceDictionary()) it takes precedence over the BS entry. For more info on BS entry see ISO-320001, Table 166.
        Returns:
        PdfDictionary which is a border style dictionary or null if it is not specified.
      • setBorderStyle

        public PdfInkAnnotation setBorderStyle​(PdfDictionary borderStyle)
        Sets border style dictionary that has more settings than the array specified for the Border entry (PdfAnnotation.getBorder()). See ISO-320001, Table 166 and getBorderStyle() for more info.
        Parameters:
        borderStyle - a border style dictionary specifying the line width and dash pattern that shall be used in drawing the annotation’s border.
        Returns:
        this PdfInkAnnotation instance.
      • setDashPattern

        public PdfInkAnnotation setDashPattern​(PdfArray dashPattern)
        Setter for the annotation's preset dashed border style. This property has affect only if PdfAnnotation.STYLE_DASHED style was used for the annotation border style (see setBorderStyle(PdfName). See ISO-320001 8.4.3.6, "Line Dash Pattern" for the format in which dash pattern shall be specified.
        Parameters:
        dashPattern - a dash array defining a pattern of dashes and gaps that shall be used in drawing a dashed border.
        Returns:
        this PdfInkAnnotation instance.