Package com.ultikits.ultitools.abstracts.gui

Class BaseConfirmationPage

java.lang.Object

mc.obliviate.inventory.Gui

com.ultikits.ultitools.abstracts.gui.BaseInventoryPage

com.ultikits.ultitools.abstracts.gui.BaseConfirmationPage

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder

Direct Known Subclasses:

InventoryConfirm

public abstract class BaseConfirmationPage
extends BaseInventoryPage

Base class for confirmation dialogs with OK and Cancel buttons.

Since:

6.2.0

Version:

2.0.0

Author:

wisdomme

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseConfirmationPage.Builder	Builder for creating confirmation dialogs.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	CANCEL_BUTTON_COLUMN	Default column for the cancel button
protected static final int	OK_BUTTON_COLUMN	Default column for the OK button

Fields inherited from class com.ultikits.ultitools.abstracts.gui.BaseInventoryPage

DEFAULT_BOTTOM_ROW

Fields inherited from class mc.obliviate.inventory.Gui

player

Constructor Summary

Constructors

Constructor	Description
BaseConfirmationPage(@NotNull org.bukkit.entity.Player player, @NotNull String id, String title, int rows)
BaseConfirmationPage(@NotNull org.bukkit.entity.Player player, @NotNull String id, String title, org.bukkit.event.inventory.InventoryType inventoryType)
BaseConfirmationPage(@NotNull org.bukkit.entity.Player player, @NotNull String id, net.kyori.adventure.text.Component title, int rows)
BaseConfirmationPage(@NotNull org.bukkit.entity.Player player, @NotNull String id, net.kyori.adventure.text.Component title, org.bukkit.event.inventory.InventoryType inventoryType)

Method Summary

Modifier and Type	Method	Description
static BaseConfirmationPage.Builder	builder(@NotNull org.bukkit.entity.Player player)	Creates a new builder for confirmation dialogs.
protected mc.obliviate.inventory.Icon	createCancelButton()	Creates the Cancel button.
protected mc.obliviate.inventory.Icon	createOkButton()	Creates the OK button.
protected String	getCancelButtonName()	Gets the Cancel button display name.
protected String	getOkButtonName()	Gets the OK button display name.
protected void	onCancel(org.bukkit.event.inventory.InventoryClickEvent event)	Called when the Cancel button is clicked.
protected abstract void	onConfirm(org.bukkit.event.inventory.InventoryClickEvent event)	Called when the OK button is clicked.
protected void	setupConfirmationButtons()	Sets up the OK and Cancel buttons.
protected final void	setupContent(org.bukkit.event.inventory.InventoryOpenEvent event)	Sets up the GUI content.
protected void	setupDialogContent(org.bukkit.event.inventory.InventoryOpenEvent event)	Sets up the dialog content.

Methods inherited from class com.ultikits.ultitools.abstracts.gui.BaseInventoryPage

addToBottomRow, afterSetup, createActionButton, createBackgroundIcon, fillArea, fillBorder, getBottomCenterSlot, getContentSlots, getSlotFromEnd, onClose, onClose, onOpen, refresh, setShowBottomToolbar, setupBottomToolbar

Methods inherited from class mc.obliviate.inventory.Gui

addItem, addItem, addItem, addItem, addItem, addItem, addItem, addItem, createInventory, createInventory, fillColumn, fillGui, fillGui, fillGui, fillGui, fillRow, getId, getInventory, getItems, getLastSlot, getPlugin, getSize, getTaskList, getTitle, isClosed, onClick, onDrag, open, runTaskLater, sendSizeUpdate, sendTitleUpdate, setClosed, setInventory, setSize, setTitle, stopAllTasks, stopTask, updateTask

Methods inherited from class java.lang.Object

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

Field Details

CANCEL_BUTTON_COLUMN

protected static final int CANCEL_BUTTON_COLUMN

Default column for the cancel button

See Also:

• Constant Field Values

OK_BUTTON_COLUMN

protected static final int OK_BUTTON_COLUMN

Default column for the OK button

See Also:

• Constant Field Values

Constructor Details

BaseConfirmationPage

public BaseConfirmationPage(@NotNull
 @NotNull org.bukkit.entity.Player player,
 @NotNull
 @NotNull String id,
 String title,
 int rows)

BaseConfirmationPage

public BaseConfirmationPage(@NotNull
 @NotNull org.bukkit.entity.Player player,
 @NotNull
 @NotNull String id,
 String title,
 org.bukkit.event.inventory.InventoryType inventoryType)

BaseConfirmationPage

public BaseConfirmationPage(@NotNull
 @NotNull org.bukkit.entity.Player player,
 @NotNull
 @NotNull String id,
 net.kyori.adventure.text.Component title,
 int rows)

BaseConfirmationPage

public BaseConfirmationPage(@NotNull
 @NotNull org.bukkit.entity.Player player,
 @NotNull
 @NotNull String id,
 net.kyori.adventure.text.Component title,
 org.bukkit.event.inventory.InventoryType inventoryType)

Method Details

setupContent

protected final void setupContent(org.bukkit.event.inventory.InventoryOpenEvent event)

Description copied from class: BaseInventoryPage

Sets up the GUI content. Override this method to add custom content.

Specified by:

setupContent in class BaseInventoryPage

Parameters:

event - the inventory open event

setupDialogContent

protected void setupDialogContent(org.bukkit.event.inventory.InventoryOpenEvent event)

Sets up the dialog content. Override to add custom content.

Parameters:

event - the inventory open event

setupConfirmationButtons

protected void setupConfirmationButtons()

Sets up the OK and Cancel buttons.

createOkButton

protected mc.obliviate.inventory.Icon createOkButton()

Creates the OK button. Override to customize.

Returns:

the OK button icon

createCancelButton

protected mc.obliviate.inventory.Icon createCancelButton()

Creates the Cancel button. Override to customize.

Returns:

the Cancel button icon

getOkButtonName

protected String getOkButtonName()

Gets the OK button display name. Override to customize.

Returns:

the OK button name

getCancelButtonName

protected String getCancelButtonName()

Gets the Cancel button display name. Override to customize.

Returns:

the Cancel button name

onConfirm

protected abstract void onConfirm(org.bukkit.event.inventory.InventoryClickEvent event)

Called when the OK button is clicked.

Parameters:

event - the click event

onCancel

protected void onCancel(org.bukkit.event.inventory.InventoryClickEvent event)

Called when the Cancel button is clicked. Default implementation does nothing.

Parameters:

event - the click event

builder

public static BaseConfirmationPage.Builder builder(@NotNull
 @NotNull org.bukkit.entity.Player player)

Creates a new builder for confirmation dialogs.

Parameters:

player - the player to show the dialog to

Returns:

a new builder