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:

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

Direct Known Subclasses:

Checkbox

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 and Description
static class	Button.ButtonAction
protected class	Button.ButtonMouseHandler
protected class	Button.FocusObserver

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_ACTIVATE
static java.lang.String	EFFECT_CLICK
static java.lang.String	EFFECT_DEACTIVATE
static java.lang.String	EFFECT_DISABLE
static java.lang.String	EFFECT_ENABLE
static java.lang.String	EFFECT_FOCUS
static java.lang.String	EFFECT_PRESS
static java.lang.String	EFFECT_RELEASE
static java.lang.String	EFFECT_UNFOCUS
static java.lang.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_LIGHTLIST, RF_MATPARAM_OVERRIDE, RF_TRANSFORM, shadowMode, userData, worldBound, worldLights, worldOverrides, worldTransform

Constructor Summary

Constructors

Modifier	Constructor and Description
	Button(java.lang.String s)
protected	Button(java.lang.String s, boolean applyStyles, ElementId elementId, java.lang.String style)
	Button(java.lang.String s, ElementId elementId)
	Button(java.lang.String s, ElementId elementId, java.lang.String style)
	Button(java.lang.String s, java.lang.String style)

Method Summary

Modifier and Type	Method and Description
void	addClickCommands(Command<? super Button>... commands)
void	addClickCommands(Command<? super Button> command)
void	addCommands(Button.ButtonAction a, Command<? super Button>... commands)
void	click() Can be called by application code to simulate a click on a button.
java.util.List<Command<? super Button>>	getClickCommands()
com.jme3.math.ColorRGBA	getColor()
java.util.List<Command<? super Button>>	getCommands(Button.ButtonAction a)
com.jme3.math.ColorRGBA	getFocusColor()
com.jme3.math.ColorRGBA	getFocusShadowColor()
com.jme3.math.ColorRGBA	getHighlightColor()
com.jme3.math.ColorRGBA	getHighlightShadowColor()
com.jme3.math.ColorRGBA	getShadowColor()
static void	initializeDefaultStyles(Attributes attrs)
boolean	isEnabled()
boolean	isFocused()
boolean	isFocusHighlightOn()
boolean	isHighlightOn()
boolean	isPressed()
void	removeClickCommands(Command<? super Button>... commands)
protected void	resetColors()
protected void	runClick()
void	setButtonCommands(java.util.Map<Button.ButtonAction,java.util.List<Command<? super Button>>> map)
void	setColor(com.jme3.math.ColorRGBA color)
void	setEnabled(boolean b)
void	setFocusColor(com.jme3.math.ColorRGBA color)
void	setFocusShadowColor(com.jme3.math.ColorRGBA color)
void	setHighlightColor(com.jme3.math.ColorRGBA color)
void	setHighlightShadowColor(com.jme3.math.ColorRGBA color)
protected void	setPressed(boolean f)
void	setShadowColor(com.jme3.math.ColorRGBA color)
protected void	showFocus(boolean f)
protected void	showHighlight(boolean f)
java.lang.String	toString()

Methods inherited from class com.simsilica.lemur.Label

getFont, getFontSize, getIcon, getMaxWidth, getShadowOffset, getText, getTextHAlignment, getTextVAlignment, setFont, 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, 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_PRESS

public static final java.lang.String EFFECT_PRESS

See Also:

Constant Field Values

EFFECT_RELEASE

public static final java.lang.String EFFECT_RELEASE

See Also:

Constant Field Values

EFFECT_CLICK

public static final java.lang.String EFFECT_CLICK

See Also:

Constant Field Values

EFFECT_ACTIVATE

public static final java.lang.String EFFECT_ACTIVATE

See Also:

Constant Field Values

EFFECT_DEACTIVATE

public static final java.lang.String EFFECT_DEACTIVATE

See Also:

Constant Field Values

EFFECT_FOCUS

public static final java.lang.String EFFECT_FOCUS

See Also:

Constant Field Values

EFFECT_UNFOCUS

public static final java.lang.String EFFECT_UNFOCUS

See Also:

Constant Field Values

EFFECT_ENABLE

public static final java.lang.String EFFECT_ENABLE

See Also:

Constant Field Values

EFFECT_DISABLE

public static final java.lang.String EFFECT_DISABLE

See Also:

Constant Field Values

Constructor Detail

Button

public Button(java.lang.String s)

Button

public Button(java.lang.String s,
              java.lang.String style)

Button

public Button(java.lang.String s,
              ElementId elementId)

Button

public Button(java.lang.String s,
              ElementId elementId,
              java.lang.String style)

Button

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

Method Detail

initializeDefaultStyles

public static void initializeDefaultStyles(Attributes attrs)

addCommands

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

getCommands

public java.util.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 java.util.List<Command<? super Button>> getClickCommands()

setButtonCommands

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

setColor

@StyleAttribute(value="color")
public void setColor(com.jme3.math.ColorRGBA color)

Overrides:

setColor in class Label

getColor

public com.jme3.math.ColorRGBA getColor()

Overrides:

getColor in class Label

setShadowColor

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

Overrides:

setShadowColor in class Label

getShadowColor

public com.jme3.math.ColorRGBA getShadowColor()

Overrides:

getShadowColor in class Label

setHighlightColor

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

getHighlightColor

public com.jme3.math.ColorRGBA getHighlightColor()

setHighlightShadowColor

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

getHighlightShadowColor

public com.jme3.math.ColorRGBA getHighlightShadowColor()

setFocusColor

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

getFocusColor

public com.jme3.math.ColorRGBA getFocusColor()

setFocusShadowColor

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

getFocusShadowColor

public com.jme3.math.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 java.lang.String toString()

Overrides:

toString in class Label