Package com.pdftools.pdf2image

Enum AnnotationOptions

java.lang.Object
java.lang.Enum<AnnotationOptions>
com.pdftools.pdf2image.AnnotationOptions
All Implemented Interfaces:
Serializable, Comparable<AnnotationOptions>
public enum AnnotationOptions extends Enum<AnnotationOptions>

Defines how to render annotations and their popups

Annotations associate an object such as a sticky note, link or rich media with a location on a PDF page; they may also provide user interaction by means of the mouse and keyboard.

Some annotations have an associated popup.

  • Enum Constant Details

    • SHOW_ANNOTATIONS

      public static final AnnotationOptions SHOW_ANNOTATIONS

      Render the annotation without the associated popup

    • SHOW_ANNOTATIONS_AND_POPUPS

      public static final AnnotationOptions SHOW_ANNOTATIONS_AND_POPUPS

      Render the annotation and the associated popup

  • Method Details

    • values

      public static AnnotationOptions[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static AnnotationOptions valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null