Package io.rhythmknights.coreapi.component.modal

Class Modal

java.lang.Object

io.rhythmknights.coreapi.component.modal.BaseModal

io.rhythmknights.coreapi.component.modal.Modal

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder

public class Modal
extends BaseModal

Standard modal implementation of BaseModal

Constructor Summary

Constructors

Constructor	Description
Modal(@NotNull ModalContainer modalContainer, @NotNull Set<InteractionModifier> interactionModifiers)

Method Summary

Modifier and Type	Method	Description
static @NotNull ChestModalBuilder	modal()	Creates a ChestModalBuilder with CHEST as the ModalType
static @NotNull TypedModalBuilder	modal(@NotNull ModalType type)	Creates a TypedModalBuilder to build a Modal
static @NotNull PaginatedBuilder	paginated()	Creates a PaginatedBuilder to build a PaginatedModal
static @NotNull ScrollingBuilder	scrolling()	Creates a ScrollingBuilder with VERTICAL as the ScrollType
static @NotNull ScrollingBuilder	scrolling(@NotNull ScrollType scrollType)	Creates a ScrollingBuilder to build a ScrollingModal

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

addItem, 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, open, removeItem, removeItem, removeItem, removeItem, setCloseModalAction, setDefaultClickAction, setDefaultTopClickAction, setDragAction, setInventory, setItem, setItem, setItem, setOpenModalAction, setOutsideClickAction, setPlayerInventoryAction, setUpdateTitleOnItemClick, setUpdating, shouldUpdateTitleOnItemClick, title, update, updateItem, updateItem, updateItem, updateItem, updateTitle, updateTitleOnItemClick

Methods inherited from class java.lang.Object

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

Constructor Details

Modal

public Modal(@NotNull
 @NotNull ModalContainer modalContainer,
 @NotNull
 @NotNull Set<InteractionModifier> interactionModifiers)

Method Details

modal

@Contract("_ -> new")
@NotNull
public static @NotNull TypedModalBuilder modal(@NotNull
 @NotNull ModalType type)

Creates a TypedModalBuilder to build a Modal

Parameters:

type - The ModalType to be used

Returns:

A TypedModalBuilder

Since:

3.0.0

modal

@Contract(" -> new")
@NotNull
public static @NotNull ChestModalBuilder modal()

Creates a ChestModalBuilder with CHEST as the ModalType

Returns:

A CHEST ChestModalBuilder

Since:

3.0.0

paginated

@Contract(" -> new")
@NotNull
public static @NotNull PaginatedBuilder paginated()

Creates a PaginatedBuilder to build a PaginatedModal

Returns:

A PaginatedBuilder

Since:

3.0.0

scrolling

@Contract("_ -> new")
@NotNull
public static @NotNull ScrollingBuilder scrolling(@NotNull
 @NotNull ScrollType scrollType)

Creates a ScrollingBuilder to build a ScrollingModal

Parameters:

scrollType - The ScrollType to be used by the modal

Returns:

A ScrollingBuilder

Since:

3.0.0

scrolling

@Contract(" -> new")
@NotNull
public static @NotNull ScrollingBuilder scrolling()

Creates a ScrollingBuilder with VERTICAL as the ScrollType

Returns:

A vertical ChestModalBuilder

Since:

3.0.0