Package org.apache.pdfbox.pdmodel.fdf
Class FDFAnnotationInk
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
- org.apache.pdfbox.pdmodel.fdf.FDFAnnotationInk
-
- All Implemented Interfaces:
COSObjectable
public class FDFAnnotationInk extends FDFAnnotation
This represents a Ink FDF annotation.
-
-
Field Summary
Fields Modifier and Type Field Description private static org.apache.commons.logging.Log
LOG
static java.lang.String
SUBTYPE
COS Model value for SubType entry.-
Fields inherited from class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
annot
-
-
Constructor Summary
Constructors Constructor Description FDFAnnotationInk()
Default constructor.FDFAnnotationInk(COSDictionary a)
Constructor.FDFAnnotationInk(org.w3c.dom.Element element)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<float[]>
getInkList()
Get the paths making up the freehand "scribble".void
setInkList(java.util.List<float[]> inklist)
Set the paths making up the freehand "scribble".-
Methods inherited from class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
create, getBorderEffect, getBorderStyle, getColor, getContents, getCOSObject, getCreationDate, getDate, getIntent, getName, getOpacity, getPage, getRectangle, getRichContents, getStringOrStream, getSubject, getTitle, isHidden, isInvisible, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setBorderEffect, setBorderStyle, setColor, setContents, setCreationDate, setDate, setHidden, setIntent, setInvisible, setLocked, setLockedContents, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPage, setPrinted, setReadOnly, setRectangle, setRichContents, setSubject, setTitle, setToggleNoView
-
-
-
-
Field Detail
-
LOG
private static final org.apache.commons.logging.Log LOG
-
SUBTYPE
public static final java.lang.String SUBTYPE
COS Model value for SubType entry.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
FDFAnnotationInk
public FDFAnnotationInk()
Default constructor.
-
FDFAnnotationInk
public FDFAnnotationInk(COSDictionary a)
Constructor.- Parameters:
a
- An existing FDF Annotation.
-
FDFAnnotationInk
public FDFAnnotationInk(org.w3c.dom.Element element) throws java.io.IOException
Constructor.- Parameters:
element
- An XFDF element.- Throws:
java.io.IOException
- If there is an error extracting information from the element.
-
-
Method Detail
-
setInkList
public final void setInkList(java.util.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
- the List of arrays representing the paths.
-
getInkList
public java.util.List<float[]> getInkList()
Get the paths making up the freehand "scribble".- Returns:
- the List of arrays representing the paths.
- See Also:
setInkList(List)
-
-