Class FDFAnnotationCaret

  • All Implemented Interfaces:
    COSObjectable

    public class FDFAnnotationCaret
    extends FDFAnnotation
    This represents a Caret FDF annotation.
    • Field Detail

      • SUBTYPE

        public static final java.lang.String SUBTYPE
        COS Model value for SubType entry.
        See Also:
        Constant Field Values
    • Constructor Detail

      • FDFAnnotationCaret

        public FDFAnnotationCaret()
        Default constructor.
      • FDFAnnotationCaret

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

        public FDFAnnotationCaret​(org.w3c.dom.Element element)
                           throws java.io.IOException
        Constructor.
        Parameters:
        element - An XFDF element.
        Throws:
        java.io.IOException - If there is an error extracting information from the element.
    • Method Detail

      • initFringe

        private void initFringe​(org.w3c.dom.Element element)
                         throws java.io.IOException
        Throws:
        java.io.IOException
      • 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​(java.lang.String symbol)
        This will set the symbol that shall be associated with the caret.
        Parameters:
        symbol - the symbol
      • getSymbol

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