Package de.placeblock.betterinventories.gui.impl.textinput

Class TextInputGUI

java.lang.Object

de.placeblock.betterinventories.gui.GUI

de.placeblock.betterinventories.gui.impl.BaseAnvilGUI

de.placeblock.betterinventories.gui.impl.textinput.TextInputGUI

All Implemented Interfaces:

PlayerGUI<org.bukkit.entity.Player>

public class TextInputGUI
extends BaseAnvilGUI
implements PlayerGUI<org.bukkit.entity.Player>

GUI for getting Text Input

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextInputGUI.AbstractBuilder<B extends TextInputGUI.AbstractBuilder<B,G,P>,G extends TextInputGUI,P extends org.bukkit.plugin.java.JavaPlugin>	Abstract Builder for creating TextInputGUI
static class	TextInputGUI.Builder<P extends org.bukkit.plugin.java.JavaPlugin>	Builder for creating TextInputGUI

Field Summary

Fields

Modifier and Type	Field	Description
static final org.bukkit.Material	INPUT_MATERIAL	The input-material
static final org.bukkit.Material	RESULT_MATERIAL	The result-material

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextInputGUI(org.bukkit.plugin.Plugin plugin, net.kyori.adventure.text.TextComponent title, boolean removeItems, org.bukkit.entity.Player player, String text, FinishConsumer onFinish, Consumer<String> onUpdate, Function<String,net.kyori.adventure.text.TextComponent> titleConverter)	Creates a new TextInputGUI

Method Summary

Modifier and Type	Method	Description
org.bukkit.entity.Player	getPlayer()
void	onClose(org.bukkit.entity.Player player)	Is called when the player closes the GUI.
boolean	onFinish(String text, boolean abort)	Called when a player clicks on the submit-item and can be overridden
void	onUpdate(String text)	Called when a player types
void	updateText(String text)	Is called by the TextInputPacketListener to update the text

Methods inherited from class de.placeblock.betterinventories.gui.impl.BaseAnvilGUI

createBukkitInventory, getSlots, provideItem, renderContent, searchSection

Methods inherited from class de.placeblock.betterinventories.gui.GUI

getPlayers, getView, getView, reloadViews, removePlayer, showPlayer, update, updateTitle

Methods inherited from class java.lang.Object

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

Field Details

INPUT_MATERIAL

public static final org.bukkit.Material INPUT_MATERIAL

The input-material

RESULT_MATERIAL

public static final org.bukkit.Material RESULT_MATERIAL

The result-material

Constructor Details

TextInputGUI

protected TextInputGUI(org.bukkit.plugin.Plugin plugin,
 net.kyori.adventure.text.TextComponent title,
 boolean removeItems,
 org.bukkit.entity.Player player,
 String text,
 FinishConsumer onFinish,
 Consumer<String> onUpdate,
 Function<String,net.kyori.adventure.text.TextComponent> titleConverter)

Creates a new TextInputGUI

Parameters:

plugin - The plugin

title - The title of the GUI

player - The player which enters text

text - The initial Text

onFinish - Is called when the player finishes renaming (by submitting or by aborting)

onUpdate - Is called whenever the player types something

titleConverter - Is called to convert the current text to the title of the submit item

removeItems - Whether to remove loose items on close. The first player that closes the gui gets the items

Method Details

updateText

public void updateText(String text)

Is called by the TextInputPacketListener to update the text

Parameters:

text - The new text

onClose

public void onClose(org.bukkit.entity.Player player)

Is called when the player closes the GUI. Aborts the text-input.

Overrides:

onClose in class GUI

Parameters:

player - The player, who closed the GUI

onUpdate

public void onUpdate(String text)

Called when a player types

Parameters:

text - The new text

onFinish

public boolean onFinish(String text,
 boolean abort)

Called when a player clicks on the submit-item and can be overridden

Parameters:

text - The final text

abort - Whether the player aborted, e.g. by closing the Inventory

Returns:

GUI closes when true is returned

getPlayer

public org.bukkit.entity.Player getPlayer()

Specified by:

getPlayer in interface PlayerGUI<org.bukkit.entity.Player>

Returns:

The player, who is entering text