Package com.pdf_tools.fourheights.pdftoolbox.pdf.annotations

Class LineAnnotation

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.LineAnnotation

public class LineAnnotation
extends DrawingAnnotation

A line annotation

An annotation that draws a line on a page.

Method Summary

Modifier and Type	Method	Description
static LineAnnotation	create(Document targetDocument, Point start, Point end, Stroke stroke)	Create a line annotation.
Point	getEnd()	The line's ending point (Getter)
LineEnding	getEndStyle()	The ending point's style (Getter)
Paint	getLineEndingFill()	The line ending filling paint (Getter)
Point	getStart()	The line's starting point (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, getId, 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

create

public static LineAnnotation create(Document targetDocument,
                                    Point start,
                                    Point end,
                                    Stroke stroke)

Create a line annotation.

The returned 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.

start - The line's start point.

end - The line's end point.

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

Returns:

The newly created line annotation.

Throws:

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

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

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

java.lang.IllegalArgumentException - if targetDocument is null

java.lang.IllegalArgumentException - if start is null

java.lang.IllegalArgumentException - if end is null

java.lang.IllegalArgumentException - if stroke is null

getStart

public Point getStart()

The line's starting point (Getter)

Throws:

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

getEnd

public Point getEnd()

The line's ending point (Getter)

Throws:

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

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 (Getter)

This paint applies to both the starting end the ending point.

Throws:

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