Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.key

Enum Class TransferFocusOnEnter

java.lang.Object

java.lang.Enum<TransferFocusOnEnter>

is.codion.swing.common.ui.key.TransferFocusOnEnter

All Implemented Interfaces:

Serializable, Comparable<TransferFocusOnEnter>, Constable

public enum TransferFocusOnEnter
extends Enum<TransferFocusOnEnter>

A utility enum for enabled focus traversal based on the Enter key.

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
BACKWARD	Transfer the focus backward when Enter is pressed with the InputEvent.SHIFT_DOWN_MASK modifier enabled.
FORWARD	Transfer the focus forward when Enter is pressed.
FORWARD_BACKWARD	Transfer the focus forward when Enter is pressed and backward when Enter is pressed with the InputEvent.SHIFT_DOWN_MASK modifier enabled.

Method Summary

Modifier and Type	Method	Description
abstract void	enable(JComponent... components)
static TransferFocusOnEnter	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TransferFocusOnEnter[]	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

FORWARD

public static final TransferFocusOnEnter FORWARD

Transfer the focus forward when Enter is pressed.

Note that in case of JTextArea the InputEvent.CTRL_DOWN_MASK modifier is added.

BACKWARD

public static final TransferFocusOnEnter BACKWARD

Transfer the focus backward when Enter is pressed with the InputEvent.SHIFT_DOWN_MASK modifier enabled.

FORWARD_BACKWARD

public static final TransferFocusOnEnter FORWARD_BACKWARD

Transfer the focus forward when Enter is pressed and backward when Enter is pressed with the InputEvent.SHIFT_DOWN_MASK modifier enabled.

Note that in case of JTextArea the InputEvent.CTRL_DOWN_MASK modifier is added for the forward trigger.

Method Details

values

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

enable

public abstract void enable(JComponent... components)

Parameters:

components - the components for which to enable focus transfer on enter