Package limn.backend.spi

Enum Class TextInput

java.lang.Object
java.lang.Enum<TextInput>
limn.backend.spi.TextInput
All Implemented Interfaces:
Serializable, Comparable<TextInput>, Constable
public enum TextInput extends Enum<TextInput>
What text a window asks the platform for, set with WindowPeer.setTextInput(limn.backend.spi.TextInput). Two requests that look like one: typed characters, which a list's type-ahead needs, and input-method composition, which only a text field wants. The SDL3 spike measured the difference: a platform that delivers no characters while composition is off broke every type-ahead.

A 1.x minor release may add constants to this enum: a switch over it needs a default branch.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CHARACTERS
    Typed characters, one committed code point at a time, with the input method off: what a control that is not text wants, so a keystroke goes past the input method untouched while a list still hears the letters for its type-ahead.
    COMPOSITION
    Characters and the input method's composition, with its preedit and candidate window: what a text field wants.
    NONE
    No text: keys only.

  • Method Summary

    Modifier and Type
    Method
    Description
    static TextInput
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static TextInput[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NONE

      public static final TextInput NONE
      No text: keys only. Characters typed are not delivered.

    • CHARACTERS

      public static final TextInput CHARACTERS
      Typed characters, one committed code point at a time, with the input method off: what a control that is not text wants, so a keystroke goes past the input method untouched while a list still hears the letters for its type-ahead.

    • COMPOSITION

      public static final TextInput COMPOSITION
      Characters and the input method's composition, with its preedit and candidate window: what a text field wants.

  • Method Details

    • values

      public static TextInput[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TextInput valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null