com.simsilica.lemur

Class OptionPanelState

java.lang.Object

com.jme3.app.state.BaseAppState

com.simsilica.lemur.OptionPanelState

All Implemented Interfaces:

com.jme3.app.state.AppState

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

Provides modal option panel support where the option panel is the only thing that can receive mouse/touch input until closed. Note: requires PopupState to have also been attached, which is done by GuiGlobals by default. This class is now just a thin wrapper around the standard PopupState.

Constructor Summary

Constructors

Constructor and Description
OptionPanelState()
OptionPanelState(com.simsilica.lemur.style.ElementId defaultElementId, java.lang.String style)
OptionPanelState(com.jme3.scene.Node guiNode)
OptionPanelState(java.lang.String style)

Method Summary

Modifier and Type	Method and Description
protected void	cleanup(com.jme3.app.Application app)
void	close() Closes an open OptionPanel if one is currently open.
OptionPanel	getCurrent() Returns the currently displayed OptionPanel or null if no option panel is visible.
com.jme3.scene.Node	getGuiNode() Returns the GUI node that will be used to display the option panel.
protected java.lang.String	getName(java.lang.Throwable t)
java.lang.String	getStyle() Returns the style that will be used for created OptionPanels.
protected void	initialize(com.jme3.app.Application app)
protected void	onDisable()
protected void	onEnable()
void	setGuiNode(com.jme3.scene.Node guiNode) Sets the GUI node that will be used to display the option panel.
void	setStyle(java.lang.String style) Sets the style that will be used for created OptionPanels.
void	show(OptionPanel panel) Modally shows the specified OptionPanel in the guiNode as defined by getGuiNode().
void	show(java.lang.String title, java.lang.String message, Action... options) Creates and displays a modal OptionPanel with the specified settings.
void	show(java.lang.String title, java.lang.String message, com.simsilica.lemur.style.ElementId elementId, Action... options) Creates and displays a modal OptionPanel with the specified settings.
void	showError(java.lang.String title, java.lang.Throwable t) Creates and displays a model OptionPanel with the specified error information.
void	showError(java.lang.String title, java.lang.Throwable t, com.simsilica.lemur.style.ElementId elementId) Creates and displays a model OptionPanel with the specified error information.
void	update(float tpf)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionPanelState

public OptionPanelState()

OptionPanelState

public OptionPanelState(java.lang.String style)

OptionPanelState

public OptionPanelState(com.simsilica.lemur.style.ElementId defaultElementId,
                        java.lang.String style)

OptionPanelState

public OptionPanelState(com.jme3.scene.Node guiNode)

Method Detail

show

public void show(java.lang.String title,
                 java.lang.String message,
                 Action... options)

Creates and displays a modal OptionPanel with the specified settings. The option panel will be visible until the user clicks a response or until close() is called.

show

public void show(java.lang.String title,
                 java.lang.String message,
                 com.simsilica.lemur.style.ElementId elementId,
                 Action... options)

Creates and displays a modal OptionPanel with the specified settings. The option panel will be visible until the user clicks a response or until close() is called.

getName

protected java.lang.String getName(java.lang.Throwable t)

showError

public void showError(java.lang.String title,
                      java.lang.Throwable t)

Creates and displays a model OptionPanel with the specified error information. An attempt is made to construct a useful message for the specified Throwable. The option panel will be visible until the user clicks a response or until close() is called.

showError

public void showError(java.lang.String title,
                      java.lang.Throwable t,
                      com.simsilica.lemur.style.ElementId elementId)

Creates and displays a model OptionPanel with the specified error information. An attempt is made to construct a useful message for the specified Throwable. The option panel will be visible until the user clicks a response or until close() is called.

show

public void show(OptionPanel panel)

Modally shows the specified OptionPanel in the guiNode as defined by getGuiNode(). An invisible blocker geometry is placed behind it to catch all mouse events until the panel is closed. The option panel will be visible until the user clicks a response or until close() is called.

close

public void close()

Closes an open OptionPanel if one is currently open. Does nothing otherwise.

getCurrent

public OptionPanel getCurrent()

Returns the currently displayed OptionPanel or null if no option panel is visible.

setStyle

public void setStyle(java.lang.String style)

Sets the style that will be used for created OptionPanels.

getStyle

public java.lang.String getStyle()

Returns the style that will be used for created OptionPanels.

setGuiNode

public void setGuiNode(com.jme3.scene.Node guiNode)

Sets the GUI node that will be used to display the option panel. By default, this is SimpleApplication.getGuiNode().

getGuiNode

public com.jme3.scene.Node getGuiNode()

Returns the GUI node that will be used to display the option panel. This is now always PopupState.getGuiNode()

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

update

public void update(float tpf)

Specified by:

update in interface com.jme3.app.state.AppState

Overrides:

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

onDisable

protected void onDisable()

Specified by:

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