com.datalogics.PDFL

Class PolygonAnnotation

java.lang.Object

com.datalogics.PDFL.Annotation

com.datalogics.PDFL.PolygonAnnotation

public class PolygonAnnotation
extends Annotation

A polygon is a closed plane figure bounded by a finite number of line segments. In this case the polygon is created as an annotation added to a PDF file.

Constructor Summary

Constructors

Constructor and Description
PolygonAnnotation(Page page, Rect initialRect, java.util.List<Point> vertices) Create a new PolygonAnnotation at the end of a page's annotation array.
PolygonAnnotation(Page page, Rect initialRect, java.util.List<Point> vertices, int addAfter) Create a new PolygonAnnotation at a specific index in the page's annotation array.

Method Summary

Modifier and Type	Method and Description
void	delete()
Form	generateAppearance() Generate a new appearance stream with the current annotation properties.
double	getAnnotationFeatureLevel() The minimum PDF version necessary to support the features used in this annotation.
java.lang.String	getBorderStyle()
java.util.List<java.lang.Double>	getBorderStyleDashPattern()
double	getBorderStyleWidth()
java.util.List<Point>	getVertices()
void	setAnnotationFeatureLevel(double featureLevel) Removes features not supported in the supplied version number.
void	setBorderStyle(java.lang.String style)
void	setBorderStyleDashPattern(java.util.List<java.lang.Double> dashPattern)
void	setBorderStyleWidth(double width)
void	setVertices(java.util.List<Point> vertices) The vertices that define the polygon annotation, in user space.

Methods inherited from class com.datalogics.PDFL.Annotation

equals, getColor, getContents, getFlags, getInteriorColor, getNormalAppearance, getOpacity, getOptionalContentMembershipDict, getPDFDict, getRect, getSubtype, getTitle, hasRichTextData, isCurrentlyVisible, setColor, setContents, setFlags, setInteriorColor, setNormalAppearance, setOpacity, setOptionalContentMembershipDict, setRect, setTitle, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PolygonAnnotation

public PolygonAnnotation(Page page,
                         Rect initialRect,
                         java.util.List<Point> vertices)

Create a new PolygonAnnotation at the end of a page's annotation array. To create a PolygonAnnotation and place it elsewhere in the page's annotation array, use the version of the constructor that takes an array position.

Parameters:

page - The page to which the PolygonAnnotation is added.

initialRect - A rectangle specifying the annotation's bounds, specified in user space coordinates.

vertices - A list of points representing the coordinates of the vertices, specified in user space.

PolygonAnnotation

public PolygonAnnotation(Page page,
                         Rect initialRect,
                         java.util.List<Point> vertices,
                         int addAfter)

Create a new PolygonAnnotation at a specific index in the page's annotation array.

Parameters:

page - The page to which the annotation is added.

initialRect - A rectangle specifying the annotation's bounds, specified in user space coordinates.

vertices - A list of points representing the coordinates of the vertices, specified in user space.

addAfter - Where to add the annotation in the page's annotation array. To add the annotation to the end of the array, pass a value of -2 or use the alternate version of this constructor that does not take an index (this is generally what you should do unless you have a need to place the annotation at a special location in the array). Passing a value of -1 adds the annotation to the beginning of the array. Passing other negative values produces undefined results.

Method Detail

delete

public void delete()

Overrides:

delete in class Annotation

generateAppearance

public Form generateAppearance()

Generate a new appearance stream with the current annotation properties.

The resulting Form can then be used to set the annotation's appearance, such as by calling SetNormalAppearance.

Overrides:

generateAppearance in class Annotation

getAnnotationFeatureLevel

public double getAnnotationFeatureLevel()

The minimum PDF version necessary to support the features used in this annotation.

Overrides:

getAnnotationFeatureLevel in class Annotation

setAnnotationFeatureLevel

public void setAnnotationFeatureLevel(double featureLevel)

Removes features not supported in the supplied version number.

Overrides:

setAnnotationFeatureLevel in class Annotation

getVertices

public java.util.List<Point> getVertices()

Returns:

The array of points, in order, that define the vertices of the polygon in user space coordinates.

setVertices

public void setVertices(java.util.List<Point> vertices)

The vertices that define the polygon annotation, in user space.

Parameters:

vertices - The array of points, in order, that define the vertices of the polygon in user space coordinates.

getBorderStyleWidth

public double getBorderStyleWidth()

setBorderStyleWidth

public void setBorderStyleWidth(double width)

getBorderStyle

public java.lang.String getBorderStyle()

setBorderStyle

public void setBorderStyle(java.lang.String style)

getBorderStyleDashPattern

public java.util.List<java.lang.Double> getBorderStyleDashPattern()

setBorderStyleDashPattern

public void setBorderStyleDashPattern(java.util.List<java.lang.Double> dashPattern)