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

public Class FDFAnnotationText

extends FDFAnnotation
Class Inheritance
Imports
java.io.IOException, org.apache.pdfbox.cos.COSDictionary, .COSName, org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText, org.w3c.dom.Element
This represents a Text FDF annotation.
Authors
Ben Litchfield, Johanneke Lamberink

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
FDFAnnotationText()

Default constructor.

public
FDFAnnotationText(COSDictionary
An existing FDF Annotation.
a)

Constructor.

public
FDFAnnotationText(Element
An XFDF element.
element)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The name of this annotation, see the PDAnnotationText.NAME_XXX constants.
getIcon()

This will retrieve the icon (and hence appearance, AP taking precedence) For this annotation.

public String

Returns:

the annotation state
getState()

This will retrieve the annotation state.

public String

Returns:

the annotation state model
getStateModel()

This will retrieve the annotation state model.

public final void
setIcon(String
The name of the annotation
icon)

This will set the icon (and hence appearance, AP taking precedence) For this annotation.

public final void
setState(String
the annotation state
state)

This will set the annotation state.

public final void
setStateModel(String
the annotation state model
stateModel)

This will set the annotation state model.

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

FDFAnnotationTextback to summary
public FDFAnnotationText()

Default constructor.

FDFAnnotationTextback to summary
public FDFAnnotationText(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

An existing FDF Annotation.

FDFAnnotationTextback to summary
public FDFAnnotationText(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

getIconback to summary
public String getIcon()

This will retrieve the icon (and hence appearance, AP taking precedence) For this annotation. The default is NOTE.

Returns:String

The name of this annotation, see the PDAnnotationText.NAME_XXX constants.

getStateback to summary
public String getState()

This will retrieve the annotation state.

Returns:String

the annotation state

getStateModelback to summary
public String getStateModel()

This will retrieve the annotation state model.

Returns:String

the annotation state model

setIconback to summary
public final void setIcon(String icon)

This will set the icon (and hence appearance, AP taking precedence) For this annotation. See the PDAnnotationText.NAME_XXX constants for valid values.

Parameters
icon:String

The name of the annotation

setStateback to summary
public final void setState(String state)

This will set the annotation state.

Parameters
state:String

the annotation state

setStateModelback to summary
public final void setStateModel(String stateModel)

This will set the annotation state model. Allowed values are "Marked" and "Review"

Parameters
stateModel:String

the annotation state model