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

public Class FDFAnnotationPolygon

extends FDFAnnotation
Class Inheritance
Imports
java.awt.Color, java.io.IOException, javax.xml.xpath.XPath, .XPathExpressionException, .XPathFactory, org.apache.commons.logging.Log, .LogFactory, org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSName, org.w3c.dom.Element
This represents a Polygon FDF annotation.
Authors
Ben Litchfield, Johanneke Lamberink

Field Summary

Modifier and TypeField and Description
private static final Log
LOG

Hides org.apache.pdfbox.pdmodel.fdf.FDFAnnotation.LOG.

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
FDFAnnotationPolygon()

Default constructor.

public
FDFAnnotationPolygon(COSDictionary
An existing FDF Annotation.
a)

Constructor.

public
FDFAnnotationPolygon(Element
An XFDF element.
element)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public Color

Returns:

object representing the color.
getInteriorColor()

This will get interior color of the drawn area.

public float[]

Returns:

array of floats [x1, y1, x2, y2, ...] vertex coordinates in default user space.
getVertices()

This will get the coordinates of the vertices.

private void
initVertices(Element element)

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

This will set interior color of the drawn area.

public final void
setVertices(float[]
array of floats [x1, y1, x2, y2, ...] vertex coordinates in default user space.
vertices)

This will set the coordinates of the vertices.

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

Field Detail

LOGback to summary
private static final Log LOG

Hides org.apache.pdfbox.pdmodel.fdf.FDFAnnotation.LOG.

SUBTYPEback to summary
public static final String SUBTYPE

COS Model value for SubType entry.

Constructor Detail

FDFAnnotationPolygonback to summary
public FDFAnnotationPolygon()

Default constructor.

FDFAnnotationPolygonback to summary
public FDFAnnotationPolygon(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

An existing FDF Annotation.

FDFAnnotationPolygonback to summary
public FDFAnnotationPolygon(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

getInteriorColorback to summary
public Color getInteriorColor()

This will get interior color of the drawn area.

Returns:Color

object representing the color.

getVerticesback to summary
public float[] getVertices()

This will get the coordinates of the vertices.

Returns:float[]

array of floats [x1, y1, x2, y2, ...] vertex coordinates in default user space.

initVerticesback to summary
private void initVertices(Element element) throws IOException
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 drawn area.

setVerticesback to summary
public final void setVertices(float[] vertices)

This will set the coordinates of the vertices.

Parameters
vertices:float[]

array of floats [x1, y1, x2, y2, ...] vertex coordinates in default user space.