Class PaginatedMenu

java.lang.Object

com.kamikazejam.kamicommon.menu.api.MenuHolder

com.kamikazejam.kamicommon.menu.AbstractMenu<PaginatedMenu>

com.kamikazejam.kamicommon.menu.PaginatedMenu

All Implemented Interfaces:

UpdatingMenu, Menu<PaginatedMenu>, InventoryHolder

public final class PaginatedMenu
extends AbstractMenu<PaginatedMenu>

This Menu class focuses on providing an easy way of creating a menu with multiple pages. This menu allows you to provide all the items you want to display, and it will automatically paginate them for you.
Pagination configuration is available by creating your own PaginationLayout or by modifying a pre-built one.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PaginatedMenu.Builder

Field Summary

Fields inherited from class AbstractMenu

events, menuIcons, options, player

Fields inherited from class MenuHolder

inventory, size, title

Method Summary

Modifier and Type	Method	Description
int	getCurrentPage()
@NotNull PaginatedMenuOptions	getOptions()
@NotNull PaginatedMenu	modifyPageIcons(@NotNull Consumer<IPageIconsAccess<PaginatedMenu>> consumer)
@Nullable InventoryView	open()	Open the Inventory for the Player that this menu was created for.
@Nullable InventoryView	open(int p)
protected void	placeFiller(Map<Integer, @Nullable ItemStack> newMenuState, Set<Integer> slots, int tick)

Methods inherited from class AbstractMenu

close, getFillerIcon, getMenuIcons, getMenuIconsAccess, modifyIcons, open, placeIcons, reopenMenu, reopenMenu, resizeMenu, setSize, updateOneTick

Methods inherited from class MenuHolder

clear, closeAll, deleteInventory, equals, firstEmpty, firstEmpty, firstEmpty, getHolder, getInventory, getItem, getMenuSize, getRawInventory, getSize, getViewers, hashCode, replaceTitle, setItem, setItem

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Menu

buildClickData, buildPlayerClickData, getEvents, getMenuSize

Methods inherited from interface UpdatingMenu

getInventory

Method Details

getOptions

@NotNull
public @NotNull PaginatedMenuOptions getOptions()

open

@Nullable
public @Nullable InventoryView open()

Description copied from class: AbstractMenu

Open the Inventory for the Player that this menu was created for.

Overrides:

open in class AbstractMenu<PaginatedMenu>

Returns:

The InventoryView for the new menu, or null if the player was not online to open the menu for.

open

@Nullable
public @Nullable InventoryView open(int p)

Parameters:

p - The page index to open (0-indexed)

placeFiller

protected void placeFiller(Map<Integer, @Nullable ItemStack> newMenuState,
 Set<Integer> slots,
 int tick)

Overrides:

placeFiller in class AbstractMenu<PaginatedMenu>

getCurrentPage

public int getCurrentPage()

Returns:

The current page (0-indexed)

modifyPageIcons

@NotNull
public @NotNull PaginatedMenu modifyPageIcons(@NotNull
 @NotNull Consumer<IPageIconsAccess<PaginatedMenu>> consumer)