Module org.sejda.sambox
Package org.sejda.sambox.pdmodel.interactive.annotation

Class PDAnnotationLine

java.lang.Object
org.sejda.sambox.pdmodel.common.PDDictionaryWrapper
org.sejda.sambox.pdmodel.interactive.annotation.PDAnnotation
org.sejda.sambox.pdmodel.interactive.annotation.PDAnnotationMarkup
org.sejda.sambox.pdmodel.interactive.annotation.PDAnnotationLine
All Implemented Interfaces:
COSObjectable
public class PDAnnotationLine extends PDAnnotationMarkup
This is the class that represents a line annotation. Introduced in PDF 1.3 specification
Author:
Paul King

  • Field Details

  • Constructor Details

    • PDAnnotationLine

      public PDAnnotationLine()
      Constructor.

    • PDAnnotationLine

      public PDAnnotationLine(COSDictionary field)
      Creates a Line annotation from a COSDictionary, expected to be a correct object definition.
      Parameters:
      field - the PDF object to represent as a field.

  • Method Details

    • setLine

      public void setLine(float[] l)
      This will set start and end coordinates of the line (or leader line if LL entry is set).
      Parameters:
      l - array of 4 floats [x1, y1, x2, y2] line start and end points in default user space.

    • getLine

      public float[] getLine()
      This will retrieve the start and end coordinates of the line (or leader line if LL entry is set).
      Returns:
      array of floats [x1, y1, x2, y2] line start and end points in default user space.

    • setStartPointEndingStyle

      public void setStartPointEndingStyle(String style)
      This will set the line ending style for the start point, see the LE_ constants for the possible values.
      Overrides:
      setStartPointEndingStyle in class PDAnnotationMarkup
      Parameters:
      style - The new style.

    • getStartPointEndingStyle

      public String getStartPointEndingStyle()
      This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.
      Overrides:
      getStartPointEndingStyle in class PDAnnotationMarkup
      Returns:
      The ending style for the start point.

    • setEndPointEndingStyle

      public void setEndPointEndingStyle(String style)
      This will set the line ending style for the end point, see the LE_ constants for the possible values.
      Overrides:
      setEndPointEndingStyle in class PDAnnotationMarkup
      Parameters:
      style - The new style.

    • getEndPointEndingStyle

      public String getEndPointEndingStyle()
      This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.
      Overrides:
      getEndPointEndingStyle in class PDAnnotationMarkup
      Returns:
      The ending style for the end point.

    • setInteriorColor

      public void setInteriorColor(PDColor ic)
      This will set interior color of the line endings defined in the LE entry. color is in DeviceRGB color space.
      Overrides:
      setInteriorColor in class PDAnnotationMarkup
      Parameters:
      ic - color in the DeviceRGB color space.

    • getInteriorColor

      public PDColor getInteriorColor()
      This will retrieve the interior color of the line endings defined in the LE entry. color is in DeviceRGB color space.
      Overrides:
      getInteriorColor in class PDAnnotationMarkup
      Returns:
      object representing the color.

    • setCaption

      public void setCaption(boolean cap)
      This will set if the contents are shown as a caption to the line.
      Parameters:
      cap - Boolean value.

    • getCaption

      public boolean getCaption()
      This will retrieve if the contents are shown as a caption or not.
      Returns:
      boolean if the content is shown as a caption.

    • setBorderStyle

      public void setBorderStyle(PDBorderStyleDictionary bs)
      This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
      Overrides:
      setBorderStyle in class PDAnnotationMarkup
      Parameters:
      bs - the border style dictionary to set.

    • getBorderStyle

      public PDBorderStyleDictionary getBorderStyle()
      This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
      Overrides:
      getBorderStyle in class PDAnnotationMarkup
      Returns:
      the border style dictionary.

    • getLeaderLineLength

      public float getLeaderLineLength()
      This will retrieve the length of the leader line.
      Returns:
      the length of the leader line

    • setLeaderLineLength

      public void setLeaderLineLength(float leaderLineLength)
      This will set the length of the leader line.
      Parameters:
      leaderLineLength - length of the leader line

    • getLeaderLineExtensionLength

      public float getLeaderLineExtensionLength()
      This will retrieve the length of the leader line extensions.
      Returns:
      the length of the leader line extensions

    • setLeaderLineExtensionLength

      public void setLeaderLineExtensionLength(float leaderLineExtensionLength)
      This will set the length of the leader line extensions.
      Parameters:
      leaderLineExtensionLength - length of the leader line extensions

    • getLeaderLineOffsetLength

      public float getLeaderLineOffsetLength()
      This will retrieve the length of the leader line offset.
      Returns:
      the length of the leader line offset

    • setLeaderLineOffsetLength

      public void setLeaderLineOffsetLength(float leaderLineOffsetLength)
      This will set the length of the leader line offset.
      Parameters:
      leaderLineOffsetLength - length of the leader line offset

    • getCaptionPositioning

      public String getCaptionPositioning()
      This will retrieve the caption positioning.
      Returns:
      the caption positioning

    • setCaptionPositioning

      public void setCaptionPositioning(String captionPositioning)
      This will set the caption positioning. Allowed values are: "Inline" and "Top"
      Parameters:
      captionPositioning - caption positioning

    • setCaptionHorizontalOffset

      public void setCaptionHorizontalOffset(float offset)
      This will set the horizontal offset of the caption.
      Parameters:
      offset - the horizontal offset of the caption

    • getCaptionHorizontalOffset

      public float getCaptionHorizontalOffset()
      This will retrieve the horizontal offset of the caption.
      Returns:
      the horizontal offset of the caption

    • setCaptionVerticalOffset

      public void setCaptionVerticalOffset(float offset)
      This will set the vertical offset of the caption.
      Parameters:
      offset - vertical offset of the caption

    • getCaptionVerticalOffset

      public float getCaptionVerticalOffset()
      This will retrieve the vertical offset of the caption.
      Returns:
      the vertical offset of the caption

    • setCustomAppearanceHandler

      public void setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)
      Set a custom appearance handler for generating the annotations appearance streams.
      Overrides:
      setCustomAppearanceHandler in class PDAnnotationMarkup
      Parameters:
      appearanceHandler -

    • constructAppearances

      public void constructAppearances()
      Description copied from class: PDAnnotation
      Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.
      Overrides:
      constructAppearances in class PDAnnotationMarkup