Package space.maxus.flare.ui.compose.complex

Interface Modal

All Superinterfaces:

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

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

A modal is a composable that opens an inner frame on click.
See more in Flare docs: Modal

See Also:

• Modals

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Modal.Builder	A builder for modals
static class	Modal.ModalFrame	The modal frame
static final record	Modal.ModalProps

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

Configurable.Configurator<S>

Method Summary

Modifier and Type	Method	Description
static @NotNull Modal.Builder	builder(@NotNull ItemProvider provider)	Constructs a new modal builder
Modal.ModalFrame	getFrame()	Returns the frame of this modal
static @NotNull Modal	of(@NotNull ItemProvider provider, Dimensions dimensions, Consumer<Modal.ModalFrame> initializer)	Constructs a new modal

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

of

@NotNull
static @NotNull Modal of(@NotNull
 @NotNull ItemProvider provider,
 Dimensions dimensions,
 Consumer<Modal.ModalFrame> initializer)

Constructs a new modal

Parameters:

provider - Item provider for modal

dimensions - Dimensions of the modal window

initializer - The modal frame configurator

Returns:

A new modal

builder

@NotNull
static @NotNull Modal.Builder builder(@NotNull
 @NotNull ItemProvider provider)

Constructs a new modal builder

Parameters:

provider - Item provider for this modal

Returns:

A new modal builder

getFrame

Modal.ModalFrame getFrame()

Returns the frame of this modal

Returns:

The frame of this modal