Package org.apache.pdfbox.pdmodel.interactive.annotation

Class PDAnnotationInk

java.lang.Object

org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation

org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationInk

All Implemented Interfaces:

COSObjectable

public class PDAnnotationInk
extends PDAnnotationMarkup

Field Summary

Fields

Modifier and Type	Field	Description
private PDAppearanceHandler	customAppearanceHandler
static final String	SUB_TYPE	The type of annotation.

Fields inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

RT_GROUP, RT_REPLY

Constructor Summary

Constructors

Constructor	Description
PDAnnotationInk()	Constructor.
PDAnnotationInk(COSDictionary dict)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	constructAppearances()	Create the appearance entry for this annotation.
void	constructAppearances(PDDocument document)	Create the appearance entry for this annotation.
float[][]	getInkList()	Get one or more disjoint paths that make this annotation.
void	setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)	Set a custom appearance handler for generating the annotations appearance streams.
void	setInkList(float[][] inkList)	Sets the paths that make this annotation.

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

getBorderStyle, getConstantOpacity, getCreationDate, getExternalData, getInReplyTo, getIntent, getPopup, getReplyType, getRichContents, getSubject, getTitlePopup, setBorderStyle, setConstantOpacity, setCreationDate, setExternalData, setInReplyTo, setIntent, setPopup, setReplyType, setRichContents, setSubject, setTitlePopup

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation

createAnnotation, equals, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getOptionalContent, getPage, getRectangle, getStructParent, getSubtype, hashCode, isHidden, isInvisible, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setBorder, setColor, setContents, setHidden, setInvisible, setLocked, setLockedContents, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setOptionalContent, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setSubtype, setToggleNoView

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

SUB_TYPE

public static final String SUB_TYPE

The type of annotation.

See Also:

• Constant Field Values

customAppearanceHandler

private PDAppearanceHandler customAppearanceHandler

Constructor Details

PDAnnotationInk

public PDAnnotationInk()

Constructor.

PDAnnotationInk

public PDAnnotationInk(COSDictionary dict)

Constructor.

Parameters:

dict - The annotations dictionary.

Method Details

setInkList

public void setInkList(float[][] inkList)

Sets the paths that make this annotation.

Parameters:

inkList - An array of arrays, each representing a stroked path. Each array shall be a series of alternating horizontal and vertical coordinates. If the parameter is null the entry will be removed.

getInkList

public float[][] getInkList()

Get one or more disjoint paths that make this annotation.

Returns:

An array of arrays, each representing a stroked path. Each array shall be a series of alternating horizontal and vertical coordinates.

setCustomAppearanceHandler

public void setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)

Set a custom appearance handler for generating the annotations appearance streams.

Parameters:

appearanceHandler - custom appearance handler

constructAppearances

public void constructAppearances()

Description copied from class: PDAnnotation

Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.

Overrides:

constructAppearances in class PDAnnotation

constructAppearances

public void constructAppearances(PDDocument document)

Description copied from class: PDAnnotation

Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.

Overrides:

constructAppearances in class PDAnnotation

Parameters:

document - the related document