Class PDAnnotationWidget
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
- All Implemented Interfaces:
COSObjectable
This is the class that represents a widget annotation. This represents the
appearance of a field and manages user interactions. A field may have several
widget annotations, which may be on several pages.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructor.PDAnnotationWidget
(COSDictionary field) Creates a PDWidget from a COSDictionary, expected to be a correct object definition for a field in PDF. -
Method Summary
Modifier and TypeMethodDescriptionGet the action to be performed when this annotation is to be activated.Get the additional actions for this field.Returns the appearance characteristics dictionary.This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.Returns the highlighting mode.void
Set the annotation action.void
setActions
(PDAnnotationAdditionalActions actions) Set the actions of the field.void
setAppearanceCharacteristics
(PDAppearanceCharacteristicsDictionary appearanceCharacteristics) Sets the appearance characteristics dictionary.void
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.void
setParent
(PDTerminalField field) Set the parent field of a widget annotation.Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
constructAppearances, constructAppearances, createAnnotation, equals, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getOptionalContent, getPage, getRectangle, getStructParent, getSubtype, hashCode, 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
-
Field Details
-
SUB_TYPE
The type of annotation.- See Also:
-
-
Constructor Details
-
PDAnnotationWidget
public PDAnnotationWidget()Constructor. -
PDAnnotationWidget
Creates a PDWidget from a COSDictionary, expected to be a correct object definition for a field in PDF.- Parameters:
field
- the PDF object to represent as a field.
-
-
Method Details
-
getHighlightingMode
Returns the highlighting mode. Default value:I
N
- (None) No highlighting.
I
- (Invert) Invert the contents of the annotation rectangle.
O
- (Outline) Invert the annotation's border.
P
- (Push) Display the annotation's down appearance, if any. If no down appearance is defined, the contents of the annotation rectangle shall be offset to appear as if it were pushed below the surface of the page
T
- (Toggle) Same as
P
(which is preferred).
- Returns:
- the highlighting mode
-
setHighlightingMode
Sets the highlighting mode.N
- (None) No highlighting.
I
- (Invert) Invert the contents of the annotation rectangle.
O
- (Outline) Invert the annotation's border.
P
- (Push) Display the annotation's down appearance, if any. If no down appearance is defined, the contents of the annotation rectangle shall be offset to appear as if it were pushed below the surface of the page
T
- (Toggle) Same as
P
(which is preferred).
- Parameters:
highlightingMode
- the highlighting mode the defined values
-
getAppearanceCharacteristics
Returns the appearance characteristics dictionary.- Returns:
- the appearance characteristics dictionary
-
setAppearanceCharacteristics
public void setAppearanceCharacteristics(PDAppearanceCharacteristicsDictionary appearanceCharacteristics) Sets the appearance characteristics dictionary.- Parameters:
appearanceCharacteristics
- the appearance characteristics dictionary
-
getAction
Get the action to be performed when this annotation is to be activated.- Returns:
- The action to be performed when this annotation is activated.
-
setAction
Set the annotation action. As of PDF 1.6 this is only used for Widget Annotations- Parameters:
action
- The annotation action.
-
getActions
Get the additional actions for this field. This will return null if there are no additional actions for this field. As of PDF 1.6 this is only used for Widget Annotations.- Returns:
- The actions of the field.
-
setActions
Set the actions of the field.- Parameters:
actions
- The field actions.
-
setBorderStyle
This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.- Parameters:
bs
- the border style dictionary to set.
-
getBorderStyle
This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.- Returns:
- the border style dictionary.
-
setParent
Set the parent field of a widget annotation. This is only required if this widget annotation is one of multiple children in a field, and not to be set otherwise. You will usually not need this, because in most cases, fields have only one widget and share a common dictionary. A usage can be found in the CreateMultiWidgetsForm example.- Parameters:
field
- the parent field.- Throws:
IllegalArgumentException
- if setParent() was called for a field that shares a dictionary with its only widget.
-