Package com.simsilica.lemur

Class Button

java.lang.Object

com.jme3.scene.Spatial

com.jme3.scene.Node

com.simsilica.lemur.Panel

com.simsilica.lemur.Label

com.simsilica.lemur.Button

All Implemented Interfaces:

HasLocalTransform, CloneableSmartAsset, Collidable, Savable, JmeCloneable, Cloneable

Direct Known Subclasses:

ActionButton, Checkbox, NButton, NIconButton

public class Button
extends Label

A standard Button GUI element that can be clicked to perform an action or set of actions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Button.ButtonAction
protected class	Button.ButtonMouseHandler
protected class	Button.FocusObserver

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

Spatial.BatchHint, Spatial.CullHint, Spatial.DFSMode

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EFFECT_ACTIVATE
static final String	EFFECT_CLICK
static final String	EFFECT_DEACTIVATE
static final String	EFFECT_DISABLE
static final String	EFFECT_ENABLE
static final String	EFFECT_FOCUS
static final String	EFFECT_PRESS
static final String	EFFECT_RELEASE
static final String	EFFECT_UNFOCUS
static final String	ELEMENT_ID

Fields inherited from class com.simsilica.lemur.Label

LAYER_ICON, LAYER_SHADOW_TEXT, LAYER_TEXT

Fields inherited from class com.simsilica.lemur.Panel

EFFECT_CLOSE, EFFECT_OPEN, 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_GLOBAL_LIGHTS, RF_LIGHTLIST, RF_MATPARAM_OVERRIDE, RF_TRANSFORM, shadowMode, userData, worldBound, worldLights, worldOverrides, worldTransform

Constructor Summary

Constructors

Modifier	Constructor	Description
	Button(String s)
protected	Button(String s, boolean applyStyles, ElementId elementId, String style)
	Button(String s, ElementId elementId)
	Button(String s, ElementId elementId, String style)
	Button(String s, String style)

Method Summary

Modifier and Type	Method	Description
void	addClickCommands(Command<? super Button> command)
void	addClickCommands(Command<? super Button>... commands)
void	addCommands(Button.ButtonAction a, Command<? super Button>... commands)
void	click()	Can be called by application code to simulate a click on a button.
List<Command<? super Button>>	getClickCommands()
ColorRGBA	getColor()
List<Command<? super Button>>	getCommands(Button.ButtonAction a)
ColorRGBA	getFocusColor()
ColorRGBA	getFocusShadowColor()
ColorRGBA	getHighlightColor()
ColorRGBA	getHighlightShadowColor()
ColorRGBA	getShadowColor()
boolean	isEnabled()
boolean	isFocused()
boolean	isFocusHighlightOn()
boolean	isHighlightOn()
boolean	isPressed()
void	removeClickCommands(Command<? super Button>... commands)
protected void	resetColors()
protected void	runClick()
void	setButtonCommands(Map<Button.ButtonAction,List<Command<? super Button>>> map)
void	setColor(ColorRGBA color)
void	setEnabled(boolean b)
void	setFocusColor(ColorRGBA color)
void	setFocusShadowColor(ColorRGBA color)
void	setHighlightColor(ColorRGBA color)
void	setHighlightShadowColor(ColorRGBA color)
protected void	setPressed(boolean f)
void	setShadowColor(ColorRGBA color)
protected void	showFocus(boolean f)
protected void	showHighlight(boolean f)
String	toString()	Returns the Spatial's name followed by the class of the spatial Example: "MyNode (com.jme3.scene.Spatial)"

Methods inherited from class com.simsilica.lemur.Label

createText2d, getFont, getFontName, getFontSize, getIcon, getMaxWidth, getShadowOffset, getText, getTextHAlignment, getTextVAlignment, setFont, setFontName, setFontSize, setIcon, setMaxWidth, setShadowOffset, setText, setTextHAlignment, setTextVAlignment

Methods inherited from class com.simsilica.lemur.Panel

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

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, addControlAt, addLight, addMatParamOverride, breadthFirstTraversal, center, checkCulling, clearMatParamOverrides, clone, depthFirstTraversal, 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, hasGlobalLights, 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 Details

ELEMENT_ID

public static final String ELEMENT_ID

See Also:

• Constant Field Values

EFFECT_PRESS

public static final String EFFECT_PRESS

See Also:

• Constant Field Values

EFFECT_RELEASE

public static final String EFFECT_RELEASE

See Also:

• Constant Field Values

EFFECT_CLICK

public static final String EFFECT_CLICK

See Also:

• Constant Field Values

EFFECT_ACTIVATE

public static final String EFFECT_ACTIVATE

See Also:

• Constant Field Values

EFFECT_DEACTIVATE

public static final String EFFECT_DEACTIVATE

See Also:

• Constant Field Values

EFFECT_FOCUS

public static final String EFFECT_FOCUS

See Also:

• Constant Field Values

EFFECT_UNFOCUS

public static final String EFFECT_UNFOCUS

See Also:

• Constant Field Values

EFFECT_ENABLE

public static final String EFFECT_ENABLE

See Also:

• Constant Field Values

EFFECT_DISABLE

public static final String EFFECT_DISABLE

See Also:

• Constant Field Values

Constructor Details

Button

public Button(String s)

Button

public Button(String s,
 String style)

Button

public Button(String s,
 ElementId elementId)

Button

public Button(String s,
 ElementId elementId,
 String style)

Button

protected Button(String s,
 boolean applyStyles,
 ElementId elementId,
 String style)

Method Details

addCommands

public void addCommands(Button.ButtonAction a,
 Command<? super Button>... commands)

getCommands

public List<Command<? super Button>> getCommands(Button.ButtonAction a)

addClickCommands

public void addClickCommands(Command<? super Button> command)

addClickCommands

public void addClickCommands(Command<? super Button>... commands)

removeClickCommands

public void removeClickCommands(Command<? super Button>... commands)

getClickCommands

public List<Command<? super Button>> getClickCommands()

setButtonCommands

@StyleAttribute("buttonCommands")
public void setButtonCommands(Map<Button.ButtonAction,List<Command<? super Button>>> map)

setColor

@StyleAttribute("color")
public void setColor(ColorRGBA color)

Overrides:

setColor in class Label

getColor

public ColorRGBA getColor()

Overrides:

getColor in class Label

setShadowColor

@StyleAttribute(value="shadowColor",
                lookupDefault=false)
public void setShadowColor(ColorRGBA color)

Overrides:

setShadowColor in class Label

getShadowColor

public ColorRGBA getShadowColor()

Overrides:

getShadowColor in class Label

setHighlightColor

@StyleAttribute(value="highlightColor",
                lookupDefault=false)
public void setHighlightColor(ColorRGBA color)

getHighlightColor

public ColorRGBA getHighlightColor()

setHighlightShadowColor

@StyleAttribute(value="highlightShadowColor",
                lookupDefault=false)
public void setHighlightShadowColor(ColorRGBA color)

getHighlightShadowColor

public ColorRGBA getHighlightShadowColor()

setFocusColor

@StyleAttribute(value="focusColor",
                lookupDefault=false)
public void setFocusColor(ColorRGBA color)

getFocusColor

public ColorRGBA getFocusColor()

setFocusShadowColor

@StyleAttribute(value="focusShadowColor",
                lookupDefault=false)
public void setFocusShadowColor(ColorRGBA color)

getFocusShadowColor

public ColorRGBA getFocusShadowColor()

click

public void click()

Can be called by application code to simulate a click on a button. Note: this will run the click effects/actions but not the press/release actions.

setEnabled

public void setEnabled(boolean b)

isEnabled

public boolean isEnabled()

isPressed

public boolean isPressed()

isHighlightOn

public boolean isHighlightOn()

isFocusHighlightOn

public boolean isFocusHighlightOn()

isFocused

public boolean isFocused()

showHighlight

protected void showHighlight(boolean f)

showFocus

protected void showFocus(boolean f)

resetColors

protected void resetColors()

setPressed

protected void setPressed(boolean f)

runClick

protected void runClick()

toString

public String toString()

Description copied from class: Spatial

Returns the Spatial's name followed by the class of the spatial
Example: "MyNode (com.jme3.scene.Spatial)"

Overrides:

toString in class Label

Returns:

Spatial's name followed by the class of the Spatial