Package com.pdftools.toolbox.pdf

Enum OcgState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OcgState>
    public enum OcgState
extends java.lang.Enum<OcgState>
    The ocg state affects the visibility of content elements that depend on it.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      OFF
      OCG is OFF.
      ON
      OCG is ON.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static OcgState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OcgState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • OFF

        public static final OcgState OFF
        OCG is OFF.

      • ON

        public static final OcgState ON
        OCG is ON.

    • Method Detail

      • values

        public static OcgState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (OcgState c : OcgState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static OcgState valueOf​(java.lang.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.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null