com.simsilica.lemur.focus

Class DefaultFocusTraversalControl

java.lang.Object

com.jme3.scene.control.AbstractControl

com.simsilica.lemur.focus.DefaultFocusTraversalControl

All Implemented Interfaces:

com.jme3.export.Savable, com.jme3.scene.control.Control, com.jme3.util.clone.JmeCloneable, FocusTraversal, java.lang.Cloneable

public class DefaultFocusTraversalControl
extends com.jme3.scene.control.AbstractControl
implements FocusTraversal

A default implementation of the FocusTraversal interface that is a control providing direct access to any child spatials that have FocusTarget controls that are "focusable". This is useful for managing the focus navigation of regular Spatials that are not standard Lemur GUI elements. It provides only the most basic next/previous navigation based on the order of the children as up/down/left/right direction doesn't make any sense out of context.

Nested Class Summary

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

FocusTraversal.TraversalDirection

Field Summary

Fields inherited from class com.jme3.scene.control.AbstractControl

enabled, spatial

Constructor Summary

Constructors

Constructor and Description
DefaultFocusTraversalControl()
DefaultFocusTraversalControl(boolean focusRoot)

Method Summary

Modifier and Type	Method and Description
protected void	controlRender(com.jme3.renderer.RenderManager rm, com.jme3.renderer.ViewPort vp)
protected void	controlUpdate(float f)
com.jme3.scene.Spatial	getDefaultFocus() Returns the focusable element that should receive focus when first entering this container level.
protected com.jme3.scene.Spatial	getFirstFocus()
protected com.jme3.scene.Spatial	getLastFocus()
protected com.jme3.scene.Spatial	getNextFocus(com.jme3.scene.Spatial from)
protected com.jme3.scene.Spatial	getPreviousFocus(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 f)
void	setSpatial(com.jme3.scene.Spatial s)
java.lang.String	toString()

Methods inherited from class com.jme3.scene.control.AbstractControl

cloneFields, cloneForSpatial, getSpatial, isEnabled, jmeClone, read, render, setEnabled, update, write

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFocusTraversalControl

public DefaultFocusTraversalControl()

DefaultFocusTraversalControl

public DefaultFocusTraversalControl(boolean focusRoot)

Method Detail

setSpatial

public void setSpatial(com.jme3.scene.Spatial s)

Specified by:

setSpatial in interface com.jme3.scene.control.Control

Overrides:

setSpatial in class com.jme3.scene.control.AbstractControl

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 f)

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

getFirstFocus

protected com.jme3.scene.Spatial getFirstFocus()

getLastFocus

protected com.jme3.scene.Spatial getLastFocus()

getNextFocus

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

getPreviousFocus

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

controlUpdate

protected void controlUpdate(float f)

Specified by:

controlUpdate in class com.jme3.scene.control.AbstractControl

controlRender

protected void controlRender(com.jme3.renderer.RenderManager rm,
                             com.jme3.renderer.ViewPort vp)

Specified by:

controlRender in class com.jme3.scene.control.AbstractControl

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object