Package studio.mevera.lotus.api.pagination

Interface PageLayout<C,X extends AbstractPageContext<C,?,?>>

Type Parameters:

C - the title component type — Component on Paper, String on Spigot

X - the page context type supplied to layout hooks

public interface PageLayout<C,X extends AbstractPageContext<C,?,?>>

Defines the shared layout for all pages in a pagination.

Method Summary

Modifier and Type	Method	Description
static <C, X extends AbstractPageContext<C, ?, ?>> @NotNull PageLayoutBuilder<C,X>	builder(@NotNull Capacity capacity)	Creates a generic builder for the given capacity.
@NotNull Capacity	capacity()	Returns the page capacity.
default @NotNull Content	decorations(X context)	Returns the static decorations for the current page.
@NotNull SlotMask	fillMask()	Returns the slots used for page items.
@NotNull Button	nextButton(X context)	Returns the next-page button.
@NotNull Slot	nextButtonSlot()	Returns the slot used by the next-page button.
@NotNull Button	previousButton(X context)	Returns the previous-page button.
@NotNull Slot	previousButtonSlot()	Returns the slot used by the previous-page button.
C	title(X context)	Returns the title for the current page.

Method Details

capacity

@NotNull
@NotNull Capacity capacity()

Returns the page capacity.

title

@NotNull
C title(@NotNull
 X context)

Returns the title for the current page.

fillMask

@NotNull
@NotNull SlotMask fillMask()

Returns the slots used for page items.

previousButtonSlot

@NotNull
@NotNull Slot previousButtonSlot()

Returns the slot used by the previous-page button.

nextButtonSlot

@NotNull
@NotNull Slot nextButtonSlot()

Returns the slot used by the next-page button.

previousButton

@NotNull
@NotNull Button previousButton(@NotNull
 X context)

Returns the previous-page button.

nextButton

@NotNull
@NotNull Button nextButton(@NotNull
 X context)

Returns the next-page button.

decorations

@NotNull
default @NotNull Content decorations(@NotNull
 X context)

Returns the static decorations for the current page.

builder

@NotNull
static <C,
X extends AbstractPageContext<C,
?,
?>>
@NotNull PageLayoutBuilder<C,X> builder(@NotNull
 @NotNull Capacity capacity)

Creates a generic builder for the given capacity.