Package org.apache.pdfbox.pdmodel.fdf
Class FDFAnnotationFreeText
java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
- All Implemented Interfaces:
COSObjectable
This represents a FreeText FDF annotation.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final org.apache.commons.logging.Log
static final String
COS Model value for SubType entry.Fields inherited from class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
annot
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Constructor.FDFAnnotationFreeText
(Element element) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionfloat[]
This will get the coordinates of the callout line.Get the default appearance string.Get the default style string.This will get the fringe.This will get the form of quadding (justification) of the annotation text.This will retrieve the line ending style.This will get the clockwise rotation in degrees.private void
initCallout
(Element element) private void
initFringe
(Element element) void
setCallout
(float[] callout) This will set the coordinates of the callout line.final void
setDefaultAppearance
(String appearance) Set the default appearance string.final void
setDefaultStyle
(String style) Set the default style string.final void
setFringe
(PDRectangle fringe) This will set the fringe rectangle.final void
setJustification
(String justification) This will set the form of quadding (justification) of the annotation text.final void
setLineEndingStyle
(String style) This will set the line ending style.final void
setRotation
(int rotation) This will set the clockwise rotation in degrees.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
-
LOG
private static final org.apache.commons.logging.Log LOG -
SUBTYPE
COS Model value for SubType entry.- See Also:
-
-
Constructor Details
-
FDFAnnotationFreeText
public FDFAnnotationFreeText()Default constructor. -
FDFAnnotationFreeText
Constructor.- Parameters:
a
- An existing FDF Annotation.
-
FDFAnnotationFreeText
Constructor.- Parameters:
element
- An XFDF element.- Throws:
IOException
- If there is an error extracting information from the element.
-
-
Method Details
-
initFringe
- Throws:
IOException
-
initCallout
-
setCallout
public void setCallout(float[] callout) This will set the coordinates of the callout line.- Parameters:
callout
- An array of four or six numbers specifying a callout line attached to the free text annotation. Six numbers [ x1 y1 x2 y2 x3 y3 ] represent the starting, knee point, and ending coordinates of the line in default user space, Four numbers [ x1 y1 x2 y2 ] represent the starting and ending coordinates of the line.
-
getCallout
public float[] getCallout()This will get the coordinates of the callout line.- Returns:
- An array of four or six numbers specifying a callout line attached to the free text annotation. Six numbers [ x1 y1 x2 y2 x3 y3 ] represent the starting, knee point, and ending coordinates of the line in default user space, Four numbers [ x1 y1 x2 y2 ] represent the starting and ending coordinates of the line.
-
setJustification
This will set the form of quadding (justification) of the annotation text.- Parameters:
justification
- The quadding of the text.
-
getJustification
This will get the form of quadding (justification) of the annotation text.- Returns:
- The quadding of the text.
-
setRotation
public final void setRotation(int rotation) This will set the clockwise rotation in degrees.- Parameters:
rotation
- The number of degrees of clockwise rotation.
-
getRotation
This will get the clockwise rotation in degrees.- Returns:
- The number of degrees of clockwise rotation.
-
setDefaultAppearance
Set the default appearance string.- Parameters:
appearance
- The new default appearance string.
-
getDefaultAppearance
Get the default appearance string.- Returns:
- The default appearance of the annotation.
-
setDefaultStyle
Set the default style string.- Parameters:
style
- The new default style string.
-
getDefaultStyle
Get the default style string.- Returns:
- The default style of the annotation.
-
setFringe
This will set the fringe rectangle. Giving the difference between the annotations rectangle and where the drawing occurs. (To take account of any effects applied through the BE entry for example)- Parameters:
fringe
- the fringe
-
getFringe
This will get the fringe. Giving the difference between the annotations rectangle and where the drawing occurs. (To take account of any effects applied through the BE entry for example)- Returns:
- the rectangle difference
-
setLineEndingStyle
This will set the line ending style.- Parameters:
style
- The new style.
-
getLineEndingStyle
This will retrieve the line ending style.- Returns:
- The ending style for the start point.
-