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

public Class FDFAnnotationPolyline

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.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine, org.w3c.dom.Element
This represents a Polyline 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
FDFAnnotationPolyline()

Default constructor.

public
FDFAnnotationPolyline(COSDictionary
An existing FDF Annotation.
a)

Constructor.

public
FDFAnnotationPolyline(Element
An XFDF element.
element)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The ending style for the end point.
getEndPointEndingStyle()

This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.

public Color

Returns:

object representing the color.
getInteriorColor()

This will retrieve the interior color of the line endings defined in the LE entry.

public String

Returns:

The ending style for the start point.
getStartPointEndingStyle()

This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.

public float[]

Returns:

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

This will get the coordinates of the the vertices.

private void
initStyles(Element element)

private void
initVertices(Element element)

public void
setEndPointEndingStyle(String
The new style.
style)

This will set the line ending style for the end point, see the LE_ constants for the possible values.

public void
setInteriorColor(Color
The interior color of the line endings.
color)

This will set interior color of the line endings defined in the LE entry.

public void
setStartPointEndingStyle(String
The new style.
style)

This will set the line ending style for the start point, see the LE_ constants for the possible values.

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

This will set the coordinates of the 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

FDFAnnotationPolylineback to summary
public FDFAnnotationPolyline()

Default constructor.

FDFAnnotationPolylineback to summary
public FDFAnnotationPolyline(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

An existing FDF Annotation.

FDFAnnotationPolylineback to summary
public FDFAnnotationPolyline(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

getEndPointEndingStyleback to summary
public String getEndPointEndingStyle()

This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.

Returns:String

The ending style for the end point.

getInteriorColorback to summary
public Color getInteriorColor()

This will retrieve the interior color of the line endings defined in the LE entry.

Returns:Color

object representing the color.

getStartPointEndingStyleback to summary
public String getStartPointEndingStyle()

This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.

Returns:String

The ending style for the start point.

getVerticesback to summary
public float[] getVertices()

This will get the coordinates of the the vertices.

Returns:float[]

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

initStylesback to summary
private void initStyles(Element element)
initVerticesback to summary
private void initVertices(Element element) throws IOException
setEndPointEndingStyleback to summary
public void setEndPointEndingStyle(String style)

This will set the line ending style for the end point, see the LE_ constants for the possible values.

Parameters
style:String

The new style.

setInteriorColorback to summary
public void setInteriorColor(Color color)

This will set interior color of the line endings defined in the LE entry.

Parameters
color:Color

The interior color of the line endings.

setStartPointEndingStyleback to summary
public void setStartPointEndingStyle(String style)

This will set the line ending style for the start point, see the LE_ constants for the possible values.

Parameters
style:String

The new style.

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

This will set the coordinates of the the vertices.

Parameters
vertices:float[]

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