Enum AnnotationOptions

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AnnotationOptions>

    public enum AnnotationOptions
    extends java.lang.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.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static AnnotationOptions valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AnnotationOptions[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • 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 Detail

      • values

        public static AnnotationOptions[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (AnnotationOptions c : AnnotationOptions.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static AnnotationOptions valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null