public class PDAnnotationWidget extends PDAnnotation
Modifier and Type | Field and Description |
---|---|
static String |
SUB_TYPE
The type of annotation.
|
Constructor and 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 and 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.
|
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(String highlightingMode)
Sets the highlighting mode.
|
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getPage, getRectangle, getStructParent, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setBorder, setColor, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView
public static final String SUB_TYPE
public PDAnnotationWidget()
public PDAnnotationWidget(COSDictionary field)
field
- the PDF object to represent as a field.public String getHighlightingMode()
I
N
I
O
P
T
P
(which is preferred).public void setHighlightingMode(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()
Copyright © 2002–2016 The Apache Software Foundation. All rights reserved.