Package org.apache.pdfbox.pdmodel.fdf
Class FDFAnnotationText
java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
org.apache.pdfbox.pdmodel.fdf.FDFAnnotationText
- All Implemented Interfaces:
COSObjectable
This represents a Text FDF annotation.
-
Field Summary
FieldsFields inherited from class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
annot
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Constructor.FDFAnnotationText
(Element element) Constructor. -
Method Summary
Modifier and TypeMethodDescriptiongetIcon()
This will retrieve the icon (and hence appearance, AP taking precedence) For this annotation.getState()
This will retrieve the annotation state.This will retrieve the annotation state model.void
This will set the icon (and hence appearance, AP taking precedence) For this annotation.void
This will set the annotation state.void
setStateModel
(String stateModel) This will set the annotation state model.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 Details
-
SUBTYPE
COS Model value for SubType entry.- See Also:
-
-
Constructor Details
-
FDFAnnotationText
public FDFAnnotationText()Default constructor. -
FDFAnnotationText
Constructor.- Parameters:
a
- An existing FDF Annotation.
-
FDFAnnotationText
Constructor.- Parameters:
element
- An XFDF element.- Throws:
IOException
- If there is an error extracting information from the element.
-
-
Method Details
-
setIcon
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
- The name of the annotation
-
getIcon
This will retrieve the icon (and hence appearance, AP taking precedence) For this annotation. The default is NOTE.- Returns:
- The name of this annotation, see the PDAnnotationText.NAME_XXX constants.
-
getState
This will retrieve the annotation state.- Returns:
- the annotation state
-
setState
This will set the annotation state.- Parameters:
state
- the annotation state
-
getStateModel
This will retrieve the annotation state model.- Returns:
- the annotation state model
-
setStateModel
This will set the annotation state model. Allowed values are "Marked" and "Review"- Parameters:
stateModel
- the annotation state model
-