Modifier and Type	Class and Description
public static class	SelectBox.SelectBoxScrollPane<T> The scroll pane shown when a select box is open.
public static class	SelectBox.SelectBoxStyle The style for a select box, see `SelectBox`.

Modifier and Type	Field and Description
private int	alignment
private ClickListener	clickListener
pack-priv boolean	disabled
pack-priv final Array<T>	items
private float	prefHeight
private float	prefWidth
pack-priv SelectBox.SelectBoxScrollPane<T>	scrollPane
pack-priv boolean	selectedPrefWidth
pack-priv final ArraySelection<T>	selection
pack-priv SelectBox.SelectBoxStyle	style
pack-priv static final Vector2	temp

Access	Constructor and Description
public	SelectBox(Skin skin)
public	SelectBox(Skin skin, String styleName)
public	SelectBox(SelectBox.SelectBoxStyle style)

Method Summary

Modifier and Type	Method and Description
public void	clearItems()
public void	draw(Batch batch, float parentAlpha) Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.draw. If this method is overridden, the super method or `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)
protected Drawable	getBackgroundDrawable() Returns appropriate background drawable from the style based on the current select box state.
public ClickListener	getClickListener()
protected Color	getFontColor() Returns the appropriate label font color from the style based on the current button state.
public Array<T>	getItems() Returns the internal items array.
public List<T>	getList() Returns the list shown when the select box is open.
public int	getMaxListCount() Returns: Max number of items to display when the box is opened, or <= 0 to display them all.
public float	getMaxSelectedPrefWidth() Returns the pref width of the select box if the widest item was selected, for use when `setSelectedPrefWidth(boolean)` is true.
public float	getPrefHeight() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefHeight. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.
public float	getPrefWidth() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefWidth. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.
public SelectBox.SelectBoxScrollPane<T>	getScrollPane() Returns the scroll pane containing the list that is shown when the select box is open.
public T	getSelected() Returns the first selected item, or null.
public int	getSelectedIndex() Returns: The index of the first selected item.
public boolean	getSelectedPrefWidth()
public ArraySelection<T>	Returns: a Selection object containing the selected elements getSelection() Get the set of selected items, useful when multiple items are selected
public SelectBox.SelectBoxStyle	getStyle() Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle. Returns the select box's style.
public void	hideList() Deprecated Use `hideScrollPane()`.
public void	hideScrollPane()
public boolean	isDisabled() Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.isDisabled.
public boolean	isOver()
public void	layout() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.layout. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.layout. Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls `invalidate()` on any each child whose width or height has changed, and calls `validate()` on each child.
protected SelectBox.SelectBoxScrollPane<T>	newScrollPane() Allows a subclass to customize the scroll pane shown when the select box is open.
protected void	onHide(Actor scrollPane)
protected void	onShow(Actor scrollPane, boolean below)
public void	setAlignment(int See `Align`. alignment) Sets the alignment of the selected item in the select box.
public void	setDisabled(boolean disabled) Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.setDisabled.
public void	setItems(T... newItems) Set the backing Array that makes up the choices available in the SelectBox
public void	setItems(Array<T> newItems) Sets the items visible in the select box.
public void	setMaxListCount(int maxListCount) Set the max number of items to display when the select box is opened.
public void	setScrollingDisabled(boolean y) Disables scrolling of the list shown when the select box is open.
public void	setSelected(T item) Sets the selection to only the passed item, if it is a possible choice, else selects the first item.
public void	setSelectedIndex(int index) Sets the selection to only the selected index.
public void	setSelectedPrefWidth(boolean selectedPrefWidth) When true the pref width is based on the selected item.
protected void	setStage(Stage stage) Overrides com.badlogic.gdx.scenes.scene2d.Actor.setStage. Called by the framework when this actor or any ascendant is added to a group that is in the stage.
public void	setStyle(SelectBox.SelectBoxStyle style) Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle. Set the current style of the actor
public void	showList() Deprecated Use `showScrollPane()`.
public void	showScrollPane()
protected String	toString(T item)

Inherited from com.badlogic.gdx.scenes.scene2d.ui.Widget:: getMaxHeight getMaxWidth getMinHeight getMinWidth invalidate invalidateHierarchy needsLayout pack setFillParent setLayoutEnabled sizeChanged validate

Field Detail

alignment	back to summary
private int alignment

clickListener	back to summary
private ClickListener clickListener

disabled	back to summary
pack-priv boolean disabled

items	back to summary
pack-priv final Array<T> items

prefHeight	back to summary
private float prefHeight

prefWidth	back to summary
private float prefWidth

scrollPane	back to summary
pack-priv SelectBox.SelectBoxScrollPane<T> scrollPane

selectedPrefWidth	back to summary
pack-priv boolean selectedPrefWidth

selection	back to summary
pack-priv final ArraySelection<T> selection

style	back to summary
pack-priv SelectBox.SelectBoxStyle style

temp	back to summary
pack-priv static final Vector2 temp

Constructor Detail

SelectBox	back to summary
public SelectBox(Skin skin)

SelectBox	back to summary
public SelectBox(Skin skin, String styleName)

SelectBox	back to summary
public SelectBox(SelectBox.SelectBoxStyle style)

Method Detail

clearItems	back to summary
public void clearItems()

draw back to summary

draw	back to summary
public void draw(Batch batch, float parentAlpha) Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.draw. Doc from com.badlogic.gdx.scenes.scene2d.ui.Widget.draw. If this method is overridden, the super method or `validate()` should be called to ensure the widget is laid out.

public void draw(Batch batch, float parentAlpha)

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

Doc from com.badlogic.gdx.scenes.scene2d.ui.Widget.draw.

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

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

getBackgroundDrawable	back to summary
protected Drawable getBackgroundDrawable() Returns appropriate background drawable from the style based on the current select box state. Annotations @Null

getBackgroundDrawable

back to summary

protected Drawable getBackgroundDrawable()

Returns appropriate background drawable from the style based on the current select box state.

Annotations

@Null

getClickListener	back to summary
public ClickListener getClickListener()

getFontColor	back to summary
protected Color getFontColor() Returns the appropriate label font color from the style based on the current button state.

getItems	back to summary
public Array<T> getItems() Returns the internal items array. If modified, `setItems(Array)` must be called to reflect the changes.

getList	back to summary
public List<T> getList() Returns the list shown when the select box is open.

getMaxListCount	back to summary
public int getMaxListCount() Returns:int Max number of items to display when the box is opened, or <= 0 to display them all.

getMaxSelectedPrefWidth	back to summary
public float getMaxSelectedPrefWidth() Returns the pref width of the select box if the widest item was selected, for use when `setSelectedPrefWidth(boolean)` is true.

getPrefHeight	back to summary
public float getPrefHeight() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefHeight. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.

getPrefHeight

back to summary

public float getPrefHeight()

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

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.

getPrefWidth	back to summary
public float getPrefWidth() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefWidth. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.

getPrefWidth

back to summary

public float getPrefWidth()

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

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.

getScrollPane	back to summary
public SelectBox.SelectBoxScrollPane<T> getScrollPane() Returns the scroll pane containing the list that is shown when the select box is open.

getSelected back to summary

getSelected	back to summary
public T getSelected() Returns the first selected item, or null. For multiple selections use `SelectBox#getSelection()`. Annotations @Null

public T getSelected()

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

Annotations

@Null

getSelectedIndex	back to summary
public int getSelectedIndex() Returns:int The index of the first selected item. The top item has an index of 0. Nothing selected has an index of -1.

getSelectedPrefWidth	back to summary
public boolean getSelectedPrefWidth()

getSelection	back to summary
public ArraySelection<T> getSelection() Get the set of selected items, useful when multiple items are selected Returns:ArraySelection<T> a Selection object containing the selected elements

getSelection

back to summary

public ArraySelection<T> getSelection()

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

Returns:ArraySelection<T>: a Selection object containing the selected elements

getStyle back to summary

getStyle	back to summary
public SelectBox.SelectBoxStyle getStyle() Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle. Returns the select box's style. Modifying the returned style may not have an effect until `setStyle(SelectBoxStyle)` is called.

public SelectBox.SelectBoxStyle getStyle()

Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle.

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

hideList	back to summary
public void hideList() Deprecated Use `hideScrollPane()`. Annotations @Deprecated

hideScrollPane	back to summary
public void hideScrollPane()

isDisabled	back to summary
public boolean isDisabled() Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.isDisabled.

isOver	back to summary
public boolean isOver()

layout back to summary

layout	back to summary
public void layout() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.layout. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.layout. Doc from com.badlogic.gdx.scenes.scene2d.utils.Layout.layout. Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls `invalidate()` on any each child whose width or height has changed, and calls `validate()` on each child. This method should almost never be called directly, instead `validate()` should be used.

public void layout()

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

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.layout.

Doc from com.badlogic.gdx.scenes.scene2d.utils.Layout.layout.

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

newScrollPane	back to summary
protected SelectBox.SelectBoxScrollPane<T> newScrollPane() Allows a subclass to customize the scroll pane shown when the select box is open.

onHide	back to summary
protected void onHide(Actor scrollPane)

onShow	back to summary
protected void onShow(Actor scrollPane, boolean below)

setAlignment back to summary

setAlignment	back to summary
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:int See `Align`.

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:int: See Align.

setDisabled	back to summary
public void setDisabled(boolean disabled) Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.setDisabled.

setItems	back to summary
public void setItems(T... newItems) Set the backing Array that makes up the choices available in the SelectBox

setItems	back to summary
public void setItems(Array<T> newItems) Sets the items visible in the select box.

setMaxListCount	back to summary
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.

setScrollingDisabled	back to summary
public void setScrollingDisabled(boolean y) Disables scrolling of the list shown when the select box is open.

setSelected	back to summary
public void setSelected(T item) Sets the selection to only the passed item, if it is a possible choice, else selects the first item.

setSelectedIndex	back to summary
public void setSelectedIndex(int index) Sets the selection to only the selected index.

setSelectedPrefWidth	back to summary
public void setSelectedPrefWidth(boolean selectedPrefWidth) When true the pref width is based on the selected item.

setStage

back to summary

protected void setStage(Stage stage)

Overrides com.badlogic.gdx.scenes.scene2d.Actor.setStage.

Doc from com.badlogic.gdx.scenes.scene2d.Actor.setStage.

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

setStyle

back to summary

public void setStyle(SelectBox.SelectBoxStyle style)

Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle.

Doc from com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle.

Set the current style of the actor

showList	back to summary
public void showList() Deprecated Use `showScrollPane()`. Annotations @Deprecated

showScrollPane	back to summary
public void showScrollPane()

toString	back to summary
protected String toString(T item)

com.badlogic.gdx.scenes.scene2d.ui back to summary

public Class SelectBox.SelectBoxScrollPane<T>

Class Inheritance

extends ScrollPane

java.lang.Object
com.badlogic.gdx.scenes.scene2d.Actor
com.badlogic.gdx.scenes.scene2d.Group
com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup
com.badlogic.gdx.scenes.scene2d.ui.ScrollPane
com.badlogic.gdx.scenes.scene2d.ui.SelectBox.SelectBoxScrollPane

The scroll pane shown when a select box is open.

Author: Nathan Sweet

Field Summary

Modifier and Type	Field and Description
private InputListener	hideListener
pack-priv final List<T>	list
pack-priv int	maxListCount
private Actor	previousScrollFocus
pack-priv final SelectBox<T>	selectBox
private final Vector2	stagePosition

Constructor Summary

Access	Constructor and Description
public	SelectBoxScrollPane(final SelectBox<T> selectBox)

Method Summary

Modifier and Type	Method and Description
public void	act(float delta) Overrides com.badlogic.gdx.scenes.scene2d.ui.ScrollPane.act. Updates the actor based on time.
public void	draw(Batch batch, float parentAlpha) Overrides com.badlogic.gdx.scenes.scene2d.ui.ScrollPane.draw. If this method is overridden, the super method or `validate()` should be called to ensure the widget group is laid out.
public List<T>	getList()
public SelectBox<T>	getSelectBox()
public void	hide()
protected List<T>	newList() Allows a subclass to customize the select box list.
protected void	setStage(Stage stage) Overrides com.badlogic.gdx.scenes.scene2d.Group.setStage. Called by the framework when this actor or any ascendant is added to a group that is in the stage.
public void	show(Stage stage)

Inherited from com.badlogic.gdx.scenes.scene2d.ui.ScrollPane:: addActor addActorAfter addActorAt addActorBefore addCaptureListener addScrollListener cancel cancelTouchFocus clamp drawDebug drawScrollBars fling getActor getFadeScrollBars getFlickScrollListener getMaxX getMaxY getMinHeight getMinWidth getMouseWheelX getMouseWheelY getOverscrollDistance getPrefHeight getPrefWidth getScrollBarHeight getScrollBarWidth getScrollHeight getScrollPercentX getScrollPercentY getScrollWidth getScrollX getScrollY getStyle getVariableSizeKnobs getVelocityX getVelocityY getVisualScrollPercentX getVisualScrollPercentY getVisualScrollX getVisualScrollY getWidget hit isBottomEdge isDragging isFlinging isForceScrollX isForceScrollY isLeftEdge isPanning isRightEdge isScrollingDisabledX isScrollingDisabledY isScrollX isScrollY isTopEdge layout removeActor removeActor removeActorAt scrollTo scrollTo scrollX scrollY setActor setCancelTouchFocus setClamp setFadeScrollBars setFlickScroll setFlickScrollTapSquareSize setFlingTime setForceScroll setOverscroll setScrollBarPositions setScrollbarsOnTop setScrollbarsVisible setScrollBarTouch setScrollingDisabled setScrollPercentX setScrollPercentY setScrollX setScrollY setSmoothScrolling setStyle setupFadeScrollBars setupOverscroll setVariableSizeKnobs setVelocityX setVelocityY setWidget smoothScroll updateVisualScroll visualScrollX visualScrollY

Field Detail

hideListener	back to summary
private InputListener hideListener

list	back to summary
pack-priv final List<T> list

maxListCount	back to summary
pack-priv int maxListCount

previousScrollFocus	back to summary
private Actor previousScrollFocus

selectBox	back to summary
pack-priv final SelectBox<T> selectBox

stagePosition	back to summary
private final Vector2 stagePosition

Constructor Detail

SelectBoxScrollPane	back to summary
public SelectBoxScrollPane(final SelectBox<T> selectBox)

Method Detail

act back to summary

public void act(float delta)

Overrides com.badlogic.gdx.scenes.scene2d.ui.ScrollPane.act.

Doc from com.badlogic.gdx.scenes.scene2d.Actor.act.

Updates the actor based on time. Typically this is called each frame by Stage#act(float).

The default implementation calls Action#act(float) on each action and removes actions that are complete.

draw back to summary

public void draw(Batch batch, float parentAlpha)

Overrides com.badlogic.gdx.scenes.scene2d.ui.ScrollPane.draw.

Doc from com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.draw.

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

getList	back to summary
public List<T> getList()

getSelectBox	back to summary
public SelectBox<T> getSelectBox()

hide	back to summary
public void hide()

newList	back to summary
protected List<T> newList() Allows a subclass to customize the select box list. The default implementation returns a list that delegates `List#toString(Object)` to `SelectBox#toString(Object)`.

setStage

back to summary

protected void setStage(Stage stage)

Overrides com.badlogic.gdx.scenes.scene2d.Group.setStage.

Doc from com.badlogic.gdx.scenes.scene2d.Actor.setStage.

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

show	back to summary
public void show(Stage stage)

com.badlogic.gdx.scenes.scene2d.ui back to summary

public Class SelectBox.SelectBoxStyle

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.scenes.scene2d.ui.SelectBox.SelectBoxStyle

The style for a select box, see SelectBox.

Authors: mzechner, Nathan Sweet

Field Summary

Modifier and Type	Field and Description
public Drawable	background
public Drawable	backgroundDisabled
public Drawable	backgroundOpen
public Drawable	backgroundOver
public Color	disabledFontColor
public BitmapFont	font
public Color	fontColor
public List.ListStyle	listStyle
public Color	overFontColor
public ScrollPane.ScrollPaneStyle	scrollStyle

Constructor Summary

Access	Constructor and Description
public	SelectBoxStyle()
public	SelectBoxStyle(BitmapFont font, Color fontColor, Drawable background, ScrollPane.ScrollPaneStyle scrollStyle, List.ListStyle listStyle)
public	SelectBoxStyle(SelectBox.SelectBoxStyle style)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

background	back to summary
public Drawable background Annotations @Null

backgroundDisabled	back to summary
public Drawable backgroundDisabled Annotations @Null

backgroundOpen	back to summary
public Drawable backgroundOpen Annotations @Null

backgroundOver	back to summary
public Drawable backgroundOver Annotations @Null

disabledFontColor	back to summary
public Color disabledFontColor Annotations @Null

font	back to summary
public BitmapFont font

fontColor	back to summary
public Color fontColor

listStyle	back to summary
public List.ListStyle listStyle

overFontColor	back to summary
public Color overFontColor Annotations @Null

scrollStyle	back to summary
public ScrollPane.ScrollPaneStyle scrollStyle

Constructor Detail

SelectBoxStyle	back to summary
public SelectBoxStyle()

SelectBoxStyle	back to summary
public SelectBoxStyle(BitmapFont font, Color fontColor, Drawable background, ScrollPane.ScrollPaneStyle scrollStyle, List.ListStyle listStyle)

SelectBoxStyle	back to summary
public SelectBoxStyle(SelectBox.SelectBoxStyle style)

public Class SelectBox<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class SelectBox.SelectBoxScrollPane<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class SelectBox.SelectBoxStyle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail