Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.fdf

public Class FDFAnnotationInk

extends FDFAnnotation
Class Inheritance
Imports
java.io.IOException, java.util.ArrayList, .List, javax.xml.xpath.XPath, .XPathConstants, .XPathExpressionException, .XPathFactory, org.apache.commons.logging.Log, .LogFactory, org.apache.pdfbox.cos.COSArray, .COSBase, .COSDictionary, .COSName, org.w3c.dom.Element, .Node, .NodeList
This represents a Ink FDF annotation.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private static final Log
LOG

Hides org.apache.pdfbox.pdmodel.fdf.FDFAnnotation.LOG.

public static final String
SUBTYPE

COS Model value for SubType entry.

Inherited from org.apache.pdfbox.pdmodel.fdf.FDFAnnotation:
annot

Constructor Summary

AccessConstructor and Description
public
FDFAnnotationInk()

Default constructor.

public
FDFAnnotationInk(COSDictionary
An existing FDF Annotation.
a)

Constructor.

public
FDFAnnotationInk(Element
An XFDF element.
element)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public List<float[]>

Returns:

the List of arrays representing the paths.
getInkList()

Get the paths making up the freehand "scribble".

public final void
setInkList(List<float[]>
the List of arrays representing the paths.
inklist)

Set the paths making up the freehand "scribble".

Inherited from org.apache.pdfbox.pdmodel.fdf.FDFAnnotation:
creategetBorderEffectgetBorderStylegetColorgetContentsgetCOSObjectgetCreationDategetDategetIntentgetNamegetOpacitygetPagegetRectanglegetRichContentsgetStringOrStreamgetSubjectgetTitleisHiddenisInvisibleisLockedisLockedContentsisNoRotateisNoViewisNoZoomisPrintedisReadOnlyisToggleNoViewsetBorderEffectsetBorderStylesetColorsetContentssetCreationDatesetDatesetHiddensetIntentsetInvisiblesetLockedsetLockedContentssetNamesetNoRotatesetNoViewsetNoZoomsetOpacitysetPagesetPrintedsetReadOnlysetRectanglesetRichContentssetSubjectsetTitlesetToggleNoView

Field Detail

LOGback to summary
private static final Log LOG

Hides org.apache.pdfbox.pdmodel.fdf.FDFAnnotation.LOG.

SUBTYPEback to summary
public static final String SUBTYPE

COS Model value for SubType entry.

Constructor Detail

FDFAnnotationInkback to summary
public FDFAnnotationInk()

Default constructor.

FDFAnnotationInkback to summary
public FDFAnnotationInk(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

An existing FDF Annotation.

FDFAnnotationInkback to summary
public FDFAnnotationInk(Element element) throws IOException

Constructor.

Parameters
element:Element

An XFDF element.

Exceptions
IOException:
If there is an error extracting information from the element.

Method Detail

getInkListback to summary
public List<float[]> getInkList()

Get the paths making up the freehand "scribble".

Returns:List<float[]>

the List of arrays representing the paths.

See Also
setInkList(List)
setInkListback to summary
public final void setInkList(List<float[]> inklist)

Set the paths making up the freehand "scribble". The ink annotation is made up of one ore more disjoint paths. Each array entry is an array representing a stroked path, being a series of alternating horizontal and vertical coordinates in default user space.

Parameters
inklist:List<float[]>

the List of arrays representing the paths.