Package space.maxus.flare.ui.compose

Interface Button

All Superinterfaces:

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

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

A button is a simple clickable component.
See more in Flare docs: Button

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Button.Builder	The button builder
static interface	Button.CancellingClickHandler
static interface	Button.ClickHandler

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

Configurable.Configurator<S>

Method Summary

Static Methods

Modifier and Type	Method	Description
static @NotNull Button.Builder	builder(ItemProvider item)	Creates a new button builder.
static Button.Builder	builder(ItemProvider item, boolean disabled)	Creates a new button builder.
static Button	of(ItemProvider item, Button.ClickHandler onClick)	Creates a new button

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

asComposable, bind, click, 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

disabledState, isDisabled, isNotDisabled, setDisabled

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

getProvider, renderAt

Method Details

builder

static Button.Builder builder(ItemProvider item,
 boolean disabled)

Creates a new button builder.

Parameters:

item - The item provider to use.

disabled - Whether the button should be disabled

Returns:

The builder

builder

@Contract(value="_ -> new",
          pure=true)
@NotNull
static @NotNull Button.Builder builder(ItemProvider item)

Creates a new button builder.

Parameters:

item - The item provider to use

Returns:

The builder

of

static Button of(ItemProvider item,
 Button.ClickHandler onClick)

Creates a new button

Parameters:

item - The item provider to use

onClick - The click handler

Returns:

The button