public class PDAnnotationText extends PDAnnotationMarkup
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME_COMMENT
Constant for the name of a text annotation.
|
static java.lang.String |
NAME_HELP
Constant for the name of a text annotation.
|
static java.lang.String |
NAME_INSERT
Constant for the name of a text annotation.
|
static java.lang.String |
NAME_KEY
Constant for the name of a text annotation.
|
static java.lang.String |
NAME_NEW_PARAGRAPH
Constant for the name of a text annotation.
|
static java.lang.String |
NAME_NOTE
Constant for the name of a text annotation.
|
static java.lang.String |
NAME_PARAGRAPH
Constant for the name of a text annotation.
|
static java.lang.String |
SUB_TYPE
The type of annotation.
|
RT_GROUP, RT_REPLY, SUB_TYPE_CARET, SUB_TYPE_FREETEXT, SUB_TYPE_INK, SUB_TYPE_POLYGON, SUB_TYPE_POLYLINE, SUB_TYPE_SOUND
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 and Description |
---|
PDAnnotationText()
Constructor.
|
PDAnnotationText(COSDictionary field)
Creates a Text annotation from a COSDictionary, expected to be a correct
object definition.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getName()
This will retrieve the name (and hence appearance, AP taking precedence)
For this annotation.
|
boolean |
getOpen()
This will retrieve the initial state of the annotation, open Or closed
(default closed).
|
java.lang.String |
getState()
This will retrieve the annotation state.
|
java.lang.String |
getStateModel()
This will retrieve the annotation state model.
|
void |
setName(java.lang.String name)
This will set the name (and hence appearance, AP taking precedence) For
this annotation.
|
void |
setOpen(boolean open)
This will set initial state of the annotation, open or closed.
|
void |
setState(java.lang.String state)
This will set the annotation state.
|
void |
setStateModel(java.lang.String stateModel)
This will set the annotation state model.
|
getConstantOpacity, getCreationDate, getExternalData, getInReplyTo, getIntent, getPopup, getReplyType, getRichContents, getSubject, getTitlePopup, setConstantOpacity, setCreationDate, setExternalData, setInReplyTo, setIntent, setPopup, setReplyType, setRichContents, setSubject, setTitlePopup
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 NAME_COMMENT
public static final java.lang.String NAME_KEY
public static final java.lang.String NAME_NOTE
public static final java.lang.String NAME_HELP
public static final java.lang.String NAME_NEW_PARAGRAPH
public static final java.lang.String NAME_PARAGRAPH
public static final java.lang.String NAME_INSERT
public static final java.lang.String SUB_TYPE
public PDAnnotationText()
public PDAnnotationText(COSDictionary field)
field
- the PDF object to represent as a field.public void setOpen(boolean open)
open
- Boolean value, true = open false = closedpublic boolean getOpen()
public void setName(java.lang.String name)
name
- The name of the annotationpublic java.lang.String getName()
public java.lang.String getState()
public void setState(java.lang.String state)
state
- the annotation statepublic java.lang.String getStateModel()
public void setStateModel(java.lang.String stateModel)
stateModel
- the annotation state model