com.simsilica.lemur.focus

Class FocusNavigationState

java.lang.Object

com.jme3.app.state.BaseAppState

com.simsilica.lemur.focus.FocusNavigationState

All Implemented Interfaces:

com.jme3.app.state.AppState

public class FocusNavigationState
extends com.jme3.app.state.BaseAppState

Manages the input based UI navigation and maybe some minimal input hookups.

Constructor Summary

Constructors

Constructor and Description
FocusNavigationState(InputMapper inputMapper, FocusManagerState focusState)

Method Summary

Modifier and Type	Method and Description
protected void	cleanup(com.jme3.app.Application app)
protected static <T> T	getControl(com.jme3.scene.Spatial s, java.lang.Class<T> type) Utillity method to get the control for a spatial when we don't care if the interface implements control.
protected com.jme3.scene.Spatial	getCurrentFocus()
com.jme3.scene.Spatial	getDefaultFocus(com.jme3.scene.Spatial spatial) Returns the default focus element for the specified spatial if it is a focus container, else it returns the spatial directly.
protected com.jme3.scene.Spatial	getFocusContainer(com.jme3.scene.Spatial spatial)
static FocusTraversal	getFocusTraversal(com.jme3.scene.Spatial s)
protected void	initialize(com.jme3.app.Application app)
protected void	navigate(FocusTraversal.TraversalDirection dir)
protected void	navigateDown()
protected void	navigateLeft()
protected void	navigateRight()
protected void	navigateUp()
protected void	onDisable()
protected void	onEnable()
com.jme3.scene.Spatial	requestChangeFocus(com.jme3.scene.Spatial spatial, FocusTraversal.TraversalDirection dir) Attempts to navigate to the next focusable element as specified by the traversal direction.

Methods inherited from class com.jme3.app.state.BaseAppState

cleanup, getApplication, getState, getStateManager, initialize, isEnabled, isInitialized, postRender, render, setEnabled, stateAttached, stateDetached, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FocusNavigationState

public FocusNavigationState(InputMapper inputMapper,
                            FocusManagerState focusState)

Method Detail

getDefaultFocus

public com.jme3.scene.Spatial getDefaultFocus(com.jme3.scene.Spatial spatial)

Returns the default focus element for the specified spatial if it is a focus container, else it returns the spatial directly.

requestChangeFocus

public com.jme3.scene.Spatial requestChangeFocus(com.jme3.scene.Spatial spatial,
                                                 FocusTraversal.TraversalDirection dir)

Attempts to navigate to the next focusable element as specified by the traversal direction.

initialize

protected void initialize(com.jme3.app.Application app)

Specified by:

initialize in class com.jme3.app.state.BaseAppState

cleanup

protected void cleanup(com.jme3.app.Application app)

Specified by:

cleanup in class com.jme3.app.state.BaseAppState

onEnable

protected void onEnable()

Specified by:

onEnable in class com.jme3.app.state.BaseAppState

onDisable

protected void onDisable()

Specified by:

onDisable in class com.jme3.app.state.BaseAppState

getCurrentFocus

protected com.jme3.scene.Spatial getCurrentFocus()

getControl

protected static <T> T getControl(com.jme3.scene.Spatial s,
                                  java.lang.Class<T> type)

Utillity method to get the control for a spatial when we don't care if the interface implements control.

getFocusTraversal

public static FocusTraversal getFocusTraversal(com.jme3.scene.Spatial s)

getFocusContainer

protected com.jme3.scene.Spatial getFocusContainer(com.jme3.scene.Spatial spatial)

navigate

protected void navigate(FocusTraversal.TraversalDirection dir)

navigateLeft

protected void navigateLeft()

navigateRight

protected void navigateRight()

navigateUp

protected void navigateUp()

navigateDown

protected void navigateDown()