com.pdf_tools.fourheights.pdftoolbox.pdf.annotations

Class PolyLineAnnotation

java.lang.Object

com.pdf_tools.fourheights.pdftoolbox.internal.NativeBase

com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.Annotation

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.MarkupAnnotation

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.DrawingAnnotation

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.PolyLineAnnotation

public class PolyLineAnnotation
extends DrawingAnnotation

A drawing annotation that consists of several line segments

Method Summary

Modifier and Type	Method and Description
static PolyLineAnnotation	create(Document targetDocument, Path path, Stroke stroke) Create a poly-line annotation.
static PolyLineAnnotation	createDynamicObject(long handle)
LineEnding	getEndStyle() The ending point's style (Getter)
Paint	getLineEndingFill() The line ending filling paint for both start and end (Getter)
LineEnding	getStartStyle() The starting point's style (Getter)

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.DrawingAnnotation

getPaint, getPopup

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.MarkupAnnotation

getInfo, getLocked, getReplies

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.Annotation

copy, getBoundingBox, getHidden, getNoPrint, getNoRotate, getNoZoom

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

createDynamicObject

public static PolyLineAnnotation createDynamicObject(long handle)

create

public static PolyLineAnnotation create(Document targetDocument,
                                        Path path,
                                        Stroke stroke)
                                 throws ConformanceException,
                                        UnsupportedFeatureException

Create a poly-line annotation.

The returned poly-line annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters:

targetDocument - The output document with which the returned object is associated.

path - The path of the poly line.

stroke - The stroking parameters used for stroking the poly-line. The stroking paint is used as the annotation's main paint.

Returns:

The newly created poly-line annotation.

Throws:

java.lang.IllegalArgumentException - if the targetDocument is null

java.lang.IllegalArgumentException - if the targetDocument has already been closed

java.lang.IllegalArgumentException - if the targetDocument is read-only

java.lang.IllegalArgumentException - if the path argument is null

java.lang.IllegalArgumentException - if the targetDocument's conformance is not PDF 2.0 and the path argument contains curve-to operations

java.lang.IllegalArgumentException - if the path argument contains close-subpath or rectangle operations

UnsupportedFeatureException - if the targetDocument's conformance is PDF 2.0 and the path argument contains curve-to operations

java.lang.IllegalArgumentException - if the path argument has not been constructed with a pdftoolbox.pdf.content.PathGenerator

java.lang.IllegalArgumentException - if the stroke argument is null

java.lang.IllegalArgumentException - if the stroke argument is not associated with the targetDocument

java.lang.IllegalArgumentException - if the stroke's pdftoolbox.pdf.content.Stroke.getPaint has a pdftoolbox.pdf.content.Paint.getColorSpace other than a device color space

java.lang.IllegalArgumentException - if the stroke's pdftoolbox.pdf.content.Stroke.getPaint has a non-nullpdftoolbox.pdf.content.Paint.getTransparency with pdftoolbox.pdf.content.Transparency.getBlendMode other than pdftoolbox.pdf.content.BlendMode.NORMAL

java.lang.IllegalArgumentException - if the stroke argument's pdftoolbox.pdf.content.Stroke.getLineCapStyle is other than pdftoolbox.pdf.content.LineCapStyle.BUTT

java.lang.IllegalArgumentException - if the stroke argument's pdftoolbox.pdf.content.Stroke.getLineJoinStyle is other than pdftoolbox.pdf.content.LineJoinStyle.MITER

java.lang.IllegalArgumentException - if the stroke argument's pdftoolbox.pdf.content.Stroke.getMiterLimit is other than 10

java.lang.IllegalArgumentException - if the stroke argument's pdftoolbox.pdf.content.Stroke.getDashPhase is other than 0

ConformanceException - if the explicitly requested PDF conformance is smaller than PDF 1.5

getStartStyle

public LineEnding getStartStyle()

The starting point's style (Getter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

getEndStyle

public LineEnding getEndStyle()

The ending point's style (Getter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

getLineEndingFill

public Paint getLineEndingFill()

The line ending filling paint for both start and end (Getter)

Throws:

java.lang.IllegalStateException - if the object has already been closed