com.simsilica.lemur

Class OptionPanel

java.lang.Object

com.jme3.scene.Spatial

com.jme3.scene.Node

com.simsilica.lemur.Panel

com.simsilica.lemur.OptionPanel

All Implemented Interfaces:

com.jme3.asset.CloneableSmartAsset, com.jme3.collision.Collidable, com.jme3.export.Savable, com.jme3.util.clone.JmeCloneable, java.lang.Cloneable

public class OptionPanel
extends com.simsilica.lemur.Panel

Presents an option title, a message, and a set of option actions to the user. The message portion of the panel can be augmented with additional components as needed. This is similar to Swing's JOptionPane in functionality.

Nested Class Summary

Nested classes/interfaces inherited from class com.jme3.scene.Spatial

com.jme3.scene.Spatial.BatchHint, com.jme3.scene.Spatial.CullHint

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EFFECT_CLOSE
static java.lang.String	EFFECT_OPEN
static java.lang.String	ELEMENT_ID

Fields inherited from class com.simsilica.lemur.Panel

LAYER_BACKGROUND, LAYER_BORDER, LAYER_INSETS

Fields inherited from class com.jme3.scene.Node

children

Fields inherited from class com.jme3.scene.Spatial

batchHint, controls, cullHint, frustrumIntersects, key, localLights, localOverrides, localTransform, name, parent, queueBucket, queueDistance, refreshFlags, RF_BOUND, RF_CHILD_LIGHTLIST, RF_LIGHTLIST, RF_MATPARAM_OVERRIDE, RF_TRANSFORM, shadowMode, userData, worldBound, worldLights, worldOverrides, worldTransform

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OptionPanel(boolean applyStyles, java.lang.String title, java.lang.String message, Action[] options, com.simsilica.lemur.style.ElementId elementId, java.lang.String style)
	OptionPanel(java.lang.String message, Action... options) Creates a new OptionPanel without a title but with the specified message and actions.
	OptionPanel(java.lang.String title, java.lang.String message, com.simsilica.lemur.style.ElementId elementId, java.lang.String style, Action... options) Creates a new OptionPanel with the specified title, message, style, and actions.
	OptionPanel(java.lang.String title, java.lang.String message, java.lang.String style, Action... options) Creates a new OptionPanel with the specified title, message, style, and actions.

Method Summary

Modifier and Type	Method and Description
void	close() Removes this panel from its parent.
com.simsilica.lemur.Container	getButtons() Returns the container that holds the action buttons.
com.simsilica.lemur.Container	getContainer() Returns the central container to which the message label was added.
java.lang.String	getMessage()
com.simsilica.lemur.Label	getMessageLabel() Returns the label element that holds the message text.
Action[]	getOptions()
java.lang.String	getTitle()
com.simsilica.lemur.Label	getTitleLabel() Returns the label element that holds the title text.
boolean	isVisible() Returns true if this panel is still attached to a parent and not CullHint.Always.
void	setMessage(java.lang.String message) Sets the message text of this option panel that will appear on the option panel's container.
void	setOptions(Action... options) Sets the actions that will be turned into ActionButtons at the bottom of the panel.
void	setTitle(java.lang.String title) Sets the title of this option panel.

Methods inherited from class com.simsilica.lemur.Panel

addEffect, addMouseListener, getAlpha, getBackground, getBorder, getEffectControl, getEffects, getElementId, getInsets, getInsetsComponent, getPreferredSize, getSize, getStyle, hasEffect, initializeDefaultStyles, removeEffect, removeMouseListener, runEffect, setAlpha, setAlpha, setBackground, setBorder, setChildAlpha, setEffects, setInsets, setInsetsComponent, setPreferredSize, setSize, toString

Methods inherited from class com.jme3.scene.Node

attachChild, attachChildAt, breadthFirstTraversal, clone, cloneFields, collideWith, deepClone, depthFirstTraversal, descendantMatches, descendantMatches, descendantMatches, detachAllChildren, detachChild, detachChildAt, detachChildNamed, getChild, getChild, getChildIndex, getChildren, getQuantity, getTriangleCount, getVertexCount, hasChild, oldDeepClone, read, setLightListRefresh, setLodLevel, setMaterial, setMatParamOverrideRefresh, setModelBound, setParent, setTransformRefresh, swapChildren, updateGeometricState, updateLogicalState, updateModelBound, updateWorldBound, write

Methods inherited from class com.jme3.scene.Spatial

addControl, addLight, addMatParamOverride, breadthFirstTraversal, center, checkCulling, clearMatParamOverrides, clone, forceRefresh, getBatchHint, getControl, getControl, getCullHint, getKey, getLastFrustumIntersection, getLocalBatchHint, getLocalCullHint, getLocalLightList, getLocalMatParamOverrides, getLocalQueueBucket, getLocalRotation, getLocalScale, getLocalShadowMode, getLocalToWorldMatrix, getLocalTransform, getLocalTranslation, getName, getNumControls, getParent, getQueueBucket, getShadowMode, getUserData, getUserDataKeys, getWorldBound, getWorldLightList, getWorldMatParamOverrides, getWorldRotation, getWorldScale, getWorldTransform, getWorldTranslation, hasAncestor, jmeClone, localToWorld, lookAt, matches, move, move, oldClone, removeControl, removeControl, removeFromParent, removeLight, removeMatParamOverride, rotate, rotate, rotateUpTo, runControlRender, scale, scale, setBatchHint, setBoundRefresh, setCullHint, setKey, setLastFrustumIntersection, setLocalRotation, setLocalRotation, setLocalScale, setLocalScale, setLocalScale, setLocalTransform, setLocalTranslation, setLocalTranslation, setName, setQueueBucket, setRequiresUpdates, setShadowMode, setUserData, updateMatParamOverrides, updateWorldLightList, updateWorldTransforms, worldToLocal

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_ID

public static final java.lang.String ELEMENT_ID

See Also:

Constant Field Values

EFFECT_OPEN

public static final java.lang.String EFFECT_OPEN

See Also:

Constant Field Values

EFFECT_CLOSE

public static final java.lang.String EFFECT_CLOSE

See Also:

Constant Field Values

Constructor Detail

OptionPanel

public OptionPanel(java.lang.String message,
                   Action... options)

Creates a new OptionPanel without a title but with the specified message and actions.

OptionPanel

public OptionPanel(java.lang.String title,
                   java.lang.String message,
                   java.lang.String style,
                   Action... options)

Creates a new OptionPanel with the specified title, message, style, and actions.

OptionPanel

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

Creates a new OptionPanel with the specified title, message, style, and actions.

OptionPanel

protected OptionPanel(boolean applyStyles,
                      java.lang.String title,
                      java.lang.String message,
                      Action[] options,
                      com.simsilica.lemur.style.ElementId elementId,
                      java.lang.String style)

Method Detail

setTitle

public void setTitle(java.lang.String title)

Sets the title of this option panel.

getTitle

public java.lang.String getTitle()

setMessage

public void setMessage(java.lang.String message)

Sets the message text of this option panel that will appear on the option panel's container.

getMessage

public java.lang.String getMessage()

setOptions

public void setOptions(Action... options)

Sets the actions that will be turned into ActionButtons at the bottom of the panel. Any action that is clicked will also call the OptionPanel.close() method which by default removes the panel from its parent node.

getOptions

public Action[] getOptions()

getContainer

public com.simsilica.lemur.Container getContainer()

Returns the central container to which the message label was added. Callers can use this to include additional components if needed. The container by default has the SpringGridLayout in row/column setup.

getTitleLabel

public com.simsilica.lemur.Label getTitleLabel()

Returns the label element that holds the title text.

getMessageLabel

public com.simsilica.lemur.Label getMessageLabel()

Returns the label element that holds the message text.

getButtons

public com.simsilica.lemur.Container getButtons()

Returns the container that holds the action buttons.

isVisible

public boolean isVisible()

Returns true if this panel is still attached to a parent and not CullHint.Always.

close

public void close()

Removes this panel from its parent. Can be overridden by subclasses to provide different close behavior.