Package com.simsilica.lemur.focus

Enum Class FocusTraversal.TraversalDirection

java.lang.Object
java.lang.Enum<FocusTraversal.TraversalDirection>
com.simsilica.lemur.focus.FocusTraversal.TraversalDirection
All Implemented Interfaces:
Serializable, Comparable<FocusTraversal.TraversalDirection>, Constable
Enclosing interface:
FocusTraversal
public static enum FocusTraversal.TraversalDirection extends Enum<FocusTraversal.TraversalDirection>

  • 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
    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
    Description
    static FocusTraversal.TraversalDirection
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static FocusTraversal.TraversalDirection[]
    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

    • 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.

    • 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 Details

    • values

      public static FocusTraversal.TraversalDirection[] 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 FocusTraversal.TraversalDirection 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