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

public Class FDFAnnotationCaret

extends FDFAnnotation
Class Inheritance
Imports
java.io.IOException, org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.PDRectangle, org.w3c.dom.Element
This represents a Caret FDF annotation.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
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
FDFAnnotationCaret()

Default constructor.

public
FDFAnnotationCaret(COSDictionary
An existing FDF Annotation.
a)

Constructor.

public
FDFAnnotationCaret(Element
An XFDF element.
element)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public PDRectangle

Returns:

the rectangle difference
getFringe()

This will retrieve the fringe.

public String

Returns:

the symbol
getSymbol()

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

private void
initFringe(Element element)

public final void
setFringe(PDRectangle
the fringe
fringe)

This will set the fringe rectangle.

public final void
setSymbol(String
the symbol
symbol)

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

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

Field Detail

SUBTYPEback to summary
public static final String SUBTYPE

COS Model value for SubType entry.

Constructor Detail

FDFAnnotationCaretback to summary
public FDFAnnotationCaret()

Default constructor.

FDFAnnotationCaretback to summary
public FDFAnnotationCaret(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

An existing FDF Annotation.

FDFAnnotationCaretback to summary
public FDFAnnotationCaret(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

getFringeback to summary
public PDRectangle getFringe()

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

Returns:PDRectangle

the rectangle difference

getSymbolback to summary
public String getSymbol()

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

Returns:String

the symbol

initFringeback to summary
private void initFringe(Element element) throws IOException
setFringeback to summary
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:PDRectangle

the fringe

setSymbolback to summary
public final void setSymbol(String symbol)

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

Parameters
symbol:String

the symbol