Package com.pspdfkit.ui.special_mode.controller

Enum AnnotationToolVariant.Preset

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description
      public final String name

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DEFAULT

      Preset for default variant used in the framework.
      PEN

      Preset for the 'pen' variant, used with the INK in the framework.
      HIGHLIGHTER

      Preset for the 'highlighter' variant, used with the INK in the framework.
      ARROW

      Preset for the 'arrow' variant, used with the LINE in the framework.
      MAGIC

      Preset for the 'magic' variant, used with the MAGIC_INK in the framework.
      CALLOUT

      Preset for the 'callout' variant, used with the FREETEXT_CALLOUT in the framework.
      CLOUDY

      Preset for the 'cloudy' variant, used with the POLYGON, SQUARE and CIRCLE in the framework.
      DASHED

      Preset for the 'dashed' variant, used with the POLYGON, SQUARE and CIRCLE in the framework.

    • Method Summary

      Modifier and Type Method Description
      static Array<AnnotationToolVariant.Preset> values() Returns an array containing the constants of this enum type, in the order they're declared.
      static AnnotationToolVariant.Preset valueOf(String name) Returns the enum constant of this type with the specified name.
      String getName() Gets the name that this preset's variant will use.

      • 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<AnnotationToolVariant.Preset> 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 AnnotationToolVariant.Preset 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

      • getName

        @Nullable() String getName()

        Gets the name that this preset's variant will use.

        Returns:

        Name of the variant represented by this preset.