com.googlecode.lanterna.gui

Enum Interactable.Result

java.lang.Object

java.lang.Enum<Interactable.Result>

com.googlecode.lanterna.gui.Interactable.Result

All Implemented Interfaces:

Serializable, Comparable<Interactable.Result>

Enclosing interface:

Interactable

public static enum Interactable.Result
extends Enum<Interactable.Result>

The available results from a keyboard interaction

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVENT_HANDLED The event has been dealt with by this component, shouldn't be sent to the parent.
EVENT_NOT_HANDLED The component didn't have any action for this event, send it to the parent.
NEXT_INTERACTABLE_DOWN Move keyboard focus to the next component, going down.
NEXT_INTERACTABLE_RIGHT Move keyboard focus to the next component, going right.
PREVIOUS_INTERACTABLE_LEFT Move keyboard focus to the previous component, going left.
PREVIOUS_INTERACTABLE_UP Move keyboard focus to the previous component, going up.

Method Summary

Methods

Modifier and Type	Method and Description
static Interactable.Result	valueOf(String name) Returns the enum constant of this type with the specified name.
static Interactable.Result[]	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

Enum Constant Detail

EVENT_HANDLED

public static final Interactable.Result EVENT_HANDLED

The event has been dealt with by this component, shouldn't be sent to the parent.

EVENT_NOT_HANDLED

public static final Interactable.Result EVENT_NOT_HANDLED

The component didn't have any action for this event, send it to the parent.

NEXT_INTERACTABLE_DOWN

public static final Interactable.Result NEXT_INTERACTABLE_DOWN

Move keyboard focus to the next component, going down.

NEXT_INTERACTABLE_RIGHT

public static final Interactable.Result NEXT_INTERACTABLE_RIGHT

Move keyboard focus to the next component, going right.

PREVIOUS_INTERACTABLE_UP

public static final Interactable.Result PREVIOUS_INTERACTABLE_UP

Move keyboard focus to the previous component, going up.

PREVIOUS_INTERACTABLE_LEFT

public static final Interactable.Result PREVIOUS_INTERACTABLE_LEFT

Move keyboard focus to the previous component, going left.

Method Detail

values

public static Interactable.Result[] 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 (Interactable.Result c : Interactable.Result.values())
    System.out.println(c);

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