Package io.rhythmknights.coreapi.component.modal

Class ScrollingModal

java.lang.Object

io.rhythmknights.coreapi.component.modal.BaseModal

io.rhythmknights.coreapi.component.modal.PaginatedModal

io.rhythmknights.coreapi.component.modal.ScrollingModal

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder

public class ScrollingModal
extends PaginatedModal

Modal that allows you to scroll through items

Constructor Summary

Constructors

Constructor	Description
ScrollingModal(@NotNull ModalContainer modalContainer, int pageSize, @NotNull ScrollType scrollType, @NotNull Set<InteractionModifier> interactionModifiers)
ScrollingModal(@NotNull ModalContainer modalContainer, @NotNull PaginationRegion paginationRegion, @NotNull ScrollType scrollType, @NotNull Set<InteractionModifier> interactionModifiers)	Constructor with pagination region

Method Summary

Modifier and Type	Method	Description
boolean	next()	Overrides PaginatedModal.next() to make it work with the specific scrolls
void	open(@NotNull org.bukkit.entity.HumanEntity player)	Overrides PaginatedModal.open(HumanEntity) to make it work with the specific scrolls
void	open(@NotNull org.bukkit.entity.HumanEntity player, int openPage)	Overrides PaginatedModal.open(HumanEntity, int) to make it work with the specific scrolls
boolean	previous()	Overrides PaginatedModal.previous() to make it work with the specific scrolls
ScrollingModal	setDynamicTitle(@NotNull String baseTitle)	Sets a dynamic title that updates with scrolling position

Methods inherited from class io.rhythmknights.coreapi.component.modal.PaginatedModal

addItem, addItem, clearPageItems, clearPageItems, getCurrentPageItems, getCurrentPageNum, getNextPageNum, getPageItems, getPagesNum, getPaginationRegion, getPrevPageNum, removePageItem, removePageItem, setPageNum, setPageSize, setPaginationRegion, update, updatePageItem, updatePageItem, updatePageItem, updatePageItem, updateTitle

Methods inherited from class io.rhythmknights.coreapi.component.modal.BaseModal

addItem, addSlotAction, addSlotAction, allInteractionsDisabled, allowsOtherActions, canDropItems, canPlaceItems, canSwapItems, canTakeItems, close, close, disableAllInteractions, disableItemDrop, disableItemPlace, disableItemSwap, disableItemTake, disableOtherActions, enableAllInteractions, enableItemDrop, enableItemPlace, enableItemSwap, enableItemTake, enableOtherActions, getFiller, getInventory, getModalItem, getModalItems, getRows, isUpdating, modalContainer, modalType, removeItem, removeItem, removeItem, removeItem, setCloseModalAction, setDefaultClickAction, setDefaultTopClickAction, setDragAction, setInventory, setItem, setItem, setItem, setOpenModalAction, setOutsideClickAction, setPlayerInventoryAction, setUpdateTitleOnItemClick, setUpdating, shouldUpdateTitleOnItemClick, title, updateItem, updateItem, updateItem, updateItem, updateTitleOnItemClick

Methods inherited from class java.lang.Object

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

Constructor Details

ScrollingModal

public ScrollingModal(@NotNull
 @NotNull ModalContainer modalContainer,
 int pageSize,
 @NotNull
 @NotNull ScrollType scrollType,
 @NotNull
 @NotNull Set<InteractionModifier> interactionModifiers)

ScrollingModal

public ScrollingModal(@NotNull
 @NotNull ModalContainer modalContainer,
 @NotNull
 @NotNull PaginationRegion paginationRegion,
 @NotNull
 @NotNull ScrollType scrollType,
 @NotNull
 @NotNull Set<InteractionModifier> interactionModifiers)

Constructor with pagination region

Parameters:

modalContainer - Modal container

paginationRegion - Region for pagination items

scrollType - Scrolling direction

interactionModifiers - Interaction modifiers

Method Details

setDynamicTitle

public ScrollingModal setDynamicTitle(@NotNull
 @NotNull String baseTitle)

Sets a dynamic title that updates with scrolling position

Overrides:

setDynamicTitle in class PaginatedModal

Parameters:

baseTitle - Base title text

Returns:

The modal

next

public boolean next()

Overrides PaginatedModal.next() to make it work with the specific scrolls

Overrides:

next in class PaginatedModal

Returns:

False if there is no next page.

previous

public boolean previous()

Overrides PaginatedModal.previous() to make it work with the specific scrolls

Overrides:

previous in class PaginatedModal

Returns:

False if there is no previous page.

open

public void open(@NotNull
 @NotNull org.bukkit.entity.HumanEntity player)

Overrides PaginatedModal.open(HumanEntity) to make it work with the specific scrolls

Overrides:

open in class PaginatedModal

Parameters:

player - The HumanEntity to open the modal to

open

public void open(@NotNull
 @NotNull org.bukkit.entity.HumanEntity player,
 int openPage)

Overrides PaginatedModal.open(HumanEntity, int) to make it work with the specific scrolls

Overrides:

open in class PaginatedModal

Parameters:

player - The HumanEntity to open the modal to

openPage - The page to open on