COSObjectable
public class PDAnnotationWidget extends PDAnnotation
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
SUB_TYPE |
The 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 |
---|---|
PDAnnotationWidget() |
Constructor.
|
PDAnnotationWidget(COSDictionary field) |
Creates a PDWidget from a COSDictionary, expected to be
a correct object definition for a field in PDF.
|
Modifier and Type | Method | Description |
---|---|---|
PDAction |
getAction() |
Get the action to be performed when this annotation is to be activated.
|
PDAnnotationAdditionalActions |
getActions() |
Get the additional actions for this field.
|
PDAppearanceCharacteristicsDictionary |
getAppearanceCharacteristics() |
Returns the appearance characteristics dictionary.
|
PDBorderStyleDictionary |
getBorderStyle() |
This will retrieve the border style dictionary, specifying the width and
dash pattern used in drawing the line.
|
java.lang.String |
getHighlightingMode() |
Returns the highlighting mode.
|
void |
setAction(PDAction action) |
Set the annotation action.
|
void |
setActions(PDAnnotationAdditionalActions actions) |
Set the actions of the field.
|
void |
setAppearanceCharacteristics(PDAppearanceCharacteristicsDictionary appearanceCharacteristics) |
Sets the appearance characteristics dictionary.
|
void |
setBorderStyle(PDBorderStyleDictionary bs) |
This will set the border style dictionary, specifying the width and dash
pattern used in drawing the line.
|
void |
setHighlightingMode(java.lang.String highlightingMode) |
Sets the highlighting mode.
|
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
public PDAnnotationWidget()
public PDAnnotationWidget(COSDictionary field)
field
- the PDF objet to represent as a field.public java.lang.String getHighlightingMode()
I
N
I
O
P
T
P
(which is preferred).public void setHighlightingMode(java.lang.String highlightingMode)
N
I
O
P
T
P
(which is preferred).highlightingMode
- the highlighting mode
the defined valuespublic PDAppearanceCharacteristicsDictionary getAppearanceCharacteristics()
public void setAppearanceCharacteristics(PDAppearanceCharacteristicsDictionary appearanceCharacteristics)
appearanceCharacteristics
- the appearance characteristics dictionarypublic PDAction getAction()
public void setAction(PDAction action)
action
- The annotation action.public PDAnnotationAdditionalActions getActions()
public void setActions(PDAnnotationAdditionalActions actions)
actions
- The field actions.public void setBorderStyle(PDBorderStyleDictionary bs)
bs
- the border style dictionary to set.public PDBorderStyleDictionary getBorderStyle()