COSObjectable
FDFAnnotationCaret
, FDFAnnotationCircle
, FDFAnnotationFileAttachment
, FDFAnnotationFreeText
, FDFAnnotationInk
, FDFAnnotationLine
, FDFAnnotationLink
, FDFAnnotationPolygon
, FDFAnnotationPolyline
, FDFAnnotationSound
, FDFAnnotationSquare
, FDFAnnotationStamp
, FDFAnnotationText
, FDFAnnotationTextMarkup
public abstract class FDFAnnotation extends java.lang.Object implements COSObjectable
Modifier and Type | Field | Description |
---|---|---|
protected COSDictionary |
annot |
Annotation dictionary.
|
Constructor | Description |
---|---|
FDFAnnotation() |
Default constructor.
|
FDFAnnotation(COSDictionary a) |
Constructor.
|
FDFAnnotation(org.w3c.dom.Element element) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
static FDFAnnotation |
create(COSDictionary fdfDic) |
Create the correct FDFAnnotation.
|
PDBorderEffectDictionary |
getBorderEffect() |
This will retrieve the border style dictionary, describing the effect applied to the border described by the BS
entry.
|
PDBorderStyleDictionary |
getBorderStyle() |
This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the
annotation.
|
java.awt.Color |
getColor() |
Get the annotation color.
|
java.lang.String |
getContents() |
Get the text, or a description, of the annotation.
|
COSDictionary |
getCOSObject() |
Convert this standard java object to a COS object.
|
java.util.Calendar |
getCreationDate() |
The annotation create date.
|
java.lang.String |
getDate() |
Modification date.
|
java.lang.String |
getIntent() |
Get the intent of the annotation.
|
java.lang.String |
getName() |
Get the annotation name.
|
float |
getOpacity() |
Get the opacity value.
|
java.lang.Integer |
getPage() |
This will get the page number or null if it does not exist.
|
PDRectangle |
getRectangle() |
The rectangle associated with this annotation.
|
java.lang.String |
getRichContents() |
This will retrieve the rich text stream which is displayed in the popup window.
|
protected java.lang.String |
getStringOrStream(COSBase base) |
Get a text or text stream.
|
java.lang.String |
getSubject() |
Get the description of the annotation.
|
java.lang.String |
getTitle() |
Get the annotation title.
|
boolean |
isHidden() |
Get the hidden flag.
|
boolean |
isInvisible() |
Get the invisible flag.
|
boolean |
isLocked() |
Get the locked flag.
|
boolean |
isNoRotate() |
Get the noRotate flag.
|
boolean |
isNoView() |
Get the noView flag.
|
boolean |
isNoZoom() |
Get the noZoom flag.
|
boolean |
isPrinted() |
Get the printed flag.
|
boolean |
isReadOnly() |
Get the readOnly flag.
|
boolean |
isToggleNoView() |
Get the toggleNoView flag.
|
void |
setBorderEffect(PDBorderEffectDictionary be) |
This will set the border effect dictionary, describing the effect applied to the border described by the BS
entry.
|
void |
setBorderStyle(PDBorderStyleDictionary bs) |
This will set the border style dictionary, specifying the width and dash pattern used in drawing the annotation.
|
void |
setColor(java.awt.Color c) |
Set the annotation color.
|
void |
setContents(java.lang.String contents) |
Set the contents, or a description, for an annotation.
|
void |
setCreationDate(java.util.Calendar date) |
Set the creation date.
|
void |
setDate(java.lang.String date) |
The annotation modification date.
|
void |
setHidden(boolean hidden) |
Set the hidden flag.
|
void |
setIntent(java.lang.String intent) |
The intent of the annotation.
|
void |
setInvisible(boolean invisible) |
Set the invisible flag.
|
void |
setLocked(boolean locked) |
Set the locked flag.
|
void |
setName(java.lang.String name) |
Set a unique name for an annotation.
|
void |
setNoRotate(boolean noRotate) |
Set the noRotate flag.
|
void |
setNoView(boolean noView) |
Set the noView flag.
|
void |
setNoZoom(boolean noZoom) |
Set the noZoom flag.
|
void |
setOpacity(float opacity) |
Set the annotation opacity.
|
void |
setPage(int page) |
This will set the page.
|
void |
setPrinted(boolean printed) |
Set the printed flag.
|
void |
setReadOnly(boolean readOnly) |
Set the readOnly flag.
|
void |
setRectangle(PDRectangle rectangle) |
Set the rectangle associated with this annotation.
|
void |
setRichContents(java.lang.String rc) |
This will set the rich text stream which is displayed in the popup window.
|
void |
setSubject(java.lang.String subject) |
A short description of the annotation.
|
void |
setTitle(java.lang.String title) |
Set a unique title for an annotation.
|
void |
setToggleNoView(boolean toggleNoView) |
Set the toggleNoView flag.
|
protected COSDictionary annot
public FDFAnnotation()
public FDFAnnotation(COSDictionary a)
a
- The FDF annotation.public FDFAnnotation(org.w3c.dom.Element element) throws java.io.IOException
element
- An XFDF element.java.io.IOException
- If there is an error extracting data from the element.public static FDFAnnotation create(COSDictionary fdfDic) throws java.io.IOException
fdfDic
- The FDF dictionary.java.io.IOException
- If there is an error accessing the FDF information.public COSDictionary getCOSObject()
getCOSObject
in interface COSObjectable
public java.lang.Integer getPage()
public final void setPage(int page)
page
- The page number.public java.awt.Color getColor()
public final void setColor(java.awt.Color c)
c
- The annotation color.public java.lang.String getDate()
public final void setDate(java.lang.String date)
date
- The date to store in the FDF annotation.public boolean isInvisible()
public final void setInvisible(boolean invisible)
invisible
- The new invisible flag.public boolean isHidden()
public final void setHidden(boolean hidden)
hidden
- The new hidden flag.public boolean isPrinted()
public final void setPrinted(boolean printed)
printed
- The new printed flag.public boolean isNoZoom()
public final void setNoZoom(boolean noZoom)
noZoom
- The new noZoom flag.public boolean isNoRotate()
public final void setNoRotate(boolean noRotate)
noRotate
- The new noRotate flag.public boolean isNoView()
public final void setNoView(boolean noView)
noView
- The new noView flag.public boolean isReadOnly()
public final void setReadOnly(boolean readOnly)
readOnly
- The new readOnly flag.public boolean isLocked()
public final void setLocked(boolean locked)
locked
- The new locked flag.public boolean isToggleNoView()
public final void setToggleNoView(boolean toggleNoView)
toggleNoView
- The new toggleNoView flag.public final void setName(java.lang.String name)
name
- The unique annotation name.public java.lang.String getName()
public final void setRectangle(PDRectangle rectangle)
rectangle
- The annotation rectangle.public PDRectangle getRectangle()
public final void setContents(java.lang.String contents)
contents
- The annotation contents, or a description.public java.lang.String getContents()
public final void setTitle(java.lang.String title)
title
- The annotation title.public java.lang.String getTitle()
public java.util.Calendar getCreationDate() throws java.io.IOException
java.io.IOException
- If there is an error converting the string to a Calendar object.public final void setCreationDate(java.util.Calendar date)
date
- The date the annotation was created.public final void setOpacity(float opacity)
opacity
- The new opacity value.public float getOpacity()
public final void setSubject(java.lang.String subject)
subject
- The annotation subject.public java.lang.String getSubject()
public final void setIntent(java.lang.String intent)
intent
- The annotation's intent.public java.lang.String getIntent()
public java.lang.String getRichContents()
public final void setRichContents(java.lang.String rc)
rc
- the rich text stream.public final void setBorderStyle(PDBorderStyleDictionary bs)
bs
- the border style dictionary to set.public PDBorderStyleDictionary getBorderStyle()
public final void setBorderEffect(PDBorderEffectDictionary be)
be
- the border effect dictionary to set.public PDBorderEffectDictionary getBorderEffect()
protected final java.lang.String getStringOrStream(COSBase base)
base
- the potential text or text streamCopyright © 2002–2018. All rights reserved.