Package com.simsilica.lemur

Class ListBox<T>

java.lang.Object

com.jme3.scene.Spatial

com.jme3.scene.Node

com.simsilica.lemur.Panel

com.simsilica.lemur.ListBox<T>

All Implemented Interfaces:

HasLocalTransform, CloneableSmartAsset, Collidable, Savable, JmeCloneable, Cloneable

public class ListBox<T>
extends Panel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ListBox.GridModelDelegate
static enum	ListBox.ListAction

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	CONTAINER_ID
static final String	EFFECT_ACTIVATE
static final String	EFFECT_CLICK
static final String	EFFECT_DEACTIVATE
static final String	EFFECT_PRESS
static final String	EFFECT_RELEASE
static final String	ELEMENT_ID
static final String	ITEMS_ID
static final String	SELECTOR_ID
static final String	SLIDER_ID

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
	ListBox()
protected	ListBox(boolean applyStyles, VersionedList<T> model, ValueRenderer<T> cellRenderer, SelectionModel selection, ElementId elementId, String style)
	ListBox(VersionedList<T> model)
	ListBox(VersionedList<T> model, ElementId elementId, String style)
	ListBox(VersionedList<T> model, ValueRenderer<T> renderer, ElementId elementId, String style)
	ListBox(VersionedList<T> model, ValueRenderer<T> renderer, String style)
	ListBox(VersionedList<T> model, String style)

Method Summary

Modifier and Type	Method	Description
protected void	activate()
void	addClickCommands(Command<? super ListBox>... commands)
void	addCommands(ListBox.ListAction a, Command<? super ListBox>... commands)
protected void	deactivate()
protected void	detachItemListeners()	Used when the list model is swapped out.
ValueRenderer<T>	getCellRenderer()
List<Command<? super ListBox>>	getClickCommands()
List<Command<? super ListBox>>	getCommands(ListBox.ListAction a)
GridPanel	getGridPanel()
protected Panel	getListCell(int row, int col, Panel existing)
VersionedList<T>	getModel()
boolean	getScrollOnHover()
T	getSelectedItem()	Returns the currently selected list item if there is one and only one item selected.
SelectionModel	getSelectionModel()
Panel	getSelector()
Slider	getSlider()
int	getVisibleItems()
protected void	gridResized(Vector3f pos, Vector3f size)
protected void	refreshActivation()
protected void	refreshSelector()
void	removeClickCommands(Command<? super ListBox>... commands)
protected void	resetModelRange()
protected void	scroll(int amount)
void	setAlpha(float alpha, boolean recursive)	Sets the alpha multiplier for all ColoredComponents in this panels component stack, including things like QuadBackgroundComponent, TextComponent, etc..
void	setCellRenderer(ValueRenderer<T> renderer)
void	setListCommands(Map<ListBox.ListAction,List<Command<? super ListBox>>> map)
void	setModel(VersionedList<T> model)
void	setScrollOnHover(boolean f)	Set to true to enable mouse-wheel style scrolling when the mouse is hovering over the ListBox.
void	setSelectedItem(T item)	Convenience method for setting the currently selected item.
void	setSelectionModel(SelectionModel selection)
void	setVisibleItems(int count)
String	toString()	Returns the Spatial's name followed by the class of the spatial Example: "MyNode (com.jme3.scene.Spatial)"
void	updateLogicalState(float tpf)	updateLogicalState calls the update() method for all controls attached to this Spatial.

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

CONTAINER_ID

public static final String CONTAINER_ID

See Also:

• Constant Field Values

ITEMS_ID

public static final String ITEMS_ID

See Also:

• Constant Field Values

SLIDER_ID

public static final String SLIDER_ID

See Also:

• Constant Field Values

SELECTOR_ID

public static final String SELECTOR_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

Constructor Details

ListBox

public ListBox()

ListBox

public ListBox(VersionedList<T> model)

ListBox

public ListBox(VersionedList<T> model,
 ValueRenderer<T> renderer,
 String style)

ListBox

public ListBox(VersionedList<T> model,
 String style)

ListBox

public ListBox(VersionedList<T> model,
 ElementId elementId,
 String style)

ListBox

public ListBox(VersionedList<T> model,
 ValueRenderer<T> renderer,
 ElementId elementId,
 String style)

ListBox

protected ListBox(boolean applyStyles,
 VersionedList<T> model,
 ValueRenderer<T> cellRenderer,
 SelectionModel selection,
 ElementId elementId,
 String style)

Method Details

updateLogicalState

public void updateLogicalState(float tpf)

Description copied from class: Spatial

updateLogicalState calls the update() method for all controls attached to this Spatial.

Overrides:

updateLogicalState in class Node

Parameters:

tpf - Time per frame.

See Also:

• Spatial.addControl(com.jme3.scene.control.Control)

gridResized

protected void gridResized(Vector3f pos,
 Vector3f size)

setModel

public void setModel(VersionedList<T> model)

getModel

public VersionedList<T> getModel()

getSlider

public Slider getSlider()

getGridPanel

public GridPanel getGridPanel()

getSelector

public Panel getSelector()

setSelectionModel

public void setSelectionModel(SelectionModel selection)

getSelectionModel

public SelectionModel getSelectionModel()

getSelectedItem

public T getSelectedItem()

Returns the currently selected list item if there is one and only one item selected. This is a convenience method that interrogates the selection model and looks up the current value in the list model.

setSelectedItem

public void setSelectedItem(T item)

Convenience method for setting the currently selected item.

addCommands

public void addCommands(ListBox.ListAction a,
 Command<? super ListBox>... commands)

getCommands

public List<Command<? super ListBox>> getCommands(ListBox.ListAction a)

addClickCommands

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

removeClickCommands

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

getClickCommands

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

setListCommands

@StyleAttribute("listCommands")
public void setListCommands(Map<ListBox.ListAction,List<Command<? super ListBox>>> map)

setVisibleItems

@StyleAttribute(value="visibleItems",
                lookupDefault=false)
public void setVisibleItems(int count)

getVisibleItems

public int getVisibleItems()

setCellRenderer

@StyleAttribute(value="cellRenderer",
                lookupDefault=false)
public void setCellRenderer(ValueRenderer<T> renderer)

getCellRenderer

public ValueRenderer<T> getCellRenderer()

setAlpha

public void setAlpha(float alpha,
 boolean recursive)

Description copied from class: Panel

Sets the alpha multiplier for all ColoredComponents in this panels component stack, including things like QuadBackgroundComponent, TextComponent, etc.. This can be used to generally fade a GUI element in or out as needed as long as its visuals are ColoredComponent compliant. If recursive is true then all child Spatials will also be checked and have their alpha set, and their children, and so on.

Overrides:

setAlpha in class Panel

setScrollOnHover

@StyleAttribute(value="scrollOnHover",
                lookupDefault=false)
public void setScrollOnHover(boolean f)

Set to true to enable mouse-wheel style scrolling when the mouse is hovering over the ListBox. (Versus only when the list has focus.) Default is true.

getScrollOnHover

public boolean getScrollOnHover()

refreshSelector

protected void refreshSelector()

resetModelRange

protected void resetModelRange()

refreshActivation

protected void refreshActivation()

getListCell

protected Panel getListCell(int row,
 int col,
 Panel existing)

detachItemListeners

protected void detachItemListeners()

Used when the list model is swapped out.

scroll

protected void scroll(int amount)

activate

protected void activate()

deactivate

protected void deactivate()

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 Panel

Returns:

Spatial's name followed by the class of the Spatial