public class PDAnnotationText extends PDAnnotationMarkup
Modifier and Type | Field and Description |
---|---|
private PDAppearanceHandler |
customAppearanceHandler |
static java.lang.String |
NAME_CHECK
Constant for the name of a check annotation.
|
static java.lang.String |
NAME_CIRCLE
Constant for the name of a circle annotation.
|
static java.lang.String |
NAME_COMMENT
Constant for the name of a text annotation.
|
static java.lang.String |
NAME_CROSS
Constant for the name of a cross annotation.
|
static java.lang.String |
NAME_CROSS_HAIRS
Constant for the name of a crosshairs 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 |
NAME_RIGHT_ARROW
Constant for the name of a right arrow annotation.
|
static java.lang.String |
NAME_RIGHT_POINTER
Constant for the name of a right pointer annotation.
|
static java.lang.String |
NAME_STAR
Constant for the name of a star annotation.
|
static java.lang.String |
NAME_UP_ARROW
Constant for the name of a crosshairs annotation.
|
static java.lang.String |
NAME_UP_LEFT_ARROW
Constant for the name of a crosshairs annotation.
|
static java.lang.String |
SUB_TYPE
The type of annotation.
|
IT_FREE_TEXT, IT_FREE_TEXT_CALLOUT, IT_FREE_TEXT_TYPE_WRITER, RT_GROUP, RT_REPLY, SUB_TYPE_CARET, SUB_TYPE_FREETEXT, SUB_TYPE_INK, SUB_TYPE_POLYGON, SUB_TYPE_POLYLINE, SUB_TYPE_SOUND
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 |
---|---|
void |
constructAppearances()
Create the appearance entry for this annotation.
|
void |
constructAppearances(PDDocument document)
Create the appearance entry for this annotation.
|
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 |
setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)
Set a custom appearance handler for generating the annotations appearance streams.
|
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.
|
getBorderEffect, getBorderStyle, getCallout, getConstantOpacity, getCreationDate, getDefaultAppearance, getDefaultStyleString, getEndPointEndingStyle, getExternalData, getInkList, getInReplyTo, getIntent, getInteriorColor, getLineEndingStyle, getPath, getPopup, getQ, getRectDifference, getRectDifferences, getReplyType, getRichContents, getStartPointEndingStyle, getSubject, getTitlePopup, getVertices, setBorderEffect, setBorderStyle, setCallout, setConstantOpacity, setCreationDate, setDefaultAppearance, setDefaultStyleString, setEndPointEndingStyle, setExternalData, setInkList, setInReplyTo, setIntent, setInteriorColor, setLineEndingStyle, setPopup, setQ, setRectDifference, setRectDifferences, setRectDifferences, setReplyType, setRichContents, setStartPointEndingStyle, setSubject, setTitlePopup, setVertices
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getOptionalContent, getPage, getRectangle, getStructParent, getSubtype, isHidden, isInvisible, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setBorder, setColor, setContents, setHidden, setInvisible, setLocked, setLockedContents, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setOptionalContent, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView
private PDAppearanceHandler customAppearanceHandler
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 NAME_CIRCLE
public static final java.lang.String NAME_CROSS
public static final java.lang.String NAME_STAR
public static final java.lang.String NAME_CHECK
public static final java.lang.String NAME_RIGHT_ARROW
public static final java.lang.String NAME_RIGHT_POINTER
public static final java.lang.String NAME_UP_ARROW
public static final java.lang.String NAME_UP_LEFT_ARROW
public static final java.lang.String NAME_CROSS_HAIRS
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 modelpublic void setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)
setCustomAppearanceHandler
in class PDAnnotationMarkup
appearanceHandler
- public void constructAppearances()
PDAnnotation
constructAppearances
in class PDAnnotationMarkup
public void constructAppearances(PDDocument document)
PDAnnotation
constructAppearances
in class PDAnnotationMarkup