Package org.apache.pdfbox.pdmodel.fdf
Class FDFAnnotationSquare
java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquare
- All Implemented Interfaces:
COSObjectable
This represents a Square FDF annotation.
-
Field Summary
FieldsFields inherited from class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
annot
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Constructor.FDFAnnotationSquare
(Element element) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionThis will get the fringe.This will retrieve the interior color of the drawn area.private void
initFringe
(Element element) final void
setFringe
(PDRectangle fringe) This will set the fringe rectangle.final void
setInteriorColor
(Color color) This will set interior color of the drawn area.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
-
FDFAnnotationSquare
public FDFAnnotationSquare()Default constructor. -
FDFAnnotationSquare
Constructor.- Parameters:
a
- An existing FDF Annotation.
-
FDFAnnotationSquare
Constructor.- Parameters:
element
- An XFDF element.- Throws:
IOException
- If there is an error extracting information from the element.
-
-
Method Details
-
initFringe
- Throws:
IOException
-
setInteriorColor
This will set interior color of the drawn area.- Parameters:
color
- The interior color of the circle.
-
getInteriorColor
This will retrieve the interior color of the drawn area.- Returns:
- object representing the color.
-
setFringe
This will set the fringe rectangle. Giving the difference between the annotations rectangle and where the drawing occurs. (To take account of any effects applied through the BE entry for example)- Parameters:
fringe
- the fringe
-
getFringe
This will get the fringe. Giving the difference between the annotations rectangle and where the drawing occurs. (To take account of any effects applied through the BE entry for example)- Returns:
- the rectangle difference
-