com.badlogic.gdx.scenes.scene2d.ui

Class SelectBox<T>

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.ui.Widget

com.badlogic.gdx.scenes.scene2d.ui.SelectBox<T>

All Implemented Interfaces:

Disableable, Layout

public class SelectBox<T>
extends Widget
implements Disableable

A select box (aka a drop-down list) allows a user to choose one of a number of values from a list. When inactive, the selected value is displayed. When activated, it shows the list of values that may be selected.

ChangeListener.ChangeEvent is fired when the selectbox selection changes.

The preferred size of the select box is determined by the maximum text bounds of the items and the size of the SelectBox.SelectBoxStyle.background.

Author:

mzechner, Nathan Sweet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SelectBox.SelectBoxStyle The style for a select box, see SelectBox.

Constructor Summary

Constructors

Constructor and Description
SelectBox(SelectBox.SelectBoxStyle style)
SelectBox(Skin skin)
SelectBox(Skin skin, java.lang.String styleName)

Method Summary

Modifier and Type	Method and Description
void	clearItems()
void	draw(Batch batch, float parentAlpha) If this method is overridden, the super method or Widget.validate() should be called to ensure the widget is laid out.
protected GlyphLayout	drawItem(Batch batch, BitmapFont font, T item, float x, float y, float width)
Array<T>	getItems() Returns the internal items array.
List<T>	getList() Returns the list shown when the select box is open.
int	getMaxListCount()
float	getPrefHeight()
float	getPrefWidth()
ScrollPane	getScrollPane() Returns the scroll pane containing the list that is shown when the select box is open.
T	getSelected() Returns the first selected item, or null.
int	getSelectedIndex()
ArraySelection<T>	getSelection() Get the set of selected items, useful when multiple items are selected
SelectBox.SelectBoxStyle	getStyle() Returns the select box's style.
void	hideList()
boolean	isDisabled()
void	layout() Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls Layout.invalidate() on any each child whose width or height has changed, and calls Layout.validate() on each child.
protected void	onHide(Actor selectBoxList)
protected void	onShow(Actor selectBoxList, boolean below)
void	setAlignment(int alignment) Sets the alignment of the selected item in the select box.
void	setDisabled(boolean disabled)
void	setItems(Array<T> newItems) Sets the items visible in the select box.
void	setItems(T... newItems) Set the backing Array that makes up the choices available in the SelectBox
void	setMaxListCount(int maxListCount) Set the max number of items to display when the select box is opened.
void	setScrollingDisabled(boolean y) Disables scrolling of the list shown when the select box is open.
void	setSelected(T item) Sets the selection to only the passed item, if it is a possible choice, else selects the first item.
void	setSelectedIndex(int index) Sets the selection to only the selected index.
protected void	setStage(Stage stage) Called by the framework when this actor or any parent is added to a group that is in the stage.
void	setStyle(SelectBox.SelectBoxStyle style)
void	showList()
protected java.lang.String	toString(T obj)

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Widget

getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, invalidate, invalidateHierarchy, needsLayout, pack, setFillParent, setLayoutEnabled, sizeChanged, validate

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor

act, addAction, addCaptureListener, addListener, clear, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, debug, drawDebug, drawDebugBounds, fire, firstAscendant, getActions, getCaptureListeners, getColor, getDebug, getHeight, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getStage, getTop, getTouchable, getUserObject, getWidth, getX, getX, getY, getY, getZIndex, hasActions, hasParent, hit, isAscendantOf, isDescendantOf, isTouchable, isVisible, localToAscendantCoordinates, localToParentCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, positionChanged, remove, removeAction, removeCaptureListener, removeListener, rotateBy, rotationChanged, scaleBy, scaleBy, screenToLocalCoordinates, setBounds, setColor, setColor, setDebug, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setTouchable, setUserObject, setVisible, setWidth, setX, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectBox

public SelectBox(Skin skin)

SelectBox

public SelectBox(Skin skin,
                 java.lang.String styleName)

SelectBox

public SelectBox(SelectBox.SelectBoxStyle style)

Method Detail

setMaxListCount

public void setMaxListCount(int maxListCount)

Set the max number of items to display when the select box is opened. Set to 0 (the default) to display as many as fit in the stage height.

getMaxListCount

public int getMaxListCount()

Returns:

Max number of items to display when the box is opened, or <= 0 to display them all.

setStage

protected void setStage(Stage stage)

Description copied from class: Actor

Called by the framework when this actor or any parent is added to a group that is in the stage.

Overrides:

setStage in class Actor

Parameters:

stage - May be null if the actor or any parent is no longer in a stage.

setStyle

public void setStyle(SelectBox.SelectBoxStyle style)

getStyle

public SelectBox.SelectBoxStyle getStyle()

Returns the select box's style. Modifying the returned style may not have an effect until setStyle(SelectBoxStyle) is called.

setItems

public void setItems(T... newItems)

Set the backing Array that makes up the choices available in the SelectBox

setItems

public void setItems(Array<T> newItems)

Sets the items visible in the select box.

clearItems

public void clearItems()

getItems

public Array<T> getItems()

Returns the internal items array. If modified, setItems(Array) must be called to reflect the changes.

layout

public void layout()

Description copied from interface: Layout

Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls Layout.invalidate() on any each child whose width or height has changed, and calls Layout.validate() on each child. This method should almost never be called directly, instead Layout.validate() should be used.

Specified by:

layout in interface Layout

Overrides:

layout in class Widget

draw

public void draw(Batch batch,
                 float parentAlpha)

Description copied from class: Widget

If this method is overridden, the super method or Widget.validate() should be called to ensure the widget is laid out.

Overrides:

draw in class Widget

parentAlpha - Should be multiplied with the actor's alpha, allowing a parent's alpha to affect all children.

drawItem

protected GlyphLayout drawItem(Batch batch,
                               BitmapFont font,
                               T item,
                               float x,
                               float y,
                               float width)

setAlignment

public void setAlignment(int alignment)

Sets the alignment of the selected item in the select box. See getList() and List.setAlignment(int) to set the alignment in the list shown when the select box is open.

Parameters:

alignment - See Align.

getSelection

public ArraySelection<T> getSelection()

Get the set of selected items, useful when multiple items are selected

Returns:

a Selection object containing the selected elements

getSelected

public T getSelected()

Returns the first selected item, or null. For multiple selections use getSelection().

setSelected

public void setSelected(T item)

Sets the selection to only the passed item, if it is a possible choice, else selects the first item.

getSelectedIndex

public int getSelectedIndex()

Returns:

The index of the first selected item. The top item has an index of 0. Nothing selected has an index of -1.

setSelectedIndex

public void setSelectedIndex(int index)

Sets the selection to only the selected index.

setDisabled

public void setDisabled(boolean disabled)

Specified by:

setDisabled in interface Disableable

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface Disableable

getPrefWidth

public float getPrefWidth()

Specified by:

getPrefWidth in interface Layout

Overrides:

getPrefWidth in class Widget

getPrefHeight

public float getPrefHeight()

Specified by:

getPrefHeight in interface Layout

Overrides:

getPrefHeight in class Widget

toString

protected java.lang.String toString(T obj)

showList

public void showList()

hideList

public void hideList()

getList

public List<T> getList()

Returns the list shown when the select box is open.

setScrollingDisabled

public void setScrollingDisabled(boolean y)

Disables scrolling of the list shown when the select box is open.

getScrollPane

public ScrollPane getScrollPane()

Returns the scroll pane containing the list that is shown when the select box is open.

onShow

protected void onShow(Actor selectBoxList,
                      boolean below)

onHide

protected void onHide(Actor selectBoxList)