org.apache.pdfbox.pdmodel.fdf

Class FDFAnnotationPolyline

java.lang.Object

org.apache.pdfbox.pdmodel.fdf.FDFAnnotation

org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline

All Implemented Interfaces:

COSObjectable

public class FDFAnnotationPolyline
extends FDFAnnotation

This represents a Polyline FDF annotation.

Author:

Ben Litchfield, Johanneke Lamberink

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUBTYPE COS Model value for SubType entry.

Fields inherited from class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation

annot

Constructor Summary

Constructors

Constructor and Description
FDFAnnotationPolyline() Default constructor.
FDFAnnotationPolyline(COSDictionary a) Constructor.
FDFAnnotationPolyline(Element element) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getEndPointEndingStyle() This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.
Color	getInteriorColor() This will retrieve the interior color of the line endings defined in the LE entry.
String	getStartPointEndingStyle() This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.
float[]	getVertices() This will get the coordinates of the vertices.
void	setEndPointEndingStyle(String style) This will set the line ending style for the end point, see the LE_ constants for the possible values.
void	setInteriorColor(Color color) This will set interior color of the line endings defined in the LE entry.
void	setStartPointEndingStyle(String style) This will set the line ending style for the start point, see the LE_ constants for the possible values.
void	setVertices(float[] vertices) This will set the coordinates of the vertices.

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, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setBorderEffect, setBorderStyle, setColor, setContents, setCreationDate, setDate, setHidden, setIntent, setInvisible, setLocked, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPage, setPrinted, setReadOnly, setRectangle, setRichContents, setSubject, setTitle, setToggleNoView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBTYPE

public static final String SUBTYPE

COS Model value for SubType entry.

See Also:

Constant Field Values

Constructor Detail

FDFAnnotationPolyline

public FDFAnnotationPolyline()

Default constructor.

FDFAnnotationPolyline

public FDFAnnotationPolyline(COSDictionary a)

Constructor.

Parameters:

a - An existing FDF Annotation.

FDFAnnotationPolyline

public FDFAnnotationPolyline(Element element)
                      throws IOException

Constructor.

Parameters:

element - An XFDF element.

Throws:

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

Method Detail

setVertices

public void setVertices(float[] vertices)

This will set the coordinates of the vertices.

Parameters:

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

getVertices

public float[] getVertices()

This will get the coordinates of the vertices.

Returns:

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

setStartPointEndingStyle

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 - The new style.

getStartPointEndingStyle

public String getStartPointEndingStyle()

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

Returns:

The ending style for the start point.

setEndPointEndingStyle

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 - The new style.

getEndPointEndingStyle

public String getEndPointEndingStyle()

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

Returns:

The ending style for the end point.

setInteriorColor

public void setInteriorColor(Color color)

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

Parameters:

color - The interior color of the line endings.

getInteriorColor

public Color getInteriorColor()

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

Returns:

object representing the color.