Package com.pspdfkit.annotations

Enum AnnotationFlags

  • All Implemented Interfaces:
    
public enum AnnotationFlags

    Specifies various characteristics of the annotation.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      INVISIBLE

      If set, ignore annotation AP stream if there is no handler available.
      HIDDEN

      If set, do not display or print the annotation or allow it to interact with the user.
      PRINT

      If set, print the annotation when the page is printed. Default value.
      NOZOOM

      If set, don't scale the annotation’s appearance to match the magnification of the page.

      Note: Supported only for FILE and STAMP annotations.

      Note:NOTE are treated as if they had this flag enabled by default. If you wish to disable this behavior, use setEnableNoteAnnotationNoZoomHandling.
      NOROTATE

      [Not supported] If set, don't rotate the annotation’s appearance to match the rotation of the page.
      NOVIEW

      If set, don't display the annotation on the screen. (But printing might be allowed)
      READONLY

      If set, don't allow the annotation to interact with the user. Ignored for Widget.
      LOCKED

      If set, don't allow the annotation to be deleted or properties modified (except contents)
      TOGGLENOVIEW

      [Not supported] If set, invert the interpretation of the NoView flag for certain events.
      LOCKEDCONTENTS

      If set, don't allow the contents of the annotation to be modified by the user.

    • Method Summary

      Modifier and Type Method Description
      static Array<AnnotationFlags> values() Returns an array containing the constants of this enum type, in the order they're declared.
      static AnnotationFlags valueOf(String name) Returns the enum constant of this type with the specified name.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • values

         static Array<AnnotationFlags> values()

        Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

        Returns:

        an array containing the constants of this enum type, in the order they're declared

      • valueOf

         static AnnotationFlags 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.)

        Returns:

        the enum constant with the specified name