Package org.apache.poi.ss.usermodel

Enum PrintCellComments

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PrintCellComments>
    public enum PrintCellComments
extends java.lang.Enum<PrintCellComments>
    These enumerations specify how cell comments shall be displayed for paper printing purposes.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AS_DISPLAYED
      Print cell comments as displayed.
      AT_END
      Print cell comments at end of document.
      NONE
      Do not print cell comments.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getValue()  
      static PrintCellComments valueOf​(int value)
      Returns the enum constant of this type with the specified name.
      static PrintCellComments valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PrintCellComments[] 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

      • AS_DISPLAYED

        public static final PrintCellComments AS_DISPLAYED
        Print cell comments as displayed.

      • AT_END

        public static final PrintCellComments AT_END
        Print cell comments at end of document.

    • Method Detail

      • values

        public static PrintCellComments[] 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 (PrintCellComments c : PrintCellComments.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static PrintCellComments 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

      • getValue

        public int getValue()

      • valueOf

        public static PrintCellComments valueOf​(int value)
        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:
        value - 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