Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.fdf

public Class FDFAnnotationCircle

extends FDFAnnotation
Class Inheritance
Imports
java.awt.Color, java.io.IOException, org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.PDRectangle, org.w3c.dom.Element
This represents a Circle FDF annotation.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
public static final String
SUBTYPE

COS Model value for SubType entry.

Inherited from org.apache.pdfbox.pdmodel.fdf.FDFAnnotation:
annot

Constructor Summary

AccessConstructor and Description
public
FDFAnnotationCircle()

Default constructor.

public
FDFAnnotationCircle(COSDictionary
An existing FDF Annotation.
a)

Constructor.

public
FDFAnnotationCircle(Element
An XFDF element.
element)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public PDRectangle

Returns:

the rectangle difference
getFringe()

This will get the fringe.

public Color

Returns:

object representing the color.
getInteriorColor()

This will retrieve the interior color of the drawn area.

private void
initFringe(Element element)

public final void
setFringe(PDRectangle
the fringe
fringe)

This will set the fringe rectangle.

public final void
setInteriorColor(Color
The interior color of the circle.
color)

This will set interior color of the drawn area.

Inherited from org.apache.pdfbox.pdmodel.fdf.FDFAnnotation:
creategetBorderEffectgetBorderStylegetColorgetContentsgetCOSObjectgetCreationDategetDategetIntentgetNamegetOpacitygetPagegetRectanglegetRichContentsgetStringOrStreamgetSubjectgetTitleisHiddenisInvisibleisLockedisLockedContentsisNoRotateisNoViewisNoZoomisPrintedisReadOnlyisToggleNoViewsetBorderEffectsetBorderStylesetColorsetContentssetCreationDatesetDatesetHiddensetIntentsetInvisiblesetLockedsetLockedContentssetNamesetNoRotatesetNoViewsetNoZoomsetOpacitysetPagesetPrintedsetReadOnlysetRectanglesetRichContentssetSubjectsetTitlesetToggleNoView

Field Detail

SUBTYPEback to summary
public static final String SUBTYPE

COS Model value for SubType entry.

Constructor Detail

FDFAnnotationCircleback to summary
public FDFAnnotationCircle()

Default constructor.

FDFAnnotationCircleback to summary
public FDFAnnotationCircle(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

An existing FDF Annotation.

FDFAnnotationCircleback to summary
public FDFAnnotationCircle(Element element) throws IOException

Constructor.

Parameters
element:Element

An XFDF element.

Exceptions
IOException:
If there is an error extracting information from the element.

Method Detail

getFringeback to summary
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:PDRectangle

the rectangle difference

getInteriorColorback to summary
public Color getInteriorColor()

This will retrieve the interior color of the drawn area.

Returns:Color

object representing the color.

initFringeback to summary
private void initFringe(Element element) throws IOException
setFringeback to summary
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:PDRectangle

the fringe

setInteriorColorback to summary
public final void setInteriorColor(Color color)

This will set interior color of the drawn area.

Parameters
color:Color

The interior color of the circle.