com.simsilica.lemur.focus

Enum FocusTraversal.TraversalDirection

java.lang.Object

java.lang.Enum<FocusTraversal.TraversalDirection>

com.simsilica.lemur.focus.FocusTraversal.TraversalDirection

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FocusTraversal.TraversalDirection>

Enclosing interface:

FocusTraversal

public static enum FocusTraversal.TraversalDirection
extends java.lang.Enum<FocusTraversal.TraversalDirection>

Enum Constant Summary

Enum Constants

Enum Constant and Description
Down For containers that provide row/column navigation, this represents the next row in a similar column as defined by the layout/navigation implementation.
End For containers that provide row/column nagivation, this represents the last element in the current row or column, depending on if the UI is row-oriented or column oriented.
Home For containers that provide row/column nagivation, this represents the first element in the current row or column, depending on if the UI is row-oriented or column oriented.
Left For containers that provide row/column navigation, this represents the previous column in a similar row as defined by the layout/navigation implementation.
Next Represents the next logical navigation step in a focus traversal workflow.
PageEnd Represents the last element in this focus container.
PageHome Represents the first element in this focus container.
Previous Represents the previous logical navigation step in a focus traversal workflow.
Right For containers that provide row/column navigation, this represents the next column in a similar row as defined by the layout/navigation implementation.
Up For containers that provide row/column navigation, this represents the previous row in a similar column as defined by the layout/navigation implementation.

Method Summary

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

Up

public static final FocusTraversal.TraversalDirection Up

For containers that provide row/column navigation, this represents the previous row in a similar column as defined by the layout/navigation implementation. In many layouts, this will be synonymous with TraversalDirection.Previous. It is up to the specific focus layout how wrapping is handled.

Down

public static final FocusTraversal.TraversalDirection Down

For containers that provide row/column navigation, this represents the next row in a similar column as defined by the layout/navigation implementation. In many layouts, this will be synonymous with TraversalDirection.Next. It is up to the specific focus layout how wrapping is handled.

Left

public static final FocusTraversal.TraversalDirection Left

For containers that provide row/column navigation, this represents the previous column in a similar row as defined by the layout/navigation implementation. In many layouts, this will be synonymous with TraversalDirection.Previous. It is up to the specific focus layout how wrapping is handled.

Right

public static final FocusTraversal.TraversalDirection Right

For containers that provide row/column navigation, this represents the next column in a similar row as defined by the layout/navigation implementation. In many layouts, this will be synonymous with TraversalDirection.Next. It is up to the specific focus layout how wrapping is handled.

Next

public static final FocusTraversal.TraversalDirection Next

Represents the next logical navigation step in a focus traversal workflow. In general, using TraversalDirection.Next should be able to take you through all focusable elements in a container, from TraversalDirection.PageHome to TraversalDirection.PageEnd. It is also typical that in a root-level container, Next should wrap to PageHome when reaching the end. It is not required.

Previous

public static final FocusTraversal.TraversalDirection Previous

Represents the previous logical navigation step in a focus traversal workflow. In general, using TraversalDirection.Previous should be able to take you through all focusable elements in a container, from TraversalDirection.PageEnd to TraversalDirection.PageHome. It is also typical that in a root-level container, Previous should wrap to PageEnd when on the first/home element. It is not required.

Home

public static final FocusTraversal.TraversalDirection Home

For containers that provide row/column nagivation, this represents the first element in the current row or column, depending on if the UI is row-oriented or column oriented. Otherwise this is the same as TraversalDirection.PageHome.

End

public static final FocusTraversal.TraversalDirection End

For containers that provide row/column nagivation, this represents the last element in the current row or column, depending on if the UI is row-oriented or column oriented. Otherwise this is the same as TraversalDirection.PageHome.

PageHome

public static final FocusTraversal.TraversalDirection PageHome

Represents the first element in this focus container.

PageEnd

public static final FocusTraversal.TraversalDirection PageEnd

Represents the last element in this focus container.

Method Detail

values

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

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FocusTraversal.TraversalDirection valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null