org.pdfbox.pdmodel.interactive.annotation
Class PDAnnotationMarkup
- COSObjectable
public abstract class PDAnnotationMarkup
This class represents the additonal fields of a Markup type Annotation.
static String | RT_GROUP - Constant for an annotation reply type.
|
static String | RT_REPLY - Constant for an annotation reply type.
|
float | getConstantOpacity() - This will retrieve the constant opacity value used when rendering the
annotation (excluing any popup).
|
Calendar | getCreationDate() - This will retrieve the date and time the annotation was created.
|
PDAnnotation | getInReplyTo() - This will retrieve the annotation to which this one is "In Reply To" the
actual relationship is specified by the RT entry.
|
String | getIntent() - This will retrieve the intent of the annotation The values and meanings
are specific to the actual annotation See the IT_* constants for the
annotation classes.
|
PDAnnotationPopup | getPopup() - This will retrieve the popup annotation used for entering/editing the
text for this annotation.
|
String | getReplyType() - This will retrieve the Reply Type (relationship) with the annotation in
the IRT entry See the RT_* constants for the available values.
|
PDTextStream | getRichContents() - This will retrieve the rich text stream which is displayed in the popup
window.
|
String | getSubject() - This will retrieve the short description of the subject of the annotation.
|
String | getTitlePopup() - Retrieve the string used as the title of the popup window shown when open
and active (by convention this identifies who added the annotation).
|
void | setConstantOpacity(float ca) - This will set the constant opacity value used when rendering the
annotation (excluing any popup).
|
void | setCreationDate(Calendar creationDate) - This will set the the date and time the annotation was created.
|
void | setInReplyTo(PDAnnotation irt) - This will set the annotation to which this one is "In Reply To" the
actual relationship is specified by the RT entry.
|
void | setIntent(String it) - This will set the intent of the annotation The values and meanings are
specific to the actual annotation See the IT_* constants for the
annotation classes.
|
void | setPopup(PDAnnotationPopup popup) - This will set the popup annotation used for entering/editing the text for
this annotation.
|
void | setReplyType(String rt) - This will set the Reply Type (relationship) with the annotation in the
IRT entry See the RT_* constants for the available values.
|
void | setRichContents(PDTextStream rc) - This will set the rich text stream which is displayed in the popup window.
|
void | setSubject(String subj) - This will set the short description of the subject of the annotation.
|
void | setTitlePopup(String t) - Set the string used as the title of the popup window shown when open and
active (by convention this identifies who added the annotation).
|
createAnnotation , getAction , getActions , getAnnotationFlags , getAnnotationName , getAppearance , getAppearanceStream , getBoderStyle , getCOSObject , getColour , getContents , getDictionary , getModifiedDate , getRectangle , isHidden , isInvisible , isLocked , isNoRotate , isNoView , isNoZoom , isPrinted , isReadOnly , isToggleNoView , setAction , setActions , setAnnotationFlags , setAnnotationName , setAppearance , setAppearanceStream , setBorderStyle , setColour , setContents , setHidden , setInvisible , setLocked , setModifiedDate , setNoRotate , setNoView , setNoZoom , setPrinted , setReadOnly , setRectangle , setToggleNoView |
RT_GROUP
public static final String RT_GROUP
Constant for an annotation reply type.
RT_REPLY
public static final String RT_REPLY
Constant for an annotation reply type.
PDAnnotationMarkup
public PDAnnotationMarkup()
Constructor.
PDAnnotationMarkup
public PDAnnotationMarkup(COSDictionary dict)
Constructor.
dict
- The annotations dictionary.
getConstantOpacity
public float getConstantOpacity()
This will retrieve the constant opacity value used when rendering the
annotation (excluing any popup).
- the constant opacity value.
getCreationDate
public Calendar getCreationDate()
throws IOException
This will retrieve the date and time the annotation was created.
getInReplyTo
public PDAnnotation getInReplyTo()
throws IOException
This will retrieve the annotation to which this one is "In Reply To" the
actual relationship is specified by the RT entry.
getIntent
public String getIntent()
This will retrieve the intent of the annotation The values and meanings
are specific to the actual annotation See the IT_* constants for the
annotation classes.
getPopup
public PDAnnotationPopup getPopup()
This will retrieve the popup annotation used for entering/editing the
text for this annotation.
getReplyType
public String getReplyType()
This will retrieve the Reply Type (relationship) with the annotation in
the IRT entry See the RT_* constants for the available values.
getRichContents
public PDTextStream getRichContents()
This will retrieve the rich text stream which is displayed in the popup
window.
getSubject
public String getSubject()
This will retrieve the short description of the subject of the annotation.
getTitlePopup
public String getTitlePopup()
Retrieve the string used as the title of the popup window shown when open
and active (by convention this identifies who added the annotation).
setConstantOpacity
public void setConstantOpacity(float ca)
This will set the constant opacity value used when rendering the
annotation (excluing any popup).
ca
- the constant opacity value.
setCreationDate
public void setCreationDate(Calendar creationDate)
This will set the the date and time the annotation was created.
creationDate
- the date and time the annotation was created.
setInReplyTo
public void setInReplyTo(PDAnnotation irt)
This will set the annotation to which this one is "In Reply To" the
actual relationship is specified by the RT entry.
irt
- the annotation this one is "In Reply To".
setIntent
public void setIntent(String it)
This will set the intent of the annotation The values and meanings are
specific to the actual annotation See the IT_* constants for the
annotation classes.
setPopup
public void setPopup(PDAnnotationPopup popup)
This will set the popup annotation used for entering/editing the text for
this annotation.
popup
- the popup annotation.
setReplyType
public void setReplyType(String rt)
This will set the Reply Type (relationship) with the annotation in the
IRT entry See the RT_* constants for the available values.
setRichContents
public void setRichContents(PDTextStream rc)
This will set the rich text stream which is displayed in the popup window.
rc
- the rich text stream.
setSubject
public void setSubject(String subj)
This will set the short description of the subject of the annotation.
subj
- short description of the subject.
setTitlePopup
public void setTitlePopup(String t)
Set the string used as the title of the popup window shown when open and
active (by convention this identifies who added the annotation).
t
- The title of the popup.