Enum Interactable.Result

java.lang.Object
java.lang.Enum<Interactable.Result>
com.googlecode.lanterna.gui2.Interactable.Result
All Implemented Interfaces:
Serializable, Comparable<Interactable.Result>, java.lang.constant.Constable
Enclosing interface:
Interactable

public static enum Interactable.Result extends Enum<Interactable.Result>
Enum to represent the various results coming out of the handleKeyStroke method
  • 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
    This component has handled the key-stroke and it should be considered consumed.
    This component has handled the key-stroke and requests the GUI system to switch focus to next component in the general down direction.
    This component has handled the key-stroke and requests the GUI system to switch focus to next component in the general left direction.
    This component has handled the key-stroke and requests the GUI system to switch focus to next component in an ordered list of components.
    This component has handled the key-stroke and requests the GUI system to switch focus to previous component in an ordered list of components.
    This component has handled the key-stroke and requests the GUI system to switch focus to next component in the general right direction.
    This component has handled the key-stroke and requests the GUI system to switch focus to next component in the general up direction.
    This component didn't handle the key-stroke, either because it was not recognized or because it chose to ignore it.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this type with the specified name.
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • UNHANDLED

      public static final Interactable.Result UNHANDLED
      This component didn't handle the key-stroke, either because it was not recognized or because it chose to ignore it.
    • HANDLED

      public static final Interactable.Result HANDLED
      This component has handled the key-stroke and it should be considered consumed.
    • MOVE_FOCUS_NEXT

      public static final Interactable.Result MOVE_FOCUS_NEXT
      This component has handled the key-stroke and requests the GUI system to switch focus to next component in an ordered list of components. This should generally be returned if moving focus by using the tab key.
    • MOVE_FOCUS_PREVIOUS

      public static final Interactable.Result MOVE_FOCUS_PREVIOUS
      This component has handled the key-stroke and requests the GUI system to switch focus to previous component in an ordered list of components. This should generally be returned if moving focus by using the reverse tab key.
    • MOVE_FOCUS_LEFT

      public static final Interactable.Result MOVE_FOCUS_LEFT
      This component has handled the key-stroke and requests the GUI system to switch focus to next component in the general left direction. By convention in Lanterna, if there is no component to the left, it will move up instead. This should generally be returned if moving focus by using the left array key.
    • MOVE_FOCUS_RIGHT

      public static final Interactable.Result MOVE_FOCUS_RIGHT
      This component has handled the key-stroke and requests the GUI system to switch focus to next component in the general right direction. By convention in Lanterna, if there is no component to the right, it will move down instead. This should generally be returned if moving focus by using the right array key.
    • MOVE_FOCUS_UP

      public static final Interactable.Result MOVE_FOCUS_UP
      This component has handled the key-stroke and requests the GUI system to switch focus to next component in the general up direction. By convention in Lanterna, if there is no component above, it will move left instead. This should generally be returned if moving focus by using the up array key.
    • MOVE_FOCUS_DOWN

      public static final Interactable.Result MOVE_FOCUS_DOWN
      This component has handled the key-stroke and requests the GUI system to switch focus to next component in the general down direction. By convention in Lanterna, if there is no component below, it will move up instead. This should generally be returned if moving focus by using the down array key.
  • Constructor Details

    • Result

      private Result()
  • Method Details

    • values

      public static Interactable.Result[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static Interactable.Result valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null