Package com.vaadin.flow.component

Enum Class InputMode

java.lang.Object
java.lang.Enum<InputMode>
com.vaadin.flow.component.InputMode
All Implemented Interfaces:
Serializable, Comparable<InputMode>, Constable
public enum InputMode extends Enum<InputMode>
Virtual keyboard hints for the inputmode attribute. They tell the browser which type of virtual keyboard to display when the user interacts with the field on a mobile device.
Since:
25.3
See Also:

  • 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
    DECIMAL
    Fractional numeric input keyboard that includes the digits and the decimal separator for the user's locale.
    EMAIL
    Virtual keyboard optimized for entering email addresses.
    NONE
    No virtual keyboard.
    NUMERIC
    Numeric input keyboard that only requires the digits 0–9.
    SEARCH
    Virtual keyboard optimized for search input.
    TEL
    Telephone keypad input, including the digits 0–9, the asterisk (*), and the pound (#) key.
    TEXT
    Standard text input keyboard for the user's current locale.
    URL
    Virtual keyboard optimized for entering URLs.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getValue()
    Gets the inputmode attribute value.
    static InputMode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static InputMode[]
    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 InputMode NONE
      No virtual keyboard. Useful when the field implements its own keyboard input control.

    • TEXT

      public static final InputMode TEXT
      Standard text input keyboard for the user's current locale.

    • DECIMAL

      public static final InputMode DECIMAL
      Fractional numeric input keyboard that includes the digits and the decimal separator for the user's locale.

    • NUMERIC

      public static final InputMode NUMERIC
      Numeric input keyboard that only requires the digits 0–9.

    • TEL

      public static final InputMode TEL
      Telephone keypad input, including the digits 0–9, the asterisk (*), and the pound (#) key.

    • EMAIL

      public static final InputMode EMAIL
      Virtual keyboard optimized for entering email addresses.

    • URL

      public static final InputMode URL
      Virtual keyboard optimized for entering URLs.

  • Method Details

    • values

      public static InputMode[] 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 InputMode 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

    • getValue

      public String getValue()
      Gets the inputmode attribute value.
      Returns:
      the inputmode attribute value