Package org.fxmisc.richtext

Enum Caret.CaretVisibility

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Caret.CaretVisibility>
    Enclosing interface:
    Caret
    public static enum Caret.CaretVisibility
extends java.lang.Enum<Caret.CaretVisibility>
    Determines whether the caret is visible. Those who wish to use the default configuration should use AUTO while those who want a more custom configuration should make a caret's CaretVisibility value oscillate between ON and OFF.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AUTO
      Caret is displayed when area is focused, enabled, and editable.
      OFF
      Caret is not displayed.
      ON
      Caret is displayed.

    • Method Summary

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

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

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

      • valueOf

        public static Caret.CaretVisibility 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