Package org.apache.pdfbox.pdmodel.fdf
Class FDFAnnotationCircle
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
- org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCircle
-
- All Implemented Interfaces:
COSObjectable
public class FDFAnnotationCircle extends FDFAnnotation
This represents a Circle FDF annotation.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SUBTYPE
COS Model value for SubType entry.-
Fields inherited from class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
annot
-
-
Constructor Summary
Constructors Constructor Description FDFAnnotationCircle()
Default constructor.FDFAnnotationCircle(COSDictionary a)
Constructor.FDFAnnotationCircle(org.w3c.dom.Element element)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PDRectangle
getFringe()
This will get the fringe.java.awt.Color
getInteriorColor()
This will retrieve the interior color of the drawn area.private void
initFringe(org.w3c.dom.Element element)
void
setFringe(PDRectangle fringe)
This will set the fringe rectangle.void
setInteriorColor(java.awt.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 Detail
-
SUBTYPE
public static final java.lang.String SUBTYPE
COS Model value for SubType entry.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
FDFAnnotationCircle
public FDFAnnotationCircle()
Default constructor.
-
FDFAnnotationCircle
public FDFAnnotationCircle(COSDictionary a)
Constructor.- Parameters:
a
- An existing FDF Annotation.
-
FDFAnnotationCircle
public FDFAnnotationCircle(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
-
setInteriorColor
public final void setInteriorColor(java.awt.Color color)
This will set interior color of the drawn area.- Parameters:
color
- The interior color of the circle.
-
getInteriorColor
public java.awt.Color getInteriorColor()
This will retrieve the interior color of the drawn area.- Returns:
- object representing the color.
-
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. (To take account of any effects applied through the BE entry for example)- Parameters:
fringe
- the fringe
-
getFringe
public PDRectangle 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
-
-