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

Interface Tabulation

All Superinterfaces:

Composable, ComposableLike, Configurable<Tabulation>

public interface Tabulation
extends Composable, Configurable<Tabulation>

Tabulation is used to display pagination state.
See more in Flare docs: Tabulation

Nested Class Summary

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

Configurable.Configurator<S>

Method Summary

Modifier and Type	Method	Description
Pagination<?>	getPagination()	Returns bound pagination
static @NotNull Tabulation	of(Pagination<?> pagination)	Constructs a new tabulation
static @NotNull Tabulation	of(Pagination<?> pagination, int idx)	Constructs a new tabulation
static @NotNull Tabulation	of(Pagination<?> pagination, @Nullable org.apache.commons.lang3.concurrent.Computable<org.apache.commons.lang3.tuple.Pair<Integer,Frame>,org.bukkit.inventory.ItemStack> selected, @Nullable org.apache.commons.lang3.concurrent.Computable<org.apache.commons.lang3.tuple.Pair<Integer,Frame>,org.bukkit.inventory.ItemStack> unselected, int idx)	Constructs a new tabulation
ReactiveState<Frame>	selectedFrame()	Returns selected page frame state
ReactiveState<Integer>	selectedIndex()	Returns selected page index state
static ItemStackBuilder	selectedItemBuilder(int idx, Frame frame)	Returns the selected item builder
default void	switchPage(int page)	Switches current page to the given page
static ItemStackBuilder	unselectedItemBuilder(int idx, Frame frame)	Returns the unselected item builder

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

Method Details

unselectedItemBuilder

static ItemStackBuilder unselectedItemBuilder(int idx,
 Frame frame)

Returns the unselected item builder

Parameters:

idx - The page index

frame - The page frame

Returns:

Unselected item builder

selectedItemBuilder

static ItemStackBuilder selectedItemBuilder(int idx,
 Frame frame)

Returns the selected item builder

Parameters:

idx - The page index

frame - The page frame

Returns:

Selected item builder

of

@NotNull
static @NotNull Tabulation of(Pagination<?> pagination)

Constructs a new tabulation

Parameters:

pagination - The pagination to use

Returns:

Constructed tabulation

of

@NotNull
static @NotNull Tabulation of(Pagination<?> pagination,
 int idx)

Constructs a new tabulation

Parameters:

pagination - The pagination to use

idx - Currently selected page index

Returns:

Constructed tabulation

of

@NotNull
static @NotNull Tabulation of(Pagination<?> pagination,
 @Nullable
 @Nullable org.apache.commons.lang3.concurrent.Computable<org.apache.commons.lang3.tuple.Pair<Integer,Frame>,org.bukkit.inventory.ItemStack> selected,
 @Nullable
 @Nullable org.apache.commons.lang3.concurrent.Computable<org.apache.commons.lang3.tuple.Pair<Integer,Frame>,org.bukkit.inventory.ItemStack> unselected,
 int idx)

Constructs a new tabulation

Parameters:

pagination - The pagination to use

selected - Builder for selected page button

unselected - Builder for unselected page button

idx - Currently selected page index

Returns:

Constructed tabulation

getPagination

Pagination<?> getPagination()

Returns bound pagination

Returns:

Bound pagination

selectedIndex

ReactiveState<Integer> selectedIndex()

Returns selected page index state

Returns:

Selected page index state

selectedFrame

ReactiveState<Frame> selectedFrame()

Returns selected page frame state

Returns:

Selected page frame state

switchPage

default void switchPage(int page)

Switches current page to the given page

Parameters:

page - Page index to switch to