Class FDFAnnotationCaret

java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCaret
All Implemented Interfaces:
COSObjectable

public class FDFAnnotationCaret extends FDFAnnotation
This represents a Caret FDF annotation.
Author:
Ben Litchfield
  • Field Details

  • Constructor Details

    • FDFAnnotationCaret

      public FDFAnnotationCaret()
      Default constructor.
    • FDFAnnotationCaret

      public FDFAnnotationCaret(COSDictionary a)
      Constructor.
      Parameters:
      a - An existing FDF Annotation.
    • FDFAnnotationCaret

      public FDFAnnotationCaret(Element element) throws IOException
      Constructor.
      Parameters:
      element - An XFDF element.
      Throws:
      IOException - If there is an error extracting information from the element.
  • Method Details

    • setFringe

      public final void setFringe(PDRectangle fringe)
      This will set the fringe rectangle. Giving the difference between the annotations rectangle and where the drawing occurs.
      Parameters:
      fringe - the fringe
    • getFringe

      public PDRectangle getFringe()
      This will retrieve the fringe. Giving the difference between the annotations rectangle and where the drawing occurs.
      Returns:
      the rectangle difference
    • setSymbol

      public final void setSymbol(String symbol)
      This will set the symbol that shall be associated with the caret.
      Parameters:
      symbol - the symbol
    • getSymbol

      public String getSymbol()
      This will retrieve the symbol that shall be associated with the caret.
      Returns:
      the symbol