Package com.pspdfkit.annotations.configuration

Enum AnnotationProperty

  • All Implemented Interfaces:
    
public enum AnnotationProperty

    Supported annotation properties. You can use these values to configure the set of editable annotation properties that are presented to your users in various places like the annotation inspector, or the annotation editing toolbar.

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

      Annotation foreground color. Controls foreground color picker in the annotation inspector.
      FILL_COLOR

      Annotation fill color. Controls fill color picker in the annotation inspector.
      THICKNESS

      Annotation thickness - i.e. line width for shape annotations. Controls thickness slider in the annotation inspector.
      TEXT_SIZE

      Free-text annotation's text size. Controls text size slider in the annotation inspector.
      BORDER_STYLE

      Annotation border style. Controls border style picker in the annotation inspector.
      LINE_ENDS

      Annotation line ends. Controls line ends picker in the annotation inspector.
      LINE_ENDS_FILL_COLOR

      Annotation line ends fill color. Controls line ends color picker in the annotation inspector.
      ANNOTATION_NOTE

      Annotation note. Controls whether note editing should be enabled.
      ANNOTATION_ALPHA

      Alpha value of the annotation. Controls alpha slider in the annotation inspector.
      FONT

      Font used for the free-text annotation. Controls font picker in the annotation inspector.
      OUTLINE_COLOR

      Annotation outline color, used for redaction annotations. Controls outline color picker in the annotation inspector.
      REPEAT_OVERLAY_TEXT

      Overlay text repeat property, used for redaction annotations. Controls repeat overlay text switch in the annotation inspector.
      OVERLAY_TEXT

      The text to overlay over redacted parts. Controls overlay text editor in the annotation inspector.
      NOTE_ICON

      Icon for the note annotation. Controls note picker in the note annotation editor.
      MEASUREMENT_PRECISION

      Floating point precision for float values. Used for measurement annotations.
      SCALE

      Page measurement to real-world Scale used for measurement annotations.

    • Method Summary

      Modifier and Type Method Description
      static Array<AnnotationProperty> values() Returns an array containing the constants of this enum type, in the order they're declared.
      static AnnotationProperty 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<AnnotationProperty> 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 AnnotationProperty 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