Class PDAnnotationWidget

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
All Implemented Interfaces:
COSObjectable

public class PDAnnotationWidget extends PDAnnotation
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.
Version:
$Revision: 1.3 $
Author:
Ben Litchfield
  • Field Details

  • Constructor Details

    • PDAnnotationWidget

      public PDAnnotationWidget()
      Constructor.
    • PDAnnotationWidget

      public PDAnnotationWidget(COSDictionary field)
      Creates a PDWidget from a COSDictionary, expected to be a correct object definition for a field in PDF.
      Parameters:
      field - the PDF objet to represent as a field.
  • Method Details

    • getHighlightingMode

      public String 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

      public void setHighlightingMode(String highlightingMode)
      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

      public PDAppearanceCharacteristicsDictionary 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

      public PDAction 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

      public void setAction(PDAction action)
      Set the annotation action. As of PDF 1.6 this is only used for Widget Annotations
      Parameters:
      action - The annotation action.
    • getActions

      public PDAnnotationAdditionalActions 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

      public void setActions(PDAnnotationAdditionalActions actions)
      Set the actions of the field.
      Parameters:
      actions - The field actions.
    • setBorderStyle

      public void setBorderStyle(PDBorderStyleDictionary bs)
      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

      public PDBorderStyleDictionary getBorderStyle()
      This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
      Returns:
      the border style dictionary.