Package org.apache.pdfbox.pdmodel.fdf
Class FDFAnnotationCaret
java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCaret
- All Implemented Interfaces:
COSObjectable
This represents a Caret FDF annotation.
-
Field Summary
FieldsFields inherited from class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
annot
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Constructor.FDFAnnotationCaret
(Element element) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionThis will retrieve the fringe.This will retrieve the symbol that shall be associated with the caret.private void
initFringe
(Element element) final void
setFringe
(PDRectangle fringe) This will set the fringe rectangle.final void
This will set the symbol that shall be associated with the caret.Methods inherited from class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
create, getBorderEffect, getBorderStyle, getColor, getContents, getCOSObject, getCreationDate, getDate, getIntent, getName, getOpacity, getPage, getRectangle, getRichContents, getStringOrStream, getSubject, getTitle, isHidden, isInvisible, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setBorderEffect, setBorderStyle, setColor, setContents, setCreationDate, setDate, setHidden, setIntent, setInvisible, setLocked, setLockedContents, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPage, setPrinted, setReadOnly, setRectangle, setRichContents, setSubject, setTitle, setToggleNoView
-
Field Details
-
SUBTYPE
COS Model value for SubType entry.- See Also:
-
-
Constructor Details
-
FDFAnnotationCaret
public FDFAnnotationCaret()Default constructor. -
FDFAnnotationCaret
Constructor.- Parameters:
a
- An existing FDF Annotation.
-
FDFAnnotationCaret
Constructor.- Parameters:
element
- An XFDF element.- Throws:
IOException
- If there is an error extracting information from the element.
-
-
Method Details
-
initFringe
- Throws:
IOException
-
setFringe
This will set the fringe rectangle. Giving the difference between the annotations rectangle and where the drawing occurs.- Parameters:
fringe
- the fringe
-
getFringe
This will retrieve the fringe. Giving the difference between the annotations rectangle and where the drawing occurs.- Returns:
- the rectangle difference
-
setSymbol
This will set the symbol that shall be associated with the caret.- Parameters:
symbol
- the symbol
-
getSymbol
This will retrieve the symbol that shall be associated with the caret.- Returns:
- the symbol
-