Package org.apache.pdfbox.pdmodel.fdf

Class FDFAnnotationCaret

java.lang.Object

org.apache.pdfbox.pdmodel.fdf.FDFAnnotation

org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCaret

All Implemented Interfaces:

COSObjectable

public class FDFAnnotationCaret
extends FDFAnnotation

This represents a Caret FDF annotation.

Author:

Ben Litchfield

Field Summary

Fields

Modifier and Type	Field	Description
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
FDFAnnotationCaret()	Default constructor.
FDFAnnotationCaret(COSDictionary a)	Constructor.
FDFAnnotationCaret(org.w3c.dom.Element element)	Constructor.

Method Summary

Modifier and Type	Method	Description
PDRectangle	getFringe()	This will retrieve the fringe.
java.lang.String	getSymbol()	This will retrieve the symbol that shall be associated with the caret.
void	setFringe(PDRectangle fringe)	This will set the fringe rectangle.
void	setSymbol(java.lang.String symbol)	This will set the symbol that shall be associated with the caret.

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

Methods inherited from class java.lang.Object

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

Field Detail

SUBTYPE

public static final java.lang.String SUBTYPE

COS Model value for SubType entry.

See Also:

Constant Field Values

Constructor Detail

FDFAnnotationCaret

public FDFAnnotationCaret()

Default constructor.

FDFAnnotationCaret

public FDFAnnotationCaret(COSDictionary a)

Constructor.

Parameters:

a - An existing FDF Annotation.

FDFAnnotationCaret

public FDFAnnotationCaret(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

setFringe

public final void setFringe(PDRectangle fringe)

This will set the fringe rectangle. Giving the difference between the annotations rectangle and where the drawing occurs.

Parameters:

fringe - the fringe

getFringe

public PDRectangle getFringe()

This will retrieve the fringe. Giving the difference between the annotations rectangle and where the drawing occurs.

Returns:

the rectangle difference

setSymbol

public final void setSymbol(java.lang.String symbol)

This will set the symbol that shall be associated with the caret.

Parameters:

symbol - the symbol

getSymbol

public java.lang.String getSymbol()

This will retrieve the symbol that shall be associated with the caret.

Returns:

the symbol