Package com.simsilica.lemur.focus

Interface FocusTraversal

All Known Implementing Classes:
DefaultFocusTraversalControl, FocusTraversalAdapter, GuiControl
public interface FocusTraversal
Implemented by classes that can provide focus traversal support for navigation. This is generally the containers or layouts of a user interface that may be able to provide next/previous navigation support.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    FocusTraversal.TraversalDirection
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Spatial
    getDefaultFocus()
    Returns the focusable element that should receive focus when first entering this container level.
    Spatial
    getRelativeFocus(Spatial from, FocusTraversal.TraversalDirection direction)
    Returns the relative focusable element from the specified element in the specified direction as defined by this focus container's implementation of that direction's policy.
    boolean
    isFocusRoot()
    Returns true if this is the root of a focus container hierarchy and navigation should not be permitted out of the container.

  • Method Details

    • getDefaultFocus

      Spatial getDefaultFocus()
      Returns the focusable element that should receive focus when first entering this container level.

    • getRelativeFocus

      Spatial getRelativeFocus(Spatial from, FocusTraversal.TraversalDirection direction)
      Returns the relative focusable element from the specified element in the specified direction as defined by this focus container's implementation of that direction's policy.

    • isFocusRoot

      boolean isFocusRoot()
      Returns true if this is the root of a focus container hierarchy and navigation should not be permitted out of the container. This is commonly used for root-level windows are any container where the user must initiate a specific action to change contexts.