org.pdfbox.pdmodel.interactive.annotation

Class PDAnnotationMarkup

Implemented Interfaces:
COSObjectable
Known Direct Subclasses:
PDAnnotationLine, PDAnnotationRubberStamp, PDAnnotationSquareCircle, PDAnnotationText, PDAnnotationTextMarkup

public abstract class PDAnnotationMarkup
extends PDAnnotation

This class represents the additonal fields of a Markup type Annotation.
Version:
$Revision: 1.1 $
Author:
Paul King

Field Summary

static String
RT_GROUP
Constant for an annotation reply type.
static String
RT_REPLY
Constant for an annotation reply type.

Fields inherited from class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation

FLAG_HIDDEN, FLAG_INVISIBLE, FLAG_LOCKED, FLAG_NO_ROTATE, FLAG_NO_VIEW, FLAG_NO_ZOOM, FLAG_PRINTED, FLAG_READ_ONLY, FLAG_TOGGLE_NO_VIEW

Constructor Summary

PDAnnotationMarkup()
Constructor.
PDAnnotationMarkup(COSDictionary dict)
Constructor.

Method Summary

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).

Methods inherited from class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation

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

Field Details

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.

Constructor Details

PDAnnotationMarkup

public PDAnnotationMarkup()
Constructor.

PDAnnotationMarkup

public PDAnnotationMarkup(COSDictionary dict)
Constructor.
Parameters:
dict - The annotations dictionary.

Method Details

getConstantOpacity

public float getConstantOpacity()
This will retrieve the constant opacity value used when rendering the annotation (excluing any popup).
Returns:
the constant opacity value.

getCreationDate

public Calendar getCreationDate()
            throws IOException
This will retrieve the date and time the annotation was created.
Returns:
the creation date/time.

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.
Returns:
the other annotation.

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.
Returns:
the intent

getPopup

public PDAnnotationPopup getPopup()
This will retrieve the popup annotation used for entering/editing the text for this annotation.
Returns:
the popup 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.
Returns:
the relationship.

getRichContents

public PDTextStream getRichContents()
This will retrieve the rich text stream which is displayed in the popup window.
Returns:
the rich text stream.

getSubject

public String getSubject()
This will retrieve the short description of the subject of the annotation.
Returns:
the subject.

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).
Returns:
The title of the popup.

setConstantOpacity

public void setConstantOpacity(float ca)
This will set the constant opacity value used when rendering the annotation (excluing any popup).
Parameters:
ca - the constant opacity value.

setCreationDate

public void setCreationDate(Calendar creationDate)
This will set the the date and time the annotation was created.
Parameters:
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.
Parameters:
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.
Parameters:
it - the intent

setPopup

public void setPopup(PDAnnotationPopup popup)
This will set the popup annotation used for entering/editing the text for this annotation.
Parameters:
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.
Parameters:
rt - the reply type.

setRichContents

public void setRichContents(PDTextStream rc)
This will set the rich text stream which is displayed in the popup window.
Parameters:
rc - the rich text stream.

setSubject

public void setSubject(String subj)
This will set the short description of the subject of the annotation.
Parameters:
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).
Parameters:
t - The title of the popup.