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

Class ButtonPaginatedMask

java.lang.Object

me.hsgamer.hscore.minecraft.gui.mask.BaseMask

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

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

All Implemented Interfaces:

Mask, Initializable

Direct Known Subclasses:

StaticButtonPaginatedMask

public abstract class ButtonPaginatedMask
extends PaginatedMask

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

Field Summary

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

cycle, pageNumberMap

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ButtonPaginatedMask(@NotNull String name, @NotNull MaskSlot maskSlot)	Create a new mask

Method Summary

Modifier and Type	Method	Description
protected Optional<Map<@NotNull Integer,@NotNull Button>>	generateButtons(@NotNull UUID uuid, @NotNull InventorySize inventorySize, int pageNumber)	Generate the buttons for the unique id
abstract @NotNull List<@NotNull Button>	getButtons(@NotNull UUID uuid)	Get the buttons for the unique id
@NotNull MaskSlot	getMaskSlot()	Get the mask slot
void	stop()	Stop the object

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

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

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

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.hsgamer.hscore.ui.property.Initializable

init

Constructor Details

ButtonPaginatedMask

protected ButtonPaginatedMask(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull MaskSlot maskSlot)

Create a new mask

Parameters:

name - the name of the mask

maskSlot - the mask slot

Method Details

getMaskSlot

@NotNull
public @NotNull MaskSlot getMaskSlot()

Get the mask slot

Returns:

the mask slot

getButtons

@NotNull
public abstract @NotNull List<@NotNull Button> getButtons(@NotNull
 @NotNull UUID uuid)

Get the buttons for the unique id

Parameters:

uuid - the unique id

Returns:

the buttons

generateButtons

protected Optional<Map<@NotNull Integer,@NotNull Button>> generateButtons(@NotNull
 @NotNull UUID uuid,
 @NotNull
 @NotNull InventorySize inventorySize,
 int pageNumber)

Description copied from class: PaginatedMask

Generate the buttons for the unique id

Specified by:

generateButtons in class PaginatedMask

Parameters:

uuid - the unique id

inventorySize - the size of the inventory

pageNumber - the page number

Returns:

the map contains the slots and the buttons

See Also:

• Mask.generateButtons(UUID, InventorySize)

stop

public void stop()

Description copied from interface: Initializable

Stop the object