Package com.itextpdf.kernel.pdf.annot

Class PdfLineAnnotation

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.PdfLineAnnotation
public class PdfLineAnnotation extends PdfMarkupAnnotation
The purpose of a line annotation is to display a single straight line on the page. When opened, it displays a pop-up window containing the text of the associated note. See also ISO-320001 12.5.6.7 "Line Annotations".

  • Constructor Details

  • Method Details

    • getSubtype

      public PdfName getSubtype()
      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.

    • getLine

      public PdfArray getLine()
      An array of four numbers, [x1 y1 x2 y2], specifying the starting and ending coordinates of the line in default user space. If the PdfName.LL entry is present, this value represents the endpoints of the leader lines rather than the endpoints of the line itself.
      Returns:
      An array of four numbers specifying the starting and ending coordinates of the line in default user space.

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

    • setBorderStyle

      public PdfLineAnnotation 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 PdfLineAnnotation instance.
      See Also:

    • setDashPattern

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

    • getLineEndingStyles

      public PdfArray getLineEndingStyles()
      An array of two names specifying the line ending styles that is used in drawing the line. The first and second elements of the array shall specify the line ending styles for the endpoints defined, respectively, by the first and second pairs of coordinates, (x1, y1) and (x2, y2), in the PdfName.L array (see getLine(). For possible values see setLineEndingStyles(PdfArray).
      Returns:
      An array of two names specifying the line ending styles that is used in drawing the line; or null if line endings style is not explicitly defined, default value is [/None /None].

    • setLineEndingStyles

      public PdfLineAnnotation setLineEndingStyles (PdfArray lineEndingStyles)
      Sets the line ending styles that are used in drawing the line. The first and second elements of the array shall specify the line ending styles for the endpoints defined, respectively, by the first and second pairs of coordinates, (x1, y1) and (x2, y2), in the PdfName.L array (see getLine(). Possible values for styles are: see also ISO-320001, Table 176 "Line ending styles".
      Parameters:
      lineEndingStyles - An array of two names specifying the line ending styles that is used in drawing the line.
      Returns:
      this PdfLineAnnotation instance.

    • getInteriorColor

      public Color getInteriorColor()
      The interior color which is used to fill the annotation's line endings.
      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 PdfLineAnnotation 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 line endings.
      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 PdfLineAnnotation instance.

    • setInteriorColor

      public PdfLineAnnotation 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 line endings.
      Parameters:
      interiorColor - an array of floats in the range 0.0 to 1.0.
      Returns:
      this PdfLineAnnotation instance.

    • getLeaderLineLength

      public float getLeaderLineLength()
      The length of leader lines in default user space that extend from each endpoint of the line perpendicular to the line itself. A positive value means that the leader lines appear in the direction that is clockwise when traversing the line from its starting point to its ending point (as specified by PdfName.L (see getLine()); a negative value indicates the opposite direction.
      Returns:
      a float specifying the length of leader lines in default user space.

    • setLeaderLineLength

      public PdfLineAnnotation setLeaderLineLength (float leaderLineLength)
      Sets the length of leader lines in default user space that extend from each endpoint of the line perpendicular to the line itself. A positive value means that the leader lines appear in the direction that is clockwise when traversing the line from its starting point to its ending point (as specified by PdfName.L (see getLine()); a negative value indicates the opposite direction.
      Parameters:
      leaderLineLength - a float specifying the length of leader lines in default user space.
      Returns:
      this PdfLineAnnotation instance.

    • getLeaderLineExtension

      public float getLeaderLineExtension()
      A non-negative number that represents the length of leader line extensions that extend from the line proper 180 degrees from the leader lines.
      Returns:
      a non-negative float that represents the length of leader line extensions; or if the leader line extension is not explicitly set, returns the default value, which is 0.

    • setLeaderLineExtension

      public PdfLineAnnotation setLeaderLineExtension (float leaderLineExtension)
      Sets the length of leader line extensions that extend from the line proper 180 degrees from the leader lines. This value shall not be set unless PdfName.LL is set.
      Parameters:
      leaderLineExtension - a non-negative float that represents the length of leader line extensions.
      Returns:
      this PdfLineAnnotation instance.

    • getLeaderLineOffset

      public float getLeaderLineOffset()
      A non-negative number that represents the length of the leader line offset, which is the amount of empty space between the endpoints of the annotation and the beginning of the leader lines.
      Returns:
      a non-negative number that represents the length of the leader line offset, or null if leader line offset is not set.

    • setLeaderLineOffset

      public PdfLineAnnotation setLeaderLineOffset (float leaderLineOffset)
      Sets the length of the leader line offset, which is the amount of empty space between the endpoints of the annotation and the beginning of the leader lines.
      Parameters:
      leaderLineOffset - a non-negative number that represents the length of the leader line offset.
      Returns:
      this PdfLineAnnotation instance.

    • getContentsAsCaption

      public boolean getContentsAsCaption()
      If true, the text specified by the PdfName.Contents or PdfName.RC entries (see PdfAnnotation.getContents() and PdfMarkupAnnotation.getRichText()) is replicated as a caption in the appearance of the line.
      Returns:
      true, if the annotation text is replicated as a caption, false otherwise. If this property is not set, default value is used which is false.

    • setContentsAsCaption

      public PdfLineAnnotation setContentsAsCaption (boolean contentsAsCaption)
      If set to true, the text specified by the PdfName.Contents or PdfName.RC entries (see PdfAnnotation.getContents() and PdfMarkupAnnotation.getRichText()) will be replicated as a caption in the appearance of the line.
      Parameters:
      contentsAsCaption - true, if the annotation text should be replicated as a caption, false otherwise.
      Returns:
      this PdfLineAnnotation instance.

    • getCaptionPosition

      public PdfName getCaptionPosition()
      A name describing the annotation's caption positioning. Valid values are PdfName.Inline, meaning the caption is centered inside the line, and PdfName.Top, meaning the caption is on top of the line.
      Returns:
      a name describing the annotation's caption positioning, or null if the caption positioning is not explicitly defined (in this case the default value is used, which is PdfName.Inline).

    • setCaptionPosition

      public PdfLineAnnotation setCaptionPosition (PdfName captionPosition)
      Sets annotation's caption positioning. Valid values are PdfName.Inline, meaning the caption is centered inside the line, and PdfName.Top, meaning the caption is on top of the line.
      Parameters:
      captionPosition - a name describing the annotation's caption positioning.
      Returns:
      this PdfLineAnnotation instance.

    • getMeasure

      public PdfDictionary getMeasure()
      A measure dictionary (see ISO-320001, Table 261) that specifies the scale and units that apply to the line annotation.
      Returns:
      a PdfDictionary that represents a measure dictionary.

    • setMeasure

      public PdfLineAnnotation setMeasure (PdfDictionary measure)
      Sets a measure dictionary that specifies the scale and units that apply to the line annotation.
      Parameters:
      measure - a PdfDictionary that represents a measure dictionary, see ISO-320001, Table 261 for valid contents specification.
      Returns:
      this PdfLineAnnotation instance.

    • getCaptionOffset

      public PdfArray getCaptionOffset()
      An array of two numbers that specifies the offset of the caption text from its normal position. The first value is the horizontal offset along the annotation line from its midpoint, with a positive value indicating offset to the right and a negative value indicating offset to the left. The second value is the vertical offset perpendicular to the annotation line, with a positive value indicating a shift up and a negative value indicating a shift down.
      Returns:
      a PdfArray of two numbers that specifies the offset of the caption text from its normal position, or null if caption offset is not explicitly specified (in this case a default value is used, which is [0, 0]).

    • setCaptionOffset

      public PdfLineAnnotation setCaptionOffset (PdfArray captionOffset)
      Sets the offset of the caption text from its normal position.
      Parameters:
      captionOffset - a PdfArray of two numbers that specifies the offset of the caption text from its normal position. The first value defines the horizontal offset along the annotation line from its midpoint, with a positive value indicating offset to the right and a negative value indicating offset to the left. The second value defines the vertical offset perpendicular to the annotation line, with a positive value indicating a shift up and a negative value indicating a shift down.
      Returns:
      this PdfLineAnnotation instance.

    • setCaptionOffset

      public PdfLineAnnotation setCaptionOffset (float[] captionOffset)
      Sets the offset of the caption text from its normal position.
      Parameters:
      captionOffset - an array of two floats that specifies the offset of the caption text from its normal position. The first value defines the horizontal offset along the annotation line from its midpoint, with a positive value indicating offset to the right and a negative value indicating offset to the left. The second value defines the vertical offset perpendicular to the annotation line, with a positive value indicating a shift up and a negative value indicating a shift down.
      Returns:
      this PdfLineAnnotation instance.