Package com.pspdfkit.annotations.actions

Enum AnnotationTriggerEvent

  • All Implemented Interfaces:
    
public enum AnnotationTriggerEvent

    Type of the annotation trigger events. Annotations can define additional actions that should be executed when these events are triggered.

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

      Triggered when cursor enters annotation area. (Unsupported)
      CURSOR_EXITS

      Triggered when cursor exits annotation area. (Unsupported)
      MOUSE_DOWN

      Triggered on ACTION_DOWN on annotation area.
      MOUSE_UP

      Triggered on ACTION_UP on annotation area.

      Note: In order to stay backwards compatible with older PDF specifications, annotation actions returned by getAction take precedence over an additional MOUSE_UP action.
      RECEIVE_FOCUS

      Triggered when annotation is selected.
      LOOSE_FOCUS

      Triggered when annotation is deselected.
      PAGE_OPENED

      Triggered when page is opened. (Unsupported)
      PAGE_CLOSED

      Triggered when page is closed. (Unsupported)
      PAGE_VISIBLE

      Triggered when page becomes visible. (Unsupported)
      FORM_CHANGED

      Triggered when form value gets changed. This trigger event only supports (as per PDF specification).
      FIELD_FORMAT

      Triggered when form value gets formatted. This trigger event only supports (as per PDF specification).
      FORM_VALIDATE

      Triggered when form value gets validated. This trigger event only supports (as per PDF specification).
      FORM_CALCULATE

      Triggered when form is being calculated. This trigger event only supports (as per PDF specification).

    • Method Summary

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