Examples of com.badlogic.gdx.scenes.scene2d.ui.List

A list of string items.

Functionality

A list displays textual items and highlights the current selection. A {@link SelectionListener} can beregistered with the list to listen to selection changes. Items have an index in the list, the top item having the index 0.

Layout

The (preferred) width and height of a List are derrived from the bounding box around all list items. Use {@link #setPrefSize(int,int)} to programmatically change the size to your liking. In case the width and height you set are tosmall for the contained text you will see artifacts. The patch highlighting the current selection will have the width of the List, either determined as explained above or set programmatically.

Style

A List is a {@link Widget} a text rendered for each list item via a {@link BitmapFont} and {@link Color} as wellas a {@link NinePatch} highlighting the current selection and a second Color used for the text of the currently selected item.The highlighting NinePatch is rendered beneath the selected item. The style is defined via an instance of {@link ListStyle}, which can be done either programmatically or via a {@link Skin}.

A List's style definition in an XML skin file should look like this:

 {@code }

The name attribute defines the name of the style which you can later use with {@link Skin#newList(String,String[],String)}.
The fontName attribute references a {@link BitmapFont} by name, to be used for render the items
The fontColorUnselected attribute references a {@link Color} by name, to be used for render unselected items
The fontColorSelected attribute references a {@link Color} by name, to be used to render the selected item
The selected attribute references a {@link NinePatch} by name, to be used to render the highlight behind theselected item

@author mzechner