APIdia Launch Partner

Top Description Fields Constructors Methods

com.badlogic.gdx.scenes.scene2d.ui

public Class ButtonGroup<T extends Button>

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.scenes.scene2d.ui.ButtonGroup

Imports

com.badlogic.gdx.utils.Array, .Null

Manages a group of buttons to enforce a minimum and maximum number of checked buttons. This enables "radio button" functionality and more. A button may only be in one group at a time.

The canCheck(Button, boolean) method can be overridden to control if a button check or uncheck is allowed.

Author: Nathan Sweet

Field Summary

Modifier and Type	Field and Description
private final Array<T>	buttons
private Array<T>	checkedButtons
private T	lastChecked
private int	maxCheckCount
private int	minCheckCount
private boolean	uncheckLast

Constructor Summary

Access	Constructor and Description
public	ButtonGroup()
public	ButtonGroup(T... buttons)

Method Summary

Modifier and Type	Method and Description
public void	add(T button)
public void	add(T... buttons)
protected boolean	Returns: True if the new state should be allowed. canCheck(T button, boolean newState) Called when a button is checked or unchecked.
public void	clear()
public Array<T>	getAllChecked()
public Array<T>	getButtons()
public T	getChecked() Returns: The first checked button, or null.
public int	getCheckedIndex() Returns: The first checked button index, or -1.
public void	remove(T button)
public void	remove(T... buttons)
public void	setChecked(String text) Sets the first `TextButton` with the specified text to checked.
public void	setMaxCheckCount(int maxCheckCount) Sets the maximum number of buttons that can be checked.
public void	setMinCheckCount(int minCheckCount) Sets the minimum number of buttons that must be checked.
public void	setUncheckLast(boolean uncheckLast) If true, when the maximum number of buttons are checked and an additional button is checked, the last button to be checked is unchecked so that the maximum is not exceeded.
public void	uncheckAll() Sets all buttons' `Button#isChecked()` to false, regardless of `setMinCheckCount(int)`.

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

Field Detail

buttons	back to summary
private final Array<T> buttons

checkedButtons	back to summary
private Array<T> checkedButtons

lastChecked	back to summary
private T lastChecked

maxCheckCount	back to summary
private int maxCheckCount

minCheckCount	back to summary
private int minCheckCount

uncheckLast	back to summary
private boolean uncheckLast

Constructor Detail

ButtonGroup	back to summary
public ButtonGroup()

ButtonGroup	back to summary
public ButtonGroup(T... buttons)

Method Detail

add	back to summary
public void add(T button)

add	back to summary
public void add(T... buttons)

canCheck

back to summary

protected boolean canCheck(T button, boolean newState)

Called when a button is checked or unchecked. If overridden, generally changing button checked states should not be done from within this method.

Returns:boolean: True if the new state should be allowed.

clear	back to summary
public void clear()

getAllChecked	back to summary
public Array<T> getAllChecked()

getButtons	back to summary
public Array<T> getButtons()

getChecked	back to summary
public T getChecked() Returns:T The first checked button, or null. Annotations @Null

getCheckedIndex	back to summary
public int getCheckedIndex() Returns:int The first checked button index, or -1.

remove	back to summary
public void remove(T button)

remove	back to summary
public void remove(T... buttons)

setChecked	back to summary
public void setChecked(String text) Sets the first `TextButton` with the specified text to checked.

setMaxCheckCount	back to summary
public void setMaxCheckCount(int maxCheckCount) Sets the maximum number of buttons that can be checked. Set to -1 for no maximum. Default is 1.

setMinCheckCount	back to summary
public void setMinCheckCount(int minCheckCount) Sets the minimum number of buttons that must be checked. Default is 1.

setUncheckLast	back to summary
public void setUncheckLast(boolean uncheckLast) If true, when the maximum number of buttons are checked and an additional button is checked, the last button to be checked is unchecked so that the maximum is not exceeded. If false, additional buttons beyond the maximum are not allowed to be checked. Default is true.

uncheckAll	back to summary
public void uncheckAll() Sets all buttons' `Button#isChecked()` to false, regardless of `setMinCheckCount(int)`.