com.simsilica.lemur.core

Class FocusTraversalAdapter

java.lang.Object

com.simsilica.lemur.core.FocusTraversalAdapter

All Implemented Interfaces:

FocusTraversal

public class FocusTraversalAdapter
extends java.lang.Object
implements FocusTraversal

Wraps a standard GuiLayout to provide basic default focus navigation support. Essentially, things like Left, Right, Up, Down are directly wired to Next, Previous and the GuiLayout's child list is used for ordering.

Nested Class Summary

Nested classes/interfaces inherited from interface com.simsilica.lemur.focus.FocusTraversal

FocusTraversal.TraversalDirection

Constructor Summary

Constructors

Constructor and Description
FocusTraversalAdapter(GuiLayout layout)

Method Summary

Modifier and Type	Method and Description
com.jme3.scene.Spatial	getDefaultFocus() Returns the focusable element that should receive focus when first entering this container level.
protected com.jme3.scene.Spatial	getFirst()
protected com.jme3.scene.Spatial	getLast()
GuiLayout	getLayout()
protected com.jme3.scene.Spatial	getNext(com.jme3.scene.Spatial from)
protected com.jme3.scene.Spatial	getPrevious(com.jme3.scene.Spatial from)
com.jme3.scene.Spatial	getRelativeFocus(com.jme3.scene.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.
void	setFocusRoot(boolean b)
void	setLayout(GuiLayout layout)

Methods inherited from class java.lang.Object

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

Constructor Detail

FocusTraversalAdapter

public FocusTraversalAdapter(GuiLayout layout)

Method Detail

setLayout

public void setLayout(GuiLayout layout)

getLayout

public GuiLayout getLayout()

getDefaultFocus

public com.jme3.scene.Spatial getDefaultFocus()

Description copied from interface: FocusTraversal

Returns the focusable element that should receive focus when first entering this container level.

Specified by:

getDefaultFocus in interface FocusTraversal

getRelativeFocus

public com.jme3.scene.Spatial getRelativeFocus(com.jme3.scene.Spatial from,
                                               FocusTraversal.TraversalDirection direction)

Description copied from interface: FocusTraversal

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.

Specified by:

getRelativeFocus in interface FocusTraversal

setFocusRoot

public void setFocusRoot(boolean b)

isFocusRoot

public boolean isFocusRoot()

Description copied from interface: FocusTraversal

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.

Specified by:

isFocusRoot in interface FocusTraversal

getFirst

protected com.jme3.scene.Spatial getFirst()

getLast

protected com.jme3.scene.Spatial getLast()

getNext

protected com.jme3.scene.Spatial getNext(com.jme3.scene.Spatial from)

getPrevious

protected com.jme3.scene.Spatial getPrevious(com.jme3.scene.Spatial from)