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

Class InkAnnotation

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

public class InkAnnotation
extends DrawingAnnotation

A free-hand drawing annotation

Method Summary

Modifier and Type	Method	Description
static InkAnnotation	create(Document targetDocument, Path path, Stroke stroke)	Create a ink annotation.

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 InkAnnotation create(Document targetDocument,
                                   Path path,
                                   Stroke stroke)
                            throws UnsupportedFeatureException

Create a ink annotation.

The returned ink 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 free-hand drawing.

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

Returns:

The newly created ink 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 path argument has not been constructed with a pdftoolbox.pdf.content.PathGenerator

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 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 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 dash array is not empty

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

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

java.lang.IllegalArgumentException - if targetDocument is null

java.lang.IllegalArgumentException - if path is null

java.lang.IllegalArgumentException - if stroke is null