|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
public class PDAnnotationWidget
This is the class that represents a widget.
Field Summary | |
---|---|
static String |
SUB_TYPE
The type of annotation. |
Fields inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation |
---|
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 Summary | |
---|---|
PDAnnotationWidget()
Constructor. |
|
PDAnnotationWidget(COSDictionary field)
Creates a PDWidget from a COSDictionary, expected to be a correct object definition for a field in PDF. |
Method Summary | |
---|---|
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. |
Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation |
---|
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceStream, getColour, getContents, getCOSObject, getDictionary, getModifiedDate, getPage, getRectangle, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceStream, setColour, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setToggleNoView |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String SUB_TYPE
Constructor Detail |
---|
public PDAnnotationWidget()
public PDAnnotationWidget(COSDictionary field)
field
- the PDF objet to represent as a field.Method Detail |
---|
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()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |