Class FDFAnnotationText

java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
org.apache.pdfbox.pdmodel.fdf.FDFAnnotationText
All Implemented Interfaces:
COSObjectable

public class FDFAnnotationText extends FDFAnnotation
This represents a Text FDF annotation.
Author:
Ben Litchfield, Johanneke Lamberink
  • Field Details

  • Constructor Details

    • FDFAnnotationText

      public FDFAnnotationText()
      Default constructor.
    • FDFAnnotationText

      public FDFAnnotationText(COSDictionary a)
      Constructor.
      Parameters:
      a - An existing FDF Annotation.
    • FDFAnnotationText

      public FDFAnnotationText(Element element) throws IOException
      Constructor.
      Parameters:
      element - An XFDF element.
      Throws:
      IOException - If there is an error extracting information from the element.
  • Method Details

    • setIcon

      public void setIcon(String icon)
      This will set the icon (and hence appearance, AP taking precedence) For this annotation. See the PDAnnotationText.NAME_XXX constants for valid values.
      Parameters:
      icon - The name of the annotation
    • getIcon

      public String getIcon()
      This will retrieve the icon (and hence appearance, AP taking precedence) For this annotation. The default is NOTE.
      Returns:
      The name of this annotation, see the PDAnnotationText.NAME_XXX constants.
    • getState

      public String getState()
      This will retrieve the annotation state.
      Returns:
      the annotation state
    • setState

      public void setState(String state)
      This will set the annotation state.
      Parameters:
      state - the annotation state
    • getStateModel

      public String getStateModel()
      This will retrieve the annotation state model.
      Returns:
      the annotation state model
    • setStateModel

      public void setStateModel(String stateModel)
      This will set the annotation state model. Allowed values are "Marked" and "Review"
      Parameters:
      stateModel - the annotation state model