com.qoppa.pdf.annotations

Interface Polyline

All Superinterfaces:

Annotation, ShapeAnnotation

public interface Polyline
extends ShapeAnnotation

Class representing a Polyline annotation in a PDF document. Polyline annotations are displayed as a series of connected vertices and can be double-clicked to display its note.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static String	POLYLINE_DIMENSION

Fields inherited from interface com.qoppa.pdf.annotations.ShapeAnnotation

LE_BUTT, LE_BUTT_STR, LE_CIRCLE, LE_CIRCLE_STR, LE_CLOSEDARROW, LE_CLOSEDARROW_STR, LE_DIAMOND, LE_DIAMOND_STR, LE_NONE, LE_NONE_STR, LE_OPENARROW, LE_OPENARROW_STR, LE_REVERSE_CLOSED_ARROW, LE_REVERSE_CLOSED_ARROW_STR, LE_REVERSE_OPEN_ARROW, LE_REVERSE_OPEN_ARROW_STR, LE_SLASH, LE_SLASH_STR, LE_SQUARE, LE_SQUARE_STR

Fields inherited from interface com.qoppa.pdf.annotations.Annotation

BORDERSTYLE_BEVELED, BORDERSTYLE_CLOUD, BORDERSTYLE_DASHED, BORDERSTYLE_INSETS, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAGS_HIDDEN, FLAGS_INVISIBLE, FLAGS_LOCKED, FLAGS_LOCKEDCONTENTS, FLAGS_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINTABLE, FLAGS_READONLY

Method Summary

Methods

Modifier and Type	Method and Description
Date	getCreationDate() Returns the date and time when the annotation was created.
String	getIntent() Returns the description of the intent of the Line Annotation
int	getLineEndStyle() Returns the polyline end style.
int	getLineStartStyle() Returns the polyline start style.
Vertices	getVertices() Returns an object that manages the vertices in the polygon.
boolean	isIntentDimension() Returns a flag indicating whether this polygon's intent is a dimension (measuring tool)
void	revalidateRectangle()
void	setLineEndStyle(String style) Sets the polyline end style.
void	setLineStartStyle(String style) Sets the polyline start style.

Methods inherited from interface com.qoppa.pdf.annotations.ShapeAnnotation

getContents, getInternalColor, getStroke, setContents, setInternalColor, setStroke

Methods inherited from interface com.qoppa.pdf.annotations.Annotation

getActions, getAnnotationComponent, getBorderStyle, getBorderWidth, getCheckmarkStatus, getColor, getComponent, getCreator, getFlags, getModifiedDate, getName, getOpacity, getPageIndex, getRectangle, getReviewHistory, getSubject, getSubtype, getTriggerActions, isHidden, isInvisible, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setLockedContents, setModifiedDate, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPrintable, setReadOnly, setRectangle, setSubject, setSubtype, setTriggerActions, shiftRectangle

Field Detail

POLYLINE_DIMENSION

static final String POLYLINE_DIMENSION

See Also:

Constant Field Values

Method Detail

revalidateRectangle

void revalidateRectangle()

getIntent

String getIntent()

Returns the description of the intent of the Line Annotation

Returns:

intent

isIntentDimension

boolean isIntentDimension()

Returns a flag indicating whether this polygon's intent is a dimension (measuring tool)

Returns:

Flag indicating whether the intent of this polygon is for dimension (measurement tool)

getVertices

Vertices getVertices()

Returns an object that manages the vertices in the polygon. The object has methods to get the vertices, and to add and remove vertices.

Returns:

The vertices in the polygon.

getCreationDate

Date getCreationDate()

Returns the date and time when the annotation was created. Milliseconds are always zero since the PDF date format doesn't support milliseconds.

Returns:

The date and time when the annotation was created.

setLineEndStyle

void setLineEndStyle(String style)

Sets the polyline end style.

Possible values are:

• ShapeAnnotation.LE_NONE_STR
• ShapeAnnotation.LE_SQUARE_STR
• ShapeAnnotation.LE_CIRCLE_STR
• ShapeAnnotation.LE_DIAMOND_STR
• ShapeAnnotation.LE_OPENARROW_STR
• ShapeAnnotation.LE_CLOSEDARROW_STR
• ShapeAnnotation.LE_BUTT_STR
• ShapeAnnotation.LE_REVERSE_OPEN_ARROW_STR
• ShapeAnnotation.LE_REVERSE_CLOSED_ARROW_STR
• ShapeAnnotation.LE_SLASH_STR

Parameters:

style - The polyline end style

setLineStartStyle

void setLineStartStyle(String style)

Sets the polyline start style.

Possible values are:

• ShapeAnnotation.LE_NONE_STR
• ShapeAnnotation.LE_SQUARE_STR
• ShapeAnnotation.LE_CIRCLE_STR
• ShapeAnnotation.LE_DIAMOND_STR
• ShapeAnnotation.LE_OPENARROW_STR
• ShapeAnnotation.LE_CLOSEDARROW_STR
• ShapeAnnotation.LE_BUTT_STR
• ShapeAnnotation.LE_REVERSE_OPEN_ARROW_STR
• ShapeAnnotation.LE_REVERSE_CLOSED_ARROW_STR
• ShapeAnnotation.LE_SLASH_STR

Parameters:

style - The polyline start style

getLineEndStyle

int getLineEndStyle()

Returns the polyline end style.

Returns:

The polyline end style

getLineStartStyle

int getLineStartStyle()

Returns the polyline start style.

Returns:

The polyline start style