COSObjectable
PDAnnotationFileAttachment
, PDAnnotationLine
, PDAnnotationRubberStamp
, PDAnnotationSquareCircle
, PDAnnotationText
, PDAnnotationTextMarkup
public class PDAnnotationMarkup extends PDAnnotation
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
RT_GROUP |
Constant for an annotation reply type.
|
static java.lang.String |
RT_REPLY |
Constant for an annotation reply type.
|
static java.lang.String |
SUB_TYPE_CARET |
Constant for an Caret type of annotation.
|
static java.lang.String |
SUB_TYPE_FREETEXT |
Constant for a FreeText type of annotation.
|
static java.lang.String |
SUB_TYPE_INK |
Constant for an Ink type of annotation.
|
static java.lang.String |
SUB_TYPE_POLYGON |
Constant for an Polygon type of annotation.
|
static java.lang.String |
SUB_TYPE_POLYLINE |
Constant for an PolyLine type of annotation.
|
static java.lang.String |
SUB_TYPE_SOUND |
Constant for an Sound type of annotation.
|
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 | Description |
---|---|
PDAnnotationMarkup() |
Constructor.
|
PDAnnotationMarkup(COSDictionary dict) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
float |
getConstantOpacity() |
This will retrieve the constant opacity value used when rendering the
annotation (excluing any popup).
|
java.util.Calendar |
getCreationDate() |
This will retrieve the date and time the annotation was created.
|
PDExternalDataDictionary |
getExternalData() |
This will return the external data dictionary.
|
PDAnnotation |
getInReplyTo() |
This will retrieve the annotation to which this one is "In Reply To" the
actual relationship is specified by the RT entry.
|
java.lang.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.
|
java.lang.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.
|
java.lang.String |
getSubject() |
This will retrieve the short description of the subject of the annotation.
|
java.lang.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(java.util.Calendar creationDate) |
This will set the the date and time the annotation was created.
|
void |
setExternalData(PDExternalDataDictionary externalData) |
This will set the external data dictionary.
|
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(java.lang.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(java.lang.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(java.lang.String subj) |
This will set the short description of the subject of the annotation.
|
void |
setTitlePopup(java.lang.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).
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceStream, getColour, getContents, getCOSObject, getDictionary, getModifiedDate, getPage, getRectangle, getStructParent, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceStream, setColour, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView
public static final java.lang.String SUB_TYPE_FREETEXT
public static final java.lang.String SUB_TYPE_POLYGON
public static final java.lang.String SUB_TYPE_POLYLINE
public static final java.lang.String SUB_TYPE_CARET
public static final java.lang.String SUB_TYPE_INK
public static final java.lang.String SUB_TYPE_SOUND
public static final java.lang.String RT_REPLY
public static final java.lang.String RT_GROUP
public PDAnnotationMarkup()
public PDAnnotationMarkup(COSDictionary dict)
dict
- The annotations dictionary.public java.lang.String getTitlePopup()
public void setTitlePopup(java.lang.String t)
t
- The title of the popup.public PDAnnotationPopup getPopup()
public void setPopup(PDAnnotationPopup popup)
popup
- the popup annotation.public float getConstantOpacity()
public void setConstantOpacity(float ca)
ca
- the constant opacity value.public PDTextStream getRichContents()
public void setRichContents(PDTextStream rc)
rc
- the rich text stream.public java.util.Calendar getCreationDate() throws java.io.IOException
java.io.IOException
- if there is a format problem when converting the date.public void setCreationDate(java.util.Calendar creationDate)
creationDate
- the date and time the annotation was created.public PDAnnotation getInReplyTo() throws java.io.IOException
java.io.IOException
- if there is an error with the annotation.public void setInReplyTo(PDAnnotation irt)
irt
- the annotation this one is "In Reply To".public java.lang.String getSubject()
public void setSubject(java.lang.String subj)
subj
- short description of the subject.public java.lang.String getReplyType()
public void setReplyType(java.lang.String rt)
rt
- the reply type.public java.lang.String getIntent()
public void setIntent(java.lang.String it)
it
- the intentpublic PDExternalDataDictionary getExternalData()
public void setExternalData(PDExternalDataDictionary externalData)
externalData
- the external data dictionary