Package me.hsgamer.hscore.minecraft.gui.mask

Class ButtonPaginatedMask

java.lang.Object

me.hsgamer.hscore.minecraft.gui.mask.PaginatedMask

me.hsgamer.hscore.minecraft.gui.mask.ButtonPaginatedMask

All Implemented Interfaces:

Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>>, GUIElement

public abstract class ButtonPaginatedMask
extends PaginatedMask

The button paginated mask, those with a long list of buttons divided into pages.

Field Summary

Fields inherited from class me.hsgamer.hscore.minecraft.gui.mask.PaginatedMask

cycle, pageNumberMap

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ButtonPaginatedMask(@NotNull Function<InventoryContext,List<Integer>> maskSlot)	Create a new mask

Method Summary

Modifier and Type	Method	Description
abstract @NotNull List<@NotNull Function<@NotNull InventoryContext,@Nullable ActionItem>>	getButtons(@NotNull UUID uuid)	Get the buttons for the unique id
protected @Nullable Map<@NotNull Integer,@NotNull ActionItem>	getItemMap(@NotNull InventoryContext context, int pageNumber)	Generate the item map for the unique id
@NotNull Function<InventoryContext,List<Integer>>	getMaskSlot()	Get the mask slot
void	stop()	Stop the element.

Methods inherited from class me.hsgamer.hscore.minecraft.gui.mask.PaginatedMask

apply, getAndSetExactPage, getExactPage, getPage, isCycle, nextPage, previousPage, setCycle, setPage

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface me.hsgamer.hscore.minecraft.gui.common.GUIElement

init

Constructor Details

ButtonPaginatedMask

protected ButtonPaginatedMask(@NotNull
 @NotNull Function<InventoryContext,List<Integer>> maskSlot)

Create a new mask

Parameters:

maskSlot - the mask slot

Method Details

getMaskSlot

@NotNull
public @NotNull Function<InventoryContext,List<Integer>> getMaskSlot()

Get the mask slot

Returns:

the mask slot

getButtons

@NotNull
public abstract @NotNull List<@NotNull Function<@NotNull InventoryContext,@Nullable ActionItem>> getButtons(@NotNull
 @NotNull UUID uuid)

Get the buttons for the unique id

Parameters:

uuid - the unique id

Returns:

the buttons

getItemMap

@Nullable
protected @Nullable Map<@NotNull Integer,@NotNull ActionItem> getItemMap(@NotNull
 @NotNull InventoryContext context,
 int pageNumber)

Description copied from class: PaginatedMask

Generate the item map for the unique id

Specified by:

getItemMap in class PaginatedMask

Parameters:

context - the context

pageNumber - the page number

Returns:

the map contains the slots and the buttons

stop

public void stop()

Description copied from interface: GUIElement

Stop the element. Should be called after removing from the GUI.