Package io.github.projectunified.craftux.button

Class ListButton

java.lang.Object

io.github.projectunified.craftux.button.MultiButton

io.github.projectunified.craftux.button.ListButton

All Implemented Interfaces:

Button, Element

public class ListButton
extends MultiButton

The button that loops through the list of child buttons

Field Summary

Fields inherited from class io.github.projectunified.craftux.button.MultiButton

buttons

Constructor Summary

Constructors

Constructor	Description
ListButton()

Method Summary

Modifier and Type	Method	Description
boolean	apply(@NotNull UUID uuid, @NotNull ActionItem actionItem)	Apply actions to the action item
boolean	isKeepCurrentIndex()	Should the button keep the current index for the unique id?
void	removeCurrentIndex(UUID uuid)	Remove the current index for the unique id
void	setKeepCurrentIndex(boolean keepCurrentIndex)	Should the button keep the current index for the unique id?
void	stop()	Stop the element.

Methods inherited from class io.github.projectunified.craftux.button.MultiButton

addButton, addButton, getButtons, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.projectunified.craftux.common.Button

apply

Constructor Details

ListButton

public ListButton()

Method Details

isKeepCurrentIndex

public boolean isKeepCurrentIndex()

Should the button keep the current index for the unique id?

Returns:

true if it should

setKeepCurrentIndex

public void setKeepCurrentIndex(boolean keepCurrentIndex)

Should the button keep the current index for the unique id?

Parameters:

keepCurrentIndex - true if it should

removeCurrentIndex

public void removeCurrentIndex(UUID uuid)

Remove the current index for the unique id

Parameters:

uuid - the unique id

apply

public boolean apply(@NotNull
 @NotNull UUID uuid,
 @NotNull
 @NotNull ActionItem actionItem)

Description copied from interface: Button

Apply actions to the action item

Parameters:

uuid - the uuid of the player

actionItem - the action item

Returns:

true if any action was applied. Can return false in a conditional case (e.g. predicate button)

stop

public void stop()

Description copied from interface: Element

Stop the element. Should be called after removing from the GUI.

Specified by:

stop in interface Element

Overrides:

stop in class MultiButton