Package space.maxus.flare.ui.compose

Interface Checkbox

All Superinterfaces:

Composable, ComposableLike, Configurable<Checkbox>, Disable, ProviderRendered

public interface Checkbox
extends Disable, ProviderRendered, Configurable<Checkbox>

A checkbox is a clickable component that is toggled on click.
See more in Flare docs: Checkbox

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Checkbox.Builder

Nested classes/interfaces inherited from interface space.maxus.flare.ui.compose.Configurable

Configurable.Configurator<S>

Method Summary

Modifier and Type	Method	Description
static @NotNull Checkbox.Builder	builder()	Creates a new Checkbox builder.
static @NotNull ItemStackBuilder	checkedBuilder(String message, String description)	Standard item builder for unchecked checkbox
static @NotNull ItemProvider	checkedItem(String message, String description)	Standard item provider for checked checkbox
ReactiveState<Boolean>	checkedState()	Returns the reactive toggle state of the checkbox.
void	click(@NotNull org.bukkit.event.inventory.InventoryClickEvent e)	Called each time this item is clicked, no matter if it is a right click, left click, middle click, etc.
ReactiveState<Boolean>	disabledState()	Returns the reactive disabled state of the element
default boolean	isChecked()	Gets whether the checkbox is checked.
static @NotNull Checkbox	of(ItemProvider checkedProvider, ItemProvider uncheckedProvider)	Creates a new Checkbox with the given checked and unchecked item providers.
static @NotNull Checkbox	of(ItemProvider checkedProvider, ItemProvider uncheckedProvider, boolean isChecked)	Creates a new Checkbox with the given checked and unchecked item providers.
default void	setChecked(boolean checked)	Sets whether the checkbox is checked.
default void	toggle()	Toggles the checkbox.
static @NotNull ItemStackBuilder	uncheckedBuilder(String message, String description)	Standard item builder for checked checkbox
static @NotNull ItemProvider	uncheckedItem(String message, String description)	Standard item provider for unchecked checkbox

Methods inherited from interface space.maxus.flare.ui.Composable

asComposable, bind, context, contextOrNull, destroy, drag, injectRoot, inside, into, leftClick, markDirty, restore, rightClick, root, shiftFrom, shiftInto, viewer

Methods inherited from interface space.maxus.flare.ui.compose.Configurable

configure, configureTyped

Methods inherited from interface space.maxus.flare.ui.compose.Disable

isDisabled, isNotDisabled, setDisabled

Methods inherited from interface space.maxus.flare.ui.compose.ProviderRendered

getProvider, renderAt

Method Details

checkedItem

@Contract("_, _ -> new")
@NotNull
static @NotNull ItemProvider checkedItem(String message,
 String description)

Standard item provider for checked checkbox

Parameters:

message - Message in the item name

description - Description of the item

Returns:

Standard item provider for checked checkbox

uncheckedItem

@Contract("_, _ -> new")
@NotNull
static @NotNull ItemProvider uncheckedItem(String message,
 String description)

Standard item provider for unchecked checkbox

Parameters:

message - Message in the item name

description - Description of the item

Returns:

Standard item provider for unchecked checkbox

uncheckedBuilder

@NotNull
static @NotNull ItemStackBuilder uncheckedBuilder(String message,
 String description)

Standard item builder for checked checkbox

Parameters:

message - Message in the item name

description - Description of the item

Returns:

Standard item builder for checked checkbox

checkedBuilder

@Contract("_, _ -> new")
@NotNull
static @NotNull ItemStackBuilder checkedBuilder(String message,
 String description)

Standard item builder for unchecked checkbox

Parameters:

message - Message in the item name

description - Description of the item

Returns:

Standard item builder for unchecked checkbox

builder

@Contract(value=" -> new",
          pure=true)
@NotNull
static @NotNull Checkbox.Builder builder()

Creates a new Checkbox builder.

Returns:

Checkbox builder

of

@Contract("_, _ -> new")
@NotNull
static @NotNull Checkbox of(ItemProvider checkedProvider,
 ItemProvider uncheckedProvider)

Creates a new Checkbox with the given checked and unchecked item providers.

Parameters:

checkedProvider - Item provider for checked checkbox

uncheckedProvider - Item provider for unchecked checkbox

Returns:

Checkbox with the given checked and unchecked item providers.

of

@Contract("_, _, _ -> new")
@NotNull
static @NotNull Checkbox of(ItemProvider checkedProvider,
 ItemProvider uncheckedProvider,
 boolean isChecked)

Creates a new Checkbox with the given checked and unchecked item providers.

Parameters:

checkedProvider - Item provider for checked checkbox

uncheckedProvider - Item provider for unchecked checkbox

isChecked - Whether the checkbox is toggled on by default

Returns:

Checkbox with the given checked and unchecked item providers.

click

void click(@NotNull
 @NotNull org.bukkit.event.inventory.InventoryClickEvent e)

Description copied from interface: Composable

Called each time this item is clicked, no matter if it is a right click, left click, middle click, etc.

Specified by:

click in interface Composable

Parameters:

e - The click event

toggle

default void toggle()

Toggles the checkbox.

isChecked

default boolean isChecked()

Gets whether the checkbox is checked.

Returns:

Whether the checkbox is checked.

setChecked

default void setChecked(boolean checked)

Sets whether the checkbox is checked.

Parameters:

checked - Whether the checkbox is checked.

disabledState

ReactiveState<Boolean> disabledState()

Description copied from interface: Disable

Returns the reactive disabled state of the element

Specified by:

disabledState in interface Disable

Returns:

The reactive disabled state of the element

checkedState

ReactiveState<Boolean> checkedState()

Returns the reactive toggle state of the checkbox.

Returns:

The reactive toggle state of the checkbox.