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:

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

public class ListBox<T>
extends com.simsilica.lemur.Panel

Nested Class Summary

Nested Classes

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

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	CONTAINER_ID
static java.lang.String	EFFECT_ACTIVATE
static java.lang.String	EFFECT_CLICK
static java.lang.String	EFFECT_DEACTIVATE
static java.lang.String	EFFECT_PRESS
static java.lang.String	EFFECT_RELEASE
static java.lang.String	ELEMENT_ID
static java.lang.String	ITEMS_ID
static java.lang.String	SELECTOR_ID
static java.lang.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_LIGHTLIST, RF_MATPARAM_OVERRIDE, RF_TRANSFORM, shadowMode, userData, worldBound, worldLights, worldOverrides, worldTransform

Constructor Summary

Constructors

Modifier	Constructor and Description
	ListBox()
protected	ListBox(boolean applyStyles, VersionedList<T> model, ValueRenderer<T> cellRenderer, SelectionModel selection, com.simsilica.lemur.style.ElementId elementId, java.lang.String style)
	ListBox(VersionedList<T> model)
	ListBox(VersionedList<T> model, com.simsilica.lemur.style.ElementId elementId, java.lang.String style)
	ListBox(VersionedList<T> model, java.lang.String style)
	ListBox(VersionedList<T> model, ValueRenderer<T> renderer, com.simsilica.lemur.style.ElementId elementId, java.lang.String style)
	ListBox(VersionedList<T> model, ValueRenderer<T> renderer, java.lang.String style)

Method Summary

Modifier and Type	Method and Description
protected void	activate()
void	addClickCommands(com.simsilica.lemur.Command<? super ListBox>... commands)
void	addCommands(ListBox.ListAction a, com.simsilica.lemur.Command<? super ListBox>... commands)
protected void	deactivate()
protected void	detachItemListeners() Used when the list model is swapped out.
ValueRenderer<T>	getCellRenderer()
java.util.List<com.simsilica.lemur.Command<? super ListBox>>	getClickCommands()
java.util.List<com.simsilica.lemur.Command<? super ListBox>>	getCommands(ListBox.ListAction a)
GridPanel	getGridPanel()
protected com.simsilica.lemur.Panel	getListCell(int row, int col, com.simsilica.lemur.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()
com.simsilica.lemur.Slider	getSlider()
int	getVisibleItems()
protected void	gridResized(com.jme3.math.Vector3f pos, com.jme3.math.Vector3f size)
static void	initializeDefaultStyles(com.simsilica.lemur.style.Styles styles, com.simsilica.lemur.style.Attributes attrs)
protected void	refreshActivation()
protected void	refreshSelector()
void	removeClickCommands(com.simsilica.lemur.Command<? super ListBox>... commands)
protected void	resetModelRange()
protected void	scroll(int amount)
void	setAlpha(float alpha, boolean recursive)
void	setCellRenderer(ValueRenderer<T> renderer)
void	setListCommands(java.util.Map<ListBox.ListAction,java.util.List<com.simsilica.lemur.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	setSelectionModel(SelectionModel selection)
void	setVisibleItems(int count)
java.lang.String	toString()
void	updateLogicalState(float tpf)

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

CONTAINER_ID

public static final java.lang.String CONTAINER_ID

See Also:

Constant Field Values

ITEMS_ID

public static final java.lang.String ITEMS_ID

See Also:

Constant Field Values

SLIDER_ID

public static final java.lang.String SLIDER_ID

See Also:

Constant Field Values

SELECTOR_ID

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

Constructor Detail

ListBox

public ListBox()

ListBox

public ListBox(VersionedList<T> model)

ListBox

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

ListBox

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

ListBox

public ListBox(VersionedList<T> model,
               com.simsilica.lemur.style.ElementId elementId,
               java.lang.String style)

ListBox

public ListBox(VersionedList<T> model,
               ValueRenderer<T> renderer,
               com.simsilica.lemur.style.ElementId elementId,
               java.lang.String style)

ListBox

protected ListBox(boolean applyStyles,
                  VersionedList<T> model,
                  ValueRenderer<T> cellRenderer,
                  SelectionModel selection,
                  com.simsilica.lemur.style.ElementId elementId,
                  java.lang.String style)

Method Detail

initializeDefaultStyles

public static void initializeDefaultStyles(com.simsilica.lemur.style.Styles styles,
                                           com.simsilica.lemur.style.Attributes attrs)

updateLogicalState

public void updateLogicalState(float tpf)

Overrides:

updateLogicalState in class com.jme3.scene.Node

gridResized

protected void gridResized(com.jme3.math.Vector3f pos,
                           com.jme3.math.Vector3f size)

setModel

public void setModel(VersionedList<T> model)

getModel

public VersionedList<T> getModel()

getSlider

public com.simsilica.lemur.Slider getSlider()

getGridPanel

public GridPanel getGridPanel()

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.

addCommands

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

getCommands

public java.util.List<com.simsilica.lemur.Command<? super ListBox>> getCommands(ListBox.ListAction a)

addClickCommands

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

removeClickCommands

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

getClickCommands

public java.util.List<com.simsilica.lemur.Command<? super ListBox>> getClickCommands()

setListCommands

@StyleAttribute(value="listCommands")
public void setListCommands(java.util.Map<ListBox.ListAction,java.util.List<com.simsilica.lemur.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)

Overrides:

setAlpha in class com.simsilica.lemur.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 com.simsilica.lemur.Panel getListCell(int row,
                                                int col,
                                                com.simsilica.lemur.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 java.lang.String toString()

Overrides:

toString in class com.simsilica.lemur.Panel