com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

Skip navigation links
com.aspose.pdf

Class AnnotationFlags

  • java.lang.Object
    • com.aspose.ms.System.ValueType<com.aspose.ms.System.Enum>
      • com.aspose.ms.System.Enum
        • com.aspose.pdf.AnnotationFlags

  • public final class AnnotationFlags
extends com.aspose.ms.System.Enum

    A set of flags specifying various characteristics of the annotation.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.aspose.ms.System.Enum

        com.aspose.ms.System.Enum.AbstractEnum, com.aspose.ms.System.Enum.FlaggedEnum, com.aspose.ms.System.Enum.ObjectEnum, com.aspose.ms.System.Enum.SimpleEnum

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int Default
      Default value.
      static int Hidden
      If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available.
      static int Invisible
      If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available.
      static int Locked
      If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user.
      static int LockedContents
      If set, do not allow the contents of the annotation to be modified by the user.
      static int NoRotate
      If set, do not rotate the annotation's appearance to match the rotation of the page.
      static int NoView
      If set, do not display the annotation on the screen or allow it to interact with the user.
      static int NoZoom
      If set, do not scale the annotation's appearance to match the magnification of the page.
      static int Print
      If set, print the annotation when the page is printed.
      static int ReadOnly
      If set, do not allow the annotation to interact with the user.
      static int ToggleNoView
      If set, invert the interpretation of the NoView flag for certain events.

      • Fields inherited from class com.aspose.ms.System.Enum

        EnumSeparatorCharArray

    • Method Summary

      • Methods inherited from class com.aspose.ms.System.Enum

        Clone, CloneTo, format, format, get_Caption, get_Value, getName, getNames, getNames, getUnderlyingType, getUnderlyingType, getValue, getValues, isDefined, isDefined, isDefined, isDefined, parse, parse, parse, parse, register, toObject

    • Field Detail

      • Invisible

        public static final int Invisible

        If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an unknown annotation using an appearance stream specified by its appearance dictionary, if any.

        See Also:
        Constant Field Values

      • Hidden

        public static final int Hidden

        If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available. In cases where screen space is limited, the ability to hide and show annotations selectively can be used in combination with appearance streams to display auxiliary pop-up information similar in function to online help systems.

        See Also:
        Constant Field Values

      • Print

        public static final int Print

        If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.

        See Also:
        Constant Field Values

      • NoZoom

        public static final int NoZoom

        If set, do not scale the annotation's appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) remains fixed, regardless of the page magnification.

        See Also:
        Constant Field Values

      • NoRotate

        public static final int NoRotate

        If set, do not rotate the annotation's appearance to match the rotation of the page. The upper-left corner of the annotation rectangle remains in a fixed location on the page, regardless of the page rotation.

        See Also:
        Constant Field Values

      • NoView

        public static final int NoView

        If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction.

        See Also:
        Constant Field Values

      • ReadOnly

        public static final int ReadOnly

        If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions. This flag is ignored for widget annotations; its function is subsumed by the ReadOnly flag of the associated form field.

        See Also:
        Constant Field Values

      • Locked

        public static final int Locked

        If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.

        See Also:
        Constant Field Values

      • ToggleNoView

        public static final int ToggleNoView

        If set, invert the interpretation of the NoView flag for certain events. A typical use is to have an annotation that appears only when a mouse cursor is held over it.

        See Also:
        Constant Field Values

      • LockedContents

        public static final int LockedContents

        If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.

        See Also:
        Constant Field Values