Modifier and Type	Class and Description
public static class	List.ListStyle The style for a list, see `List`.

Modifier and Type	Field and Description
private int	alignment
private Rectangle	cullingArea
pack-priv float	itemHeight
pack-priv final Array<T>	items
private InputListener	keyListener
pack-priv int	overIndex
private float	prefHeight
private float	prefWidth
pack-priv int	pressedIndex
pack-priv ArraySelection<T>	selection
pack-priv List.ListStyle	style
pack-priv boolean	typeToSelect

Access	Constructor and Description
public	List(Skin skin)
public	List(Skin skin, String styleName)
public	List(List.ListStyle 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 void	drawBackground(Batch batch, float parentAlpha) Called to draw the background.
protected GlyphLayout	drawItem(Batch batch, BitmapFont font, int index, T item, float x, float y, float width)
protected void	drawSelection(Batch batch, Drawable drawable, float x, float y, float width, float height)
public int	getAlignment()
public Rectangle	getCullingArea() Returns: May be null.
public T	getItemAt(float y) Returns: null if not over an item.
public float	getItemHeight()
public int	getItemIndexAt(float y) Returns: -1 if not over an item.
public Array<T>	getItems() Returns the internal items array.
public InputListener	getKeyListener()
public T	getOverItem() Returns: May be null.
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 T	getPressedItem() Returns: May be null.
public T	getSelected() Returns the first selected item, or null.
public int	getSelectedIndex() Returns: The index of the first selected item.
public ArraySelection<T>	getSelection()
public List.ListStyle	getStyle() Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle. Returns the list's style.
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.
public void	setAlignment(int See `Align`. alignment) Sets the horizontal alignment of the list items.
public void	setCullingArea(Rectangle cullingArea) Implements com.badlogic.gdx.scenes.scene2d.utils.Cullable.setCullingArea.
public void	setItems(T... newItems)
public void	setItems(Array<T> newItems) Sets the items visible in the list, clearing the selection if it is no longer valid.
public void	setSelected(T May be null. item) Sets the selection to only the passed item, if it is a possible choice.
public void	setSelectedIndex(int -1 to clear the selection. index) Sets the selection to only the selected index.
public void	setSelection(ArraySelection<T> selection)
public void	setStyle(List.ListStyle style) Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle. Set the current style of the actor
public void	setTypeToSelect(boolean typeToSelect)
public String	toString(T object)

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

cullingArea	back to summary
private Rectangle cullingArea

itemHeight	back to summary
pack-priv float itemHeight

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

keyListener	back to summary
private InputListener keyListener

overIndex	back to summary
pack-priv int overIndex

prefHeight	back to summary
private float prefHeight

prefWidth	back to summary
private float prefWidth

pressedIndex	back to summary
pack-priv int pressedIndex

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

style	back to summary
pack-priv List.ListStyle style

typeToSelect	back to summary
pack-priv boolean typeToSelect

Constructor Detail

List	back to summary
public List(Skin skin)

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

List	back to summary
public List(List.ListStyle 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.

drawBackground	back to summary
protected void drawBackground(Batch batch, float parentAlpha) Called to draw the background. Default implementation draws the style background drawable.

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

drawSelection	back to summary
protected void drawSelection(Batch batch, Drawable drawable, float x, float y, float width, float height)

getAlignment	back to summary
public int getAlignment()

getCullingArea	back to summary
public Rectangle getCullingArea() Returns:Rectangle May be null. See Also `setCullingArea(Rectangle)`

getItemAt	back to summary
public T getItemAt(float y) Returns:T null if not over an item. Annotations @Null

getItemHeight	back to summary
public float getItemHeight()

getItemIndexAt	back to summary
public int getItemIndexAt(float y) Returns:int -1 if not over an item.

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

getKeyListener	back to summary
public InputListener getKeyListener()

getOverItem	back to summary
public T getOverItem() Returns:T May be null.

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.

getPressedItem	back to summary
public T getPressedItem() Returns:T May be null.

getSelected	back to summary
public T getSelected() Returns the first selected item, or null. Annotations @Null

getSelected

back to summary

public T getSelected()

Returns the first selected item, or null.

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.

getSelection	back to summary
public ArraySelection<T> getSelection()

getStyle back to summary

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

public List.ListStyle getStyle()

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

Returns the list's style. Modifying the returned style may not have an effect until setStyle(ListStyle) is called.

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.

setAlignment back to summary

setAlignment	back to summary
public void setAlignment(int alignment) Sets the horizontal alignment of the list items. Parameters alignment:int See `Align`.

public void setAlignment(int alignment)

Sets the horizontal alignment of the list items.

Parameters

alignment:int: See Align.

setCullingArea	back to summary
public void setCullingArea(Rectangle cullingArea) Implements com.badlogic.gdx.scenes.scene2d.utils.Cullable.setCullingArea.

setItems	back to summary
public void setItems(T... newItems)

setItems	back to summary
public void setItems(Array<T> newItems) Sets the items visible in the list, clearing the selection if it is no longer valid. If a selection is `ArraySelection#getRequired()`, the first item is selected. This can safely be called with a (modified) array returned from `getItems()`.

setSelected	back to summary
public void setSelected(T item) Sets the selection to only the passed item, if it is a possible choice. Parameters item:T May be null.

setSelected

back to summary

public void setSelected(T item)

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

Parameters

item:T: May be null.

setSelectedIndex	back to summary
public void setSelectedIndex(int index) Sets the selection to only the selected index. Parameters index:int -1 to clear the selection.

setSelectedIndex

back to summary

public void setSelectedIndex(int index)

Sets the selection to only the selected index.

Parameters

index:int: -1 to clear the selection.

setSelection	back to summary
public void setSelection(ArraySelection<T> selection)

setStyle	back to summary
public void setStyle(List.ListStyle 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

setStyle

back to summary

public void setStyle(List.ListStyle 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

setTypeToSelect	back to summary
public void setTypeToSelect(boolean typeToSelect)

toString	back to summary
public String toString(T object)

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

public Class List.ListStyle

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.scenes.scene2d.ui.List.ListStyle

The style for a list, see List.

Authors: mzechner, Nathan Sweet

Field Summary

Modifier and Type	Field and Description
public Drawable	background
public Drawable	down
public BitmapFont	font
public Color	fontColorSelected
public Color	fontColorUnselected
public Drawable	over
public Drawable	selection

Constructor Summary

Access	Constructor and Description
public	ListStyle()
public	ListStyle(BitmapFont font, Color fontColorSelected, Color fontColorUnselected, Drawable selection)
public	ListStyle(List.ListStyle 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

down	back to summary
public Drawable down Annotations @Null

font	back to summary
public BitmapFont font

fontColorSelected	back to summary
public Color fontColorSelected

fontColorUnselected	back to summary
public Color fontColorUnselected

over	back to summary
public Drawable over Annotations @Null

selection	back to summary
public Drawable selection

Constructor Detail

ListStyle	back to summary
public ListStyle()

ListStyle	back to summary
public ListStyle(BitmapFont font, Color fontColorSelected, Color fontColorUnselected, Drawable selection)

ListStyle	back to summary
public ListStyle(List.ListStyle style)

public Class List<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class List.ListStyle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail