Package org.apache.pdfbox.pdmodel.fdf
Class FDFAnnotation
java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
- All Implemented Interfaces:
COSObjectable
- Direct Known Subclasses:
FDFAnnotationCaret
,FDFAnnotationCircle
,FDFAnnotationFileAttachment
,FDFAnnotationFreeText
,FDFAnnotationInk
,FDFAnnotationLine
,FDFAnnotationLink
,FDFAnnotationPolygon
,FDFAnnotationPolyline
,FDFAnnotationSound
,FDFAnnotationSquare
,FDFAnnotationStamp
,FDFAnnotationText
,FDFAnnotationTextMarkup
This represents an FDF annotation that is part of the FDF document.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected COSDictionary
Annotation dictionary.private static final int
An annotation flag.private static final int
An annotation flag.private static final int
An annotation flag.private static final int
An annotation flag.private static final int
An annotation flag.private static final int
An annotation flag.private static final int
An annotation flag.private static final int
An annotation flag.private static final int
An annotation flag.private static final int
An annotation flag.private static final org.apache.commons.logging.Log
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Constructor.FDFAnnotation
(Element element) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionstatic FDFAnnotation
create
(COSDictionary fdfDic) Create the correct FDFAnnotation.This will retrieve the border style dictionary, describing the effect applied to the border described by the BS entry.This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the annotation.getColor()
Get the annotation color.Get the text, or a description, of the annotation.Convert this standard java object to a COS object.The annotation create date.getDate()
Modification date.Get the intent of the annotation.getName()
Get the annotation name.float
Get the opacity value.getPage()
This will get the page number or null if it does not exist.The rectangle associated with this annotation.This will retrieve the rich text stream which is displayed in the popup window.protected final String
getStringOrStream
(COSBase base) Get a text or text stream.Get the description of the annotation.getTitle()
Get the annotation title.boolean
isHidden()
Get the hidden flag.boolean
Get the invisible flag.boolean
isLocked()
Get the locked flag.boolean
Get the LockedContents flag.boolean
Get the noRotate flag.boolean
isNoView()
Get the noView flag.boolean
isNoZoom()
Get the noZoom flag.boolean
Get the printed flag.boolean
Get the readOnly flag.boolean
Get the toggleNoView flag.private String
richContentsToString
(Node node, boolean root) final void
This will set the border effect dictionary, describing the effect applied to the border described by the BS entry.final void
This will set the border style dictionary, specifying the width and dash pattern used in drawing the annotation.final void
Set the annotation color.final void
setContents
(String contents) Set the contents, or a description, for an annotation.final void
setCreationDate
(Calendar date) Set the creation date.final void
The annotation modification date.final void
setHidden
(boolean hidden) Set the hidden flag.final void
The intent of the annotation.final void
setInvisible
(boolean invisible) Set the invisible flag.final void
setLocked
(boolean locked) Set the locked flag.void
setLockedContents
(boolean lockedContents) Set the LockedContents flag.final void
Set a unique name for an annotation.final void
setNoRotate
(boolean noRotate) Set the noRotate flag.final void
setNoView
(boolean noView) Set the noView flag.final void
setNoZoom
(boolean noZoom) Set the noZoom flag.final void
setOpacity
(float opacity) Set the annotation opacity.final void
setPage
(int page) This will set the page.final void
setPrinted
(boolean printed) Set the printed flag.final void
setReadOnly
(boolean readOnly) Set the readOnly flag.final void
setRectangle
(PDRectangle rectangle) Set the rectangle associated with this annotation.final void
This will set the rich text stream which is displayed in the popup window.final void
setSubject
(String subject) A short description of the annotation.final void
Set a unique title for an annotation.final void
setToggleNoView
(boolean toggleNoView) Set the toggleNoView flag.
-
Field Details
-
LOG
private static final org.apache.commons.logging.Log LOG -
FLAG_INVISIBLE
private static final int FLAG_INVISIBLEAn annotation flag.- See Also:
-
FLAG_HIDDEN
private static final int FLAG_HIDDENAn annotation flag.- See Also:
-
FLAG_PRINTED
private static final int FLAG_PRINTEDAn annotation flag.- See Also:
-
FLAG_NO_ZOOM
private static final int FLAG_NO_ZOOMAn annotation flag.- See Also:
-
FLAG_NO_ROTATE
private static final int FLAG_NO_ROTATEAn annotation flag.- See Also:
-
FLAG_NO_VIEW
private static final int FLAG_NO_VIEWAn annotation flag.- See Also:
-
FLAG_READ_ONLY
private static final int FLAG_READ_ONLYAn annotation flag.- See Also:
-
FLAG_LOCKED
private static final int FLAG_LOCKEDAn annotation flag.- See Also:
-
FLAG_TOGGLE_NO_VIEW
private static final int FLAG_TOGGLE_NO_VIEWAn annotation flag.- See Also:
-
FLAG_LOCKED_CONTENTS
private static final int FLAG_LOCKED_CONTENTSAn annotation flag.- See Also:
-
annot
Annotation dictionary.
-
-
Constructor Details
-
FDFAnnotation
public FDFAnnotation()Default constructor. -
FDFAnnotation
Constructor.- Parameters:
a
- The FDF annotation.
-
FDFAnnotation
Constructor.- Parameters:
element
- An XFDF element.- Throws:
IOException
- If there is an error extracting data from the element.
-
-
Method Details
-
create
Create the correct FDFAnnotation.- Parameters:
fdfDic
- The FDF dictionary.- Returns:
- A newly created FDFAnnotation
- Throws:
IOException
- If there is an error accessing the FDF information.
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getPage
This will get the page number or null if it does not exist.- Returns:
- The page number.
-
setPage
public final void setPage(int page) This will set the page.- Parameters:
page
- The page number.
-
getColor
Get the annotation color.- Returns:
- The annotation color, or null if there is none.
-
setColor
Set the annotation color.- Parameters:
c
- The annotation color.
-
getDate
Modification date.- Returns:
- The date as a string.
-
setDate
The annotation modification date.- Parameters:
date
- The date to store in the FDF annotation.
-
isInvisible
public boolean isInvisible()Get the invisible flag.- Returns:
- The invisible flag.
-
setInvisible
public final void setInvisible(boolean invisible) Set the invisible flag.- Parameters:
invisible
- The new invisible flag.
-
isHidden
public boolean isHidden()Get the hidden flag.- Returns:
- The hidden flag.
-
setHidden
public final void setHidden(boolean hidden) Set the hidden flag.- Parameters:
hidden
- The new hidden flag.
-
isPrinted
public boolean isPrinted()Get the printed flag.- Returns:
- The printed flag.
-
setPrinted
public final void setPrinted(boolean printed) Set the printed flag.- Parameters:
printed
- The new printed flag.
-
isNoZoom
public boolean isNoZoom()Get the noZoom flag.- Returns:
- The noZoom flag.
-
setNoZoom
public final void setNoZoom(boolean noZoom) Set the noZoom flag.- Parameters:
noZoom
- The new noZoom flag.
-
isNoRotate
public boolean isNoRotate()Get the noRotate flag.- Returns:
- The noRotate flag.
-
setNoRotate
public final void setNoRotate(boolean noRotate) Set the noRotate flag.- Parameters:
noRotate
- The new noRotate flag.
-
isNoView
public boolean isNoView()Get the noView flag.- Returns:
- The noView flag.
-
setNoView
public final void setNoView(boolean noView) Set the noView flag.- Parameters:
noView
- The new noView flag.
-
isReadOnly
public boolean isReadOnly()Get the readOnly flag.- Returns:
- The readOnly flag.
-
setReadOnly
public final void setReadOnly(boolean readOnly) Set the readOnly flag.- Parameters:
readOnly
- The new readOnly flag.
-
isLocked
public boolean isLocked()Get the locked flag.- Returns:
- The locked flag.
-
setLocked
public final void setLocked(boolean locked) Set the locked flag.- Parameters:
locked
- The new locked flag.
-
isToggleNoView
public boolean isToggleNoView()Get the toggleNoView flag.- Returns:
- The toggleNoView flag.
-
setToggleNoView
public final void setToggleNoView(boolean toggleNoView) Set the toggleNoView flag.- Parameters:
toggleNoView
- The new toggleNoView flag.
-
isLockedContents
public boolean isLockedContents()Get the LockedContents flag.- Returns:
- The LockedContents flag.
-
setLockedContents
public void setLockedContents(boolean lockedContents) Set the LockedContents flag.- Parameters:
lockedContents
- The new LockedContents flag.
-
setName
Set a unique name for an annotation.- Parameters:
name
- The unique annotation name.
-
getName
Get the annotation name.- Returns:
- The unique name of the annotation.
-
setRectangle
Set the rectangle associated with this annotation.- Parameters:
rectangle
- The annotation rectangle.
-
getRectangle
The rectangle associated with this annotation.- Returns:
- The annotation rectangle.
-
setContents
Set the contents, or a description, for an annotation.- Parameters:
contents
- The annotation contents, or a description.
-
getContents
Get the text, or a description, of the annotation.- Returns:
- The text, or a description, of the annotation.
-
setTitle
Set a unique title for an annotation.- Parameters:
title
- The annotation title.
-
getTitle
Get the annotation title.- Returns:
- The title of the annotation.
-
getCreationDate
The annotation create date.- Returns:
- The date of the creation of the annotation date
- Throws:
IOException
- If there is an error converting the string to a Calendar object.
-
setCreationDate
Set the creation date.- Parameters:
date
- The date the annotation was created.
-
setOpacity
public final void setOpacity(float opacity) Set the annotation opacity.- Parameters:
opacity
- The new opacity value.
-
getOpacity
public float getOpacity()Get the opacity value.- Returns:
- The opacity of the annotation.
-
setSubject
A short description of the annotation.- Parameters:
subject
- The annotation subject.
-
getSubject
Get the description of the annotation.- Returns:
- The subject of the annotation.
-
setIntent
The intent of the annotation.- Parameters:
intent
- The annotation's intent.
-
getIntent
Get the intent of the annotation.- Returns:
- The intent of the annotation.
-
getRichContents
This will retrieve the rich text stream which is displayed in the popup window.- Returns:
- the rich text stream.
-
setRichContents
This will set the rich text stream which is displayed in the popup window.- Parameters:
rc
- the rich text stream.
-
setBorderStyle
This will set the border style dictionary, specifying the width and dash pattern used in drawing the annotation.- Parameters:
bs
- the border style dictionary to set.
-
getBorderStyle
This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the annotation.- Returns:
- the border style dictionary.
-
setBorderEffect
This will set the border effect dictionary, describing the effect applied to the border described by the BS entry.- Parameters:
be
- the border effect dictionary to set.
-
getBorderEffect
This will retrieve the border style dictionary, describing the effect applied to the border described by the BS entry.- Returns:
- the border effect dictionary.
-
getStringOrStream
Get a text or text stream. Some dictionary entries allow either a text or a text stream.- Parameters:
base
- the potential text or text stream- Returns:
- the text stream
-
richContentsToString
-