Package com.itextpdf.kernel.pdf.annot

Class PdfSquareAnnotation

java.lang.Object
com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>
com.itextpdf.kernel.pdf.annot.PdfAnnotation
com.itextpdf.kernel.pdf.annot.PdfMarkupAnnotation
com.itextpdf.kernel.pdf.annot.PdfSquareAnnotation
public class PdfSquareAnnotation extends PdfMarkupAnnotation

  • Constructor Details

  • Method Details

    • 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 PdfSquareAnnotation 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 PdfSquareAnnotation instance.

    • setBorderStyle

      public PdfSquareAnnotation setBorderStyle (PdfName style)
      Setter for the annotation's preset border style. Possible values are See also ISO-320001, Table 166.
      Parameters:
      style - The new value for the annotation's border style.
      Returns:
      this PdfSquareAnnotation instance.
      See Also:

    • setDashPattern

      public PdfSquareAnnotation 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 PdfSquareAnnotation instance.

    • getRectangleDifferences

      public PdfArray getRectangleDifferences()
      A set of four numbers describing the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying square.
      Returns:
      null if not specified, otherwise a PdfArray with four numbers which correspond to the differences in default user space between the left, top, right, and bottom coordinates of Rect and those of the inner rectangle, respectively.

    • setRectangleDifferences

      public PdfSquareAnnotation setRectangleDifferences (PdfArray rect)
      A set of four numbers describing the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying square.
      Parameters:
      rect - a PdfArray with four numbers which correspond to the differences in default user space between the left, top, right, and bottom coordinates of Rect and those of the inner rectangle, respectively. Each value shall be greater than or equal to 0. The sum of the top and bottom differences shall be less than the height of Rect, and the sum of the left and right differences shall be less than the width of Rect.
      Returns:
      this PdfSquareAnnotation instance.

    • getBorderEffect

      public PdfDictionary getBorderEffect()
      Gets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.
      Returns:
      a PdfDictionary, which is a border effect dictionary (see ISO-320001, Table 167).

    • setBorderEffect

      public PdfSquareAnnotation setBorderEffect (PdfDictionary borderEffect)
      Sets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.
      Parameters:
      borderEffect - a PdfDictionary which contents shall be specified in accordance to ISO-320001, Table 167.
      Returns:
      this PdfSquareAnnotation instance.

    • getInteriorColor

      public Color getInteriorColor()
      The interior color which is used to fill the annotation's rectangle.
      Returns:
      Color of either DeviceGray, DeviceRgb or DeviceCmyk type which defines interior color of the annotation, or null if interior color is not specified.

    • setInteriorColor

      public PdfSquareAnnotation setInteriorColor (PdfArray interiorColor)
      An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill the annotation's rectangle.
      Parameters:
      interiorColor - a PdfArray of numbers in the range 0.0 to 1.0. The number of array elements determines the colour space in which the colour is defined: 0 - No colour, transparent; 1 - DeviceGray, 3 - DeviceRGB, 4 - DeviceCMYK. For the PdfRedactAnnotation number of elements shall be equal to 3 (which defines DeviceRGB colour space).
      Returns:
      this PdfSquareAnnotation instance.

    • setInteriorColor

      public PdfSquareAnnotation setInteriorColor (float[] interiorColor)
      An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill the annotation's rectangle.
      Parameters:
      interiorColor - an array of floats in the range 0.0 to 1.0.
      Returns:
      this PdfSquareAnnotation instance.