com.simsilica.lemur.core

Class GuiControl

java.lang.Object

com.jme3.scene.control.AbstractControl

com.simsilica.lemur.core.AbstractNodeControl<GuiControl>

com.simsilica.lemur.core.GuiControl

All Implemented Interfaces:

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

public class GuiControl
extends AbstractNodeControl<GuiControl>
implements FocusTarget, FocusTraversal

Manages a component stack, the parent/child relationship, and other standard GuiControl functionality.

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
GuiControl(GuiComponent... components)
GuiControl(java.lang.String... layerOrder)

Method Summary

Modifier and Type	Method and Description
<T extends GuiComponent> T	addComponent(T c)
void	addFocusChangeListener(FocusChangeListener l)
void	addListener(GuiControlListener l)
void	addUpdateListener(GuiUpdateListener l)
protected void	attach()
protected void	controlUpdate(float tpf)
protected void	detach()
void	focusGained() Notifies this focus target that is has gained focus.
void	focusLost() Notifies this focus target that is has lost focus.
<T extends GuiComponent> T	getComponent(java.lang.String key)
int	getComponentIndex(GuiComponent c)
java.util.List<GuiComponent>	getComponents()
com.jme3.scene.Spatial	getDefaultFocus() Returns the focusable element that should receive focus when first entering this container level.
<T extends GuiLayout> T	getLayout()
com.jme3.scene.Node	getNode()
com.jme3.math.Vector3f	getPreferredSize()
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.
com.jme3.math.Vector3f	getSize()
protected boolean	hasParent()
void	invalidate()
protected boolean	isChild()
boolean	isFocusable() Returns true if this control is focusable, either because one of its child components/layout is focusable or because setFocusable(true) was called.
boolean	isFocused() Returns true if this focus target currently has the focus.
boolean	isFocusRoot() Returns true if this is the root of a focus container hierarchy and navigation should not be permitted out of the container.
boolean	removeComponent(GuiComponent c)
<T extends GuiComponent> T	removeComponent(java.lang.String key)
void	removeFocusChangeListener(FocusChangeListener l)
void	removeListener(GuiControlListener l)
void	removeUpdateListener(GuiUpdateListener l)
protected void	revalidate()
<T extends GuiComponent> T	setComponent(java.lang.String key, T component) Sets a new component to the specified layer and returns THAT component, not the previous value.
void	setFocusable(boolean b) Sets the focusable state to true for this control even if none of the child components are focusable.
void	setLayerOrder(java.lang.String... layers)
void	setLayout(GuiLayout l)
void	setPreferredSize(com.jme3.math.Vector3f pref)
void	setSize(com.jme3.math.Vector3f size)

Methods inherited from class com.simsilica.lemur.core.AbstractNodeControl

controlRender, setSpatial

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, toString, wait, wait, wait

Constructor Detail

GuiControl

public GuiControl(GuiComponent... components)

GuiControl

public GuiControl(java.lang.String... layerOrder)

Method Detail

getNode

public com.jme3.scene.Node getNode()

Overrides:

getNode in class AbstractNodeControl<GuiControl>

addListener

public void addListener(GuiControlListener l)

removeListener

public void removeListener(GuiControlListener l)

addFocusChangeListener

public void addFocusChangeListener(FocusChangeListener l)

removeFocusChangeListener

public void removeFocusChangeListener(FocusChangeListener l)

addUpdateListener

public void addUpdateListener(GuiUpdateListener l)

removeUpdateListener

public void removeUpdateListener(GuiUpdateListener l)

isFocused

public boolean isFocused()

Description copied from interface: FocusTarget

Returns true if this focus target currently has the focus.

Specified by:

isFocused in interface FocusTarget

setFocusable

public void setFocusable(boolean b)

Sets the focusable state to true for this control even if none of the child components are focusable.

isFocusable

public boolean isFocusable()

Returns true if this control is focusable, either because one of its child components/layout is focusable or because setFocusable(true) was called.

Specified by:

isFocusable in interface FocusTarget

focusGained

public void focusGained()

Description copied from interface: FocusTarget

Notifies this focus target that is has gained focus.

Specified by:

focusGained in interface FocusTarget

focusLost

public void focusLost()

Description copied from interface: FocusTarget

Notifies this focus target that is has lost focus.

Specified by:

focusLost in interface FocusTarget

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

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

setLayerOrder

public void setLayerOrder(java.lang.String... layers)

setLayout

public void setLayout(GuiLayout l)

getLayout

public <T extends GuiLayout> T getLayout()

setPreferredSize

public void setPreferredSize(com.jme3.math.Vector3f pref)

getPreferredSize

public com.jme3.math.Vector3f getPreferredSize()

setSize

public void setSize(com.jme3.math.Vector3f size)

getSize

public com.jme3.math.Vector3f getSize()

getComponents

public java.util.List<GuiComponent> getComponents()

addComponent

public <T extends GuiComponent> T addComponent(T c)

getComponentIndex

public int getComponentIndex(GuiComponent c)

setComponent

public <T extends GuiComponent> T setComponent(java.lang.String key,
                                               T component)

Sets a new component to the specified layer and returns THAT component, not the previous value. This is so that it works like addComponent() in that you can set it and grab it at the same time.

getComponent

public <T extends GuiComponent> T getComponent(java.lang.String key)

removeComponent

public <T extends GuiComponent> T removeComponent(java.lang.String key)

removeComponent

public boolean removeComponent(GuiComponent c)

attach

protected void attach()

Specified by:

attach in class AbstractNodeControl<GuiControl>

controlUpdate

protected void controlUpdate(float tpf)

Overrides:

controlUpdate in class AbstractNodeControl<GuiControl>

hasParent

protected boolean hasParent()

isChild

protected boolean isChild()

revalidate

protected void revalidate()

invalidate

public void invalidate()

detach

protected void detach()

Specified by:

detach in class AbstractNodeControl<GuiControl>