Package space.maxus.flare.ui.compose

Interface GoBackButton

All Superinterfaces:

Composable, ComposableLike, Configurable<GoBackButton>, Disable

public interface GoBackButton
extends Disable, Composable, Configurable<GoBackButton>

A button that takes player to previously opened frame. Only renders if it exists.
See more in Flare docs: Go Back Button

Nested Class Summary

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 GoBackButton	create()	Returns a default go back item
static @NotNull ItemProvider	goBackItem(org.bukkit.entity.HumanEntity player)	Returns a default go back item
static ItemStackBuilder	goBackItemBuilder(@Nullable Frame frame)	Returns the default builder for go back button

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

asComposable, bind, click, context, contextOrNull, destroy, drag, injectRoot, inside, into, leftClick, markDirty, renderAt, 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

Method Details

goBackItemBuilder

static ItemStackBuilder goBackItemBuilder(@Nullable
 @Nullable Frame frame)

Returns the default builder for go back button

Parameters:

frame - The previous frame

Returns:

The default builder for go back button

goBackItem

@Contract(pure=true)
@NotNull
static @NotNull ItemProvider goBackItem(org.bukkit.entity.HumanEntity player)

Returns a default go back item

Parameters:

player - Player for whom to build this button

Returns:

Default go back button

create

@Contract(" -> new")
@NotNull
static @NotNull GoBackButton create()

Returns a default go back item

Returns:

Default go back item