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

Class TextInputGUI.Builder<P extends org.bukkit.plugin.java.JavaPlugin>

java.lang.Object

de.placeblock.betterinventories.Builder<B,G>

de.placeblock.betterinventories.gui.GUI.Builder<B,G,P>

de.placeblock.betterinventories.gui.impl.BaseAnvilGUI.Builder<TextInputGUI.Builder<P>,TextInputGUI,P>

de.placeblock.betterinventories.gui.impl.textinput.TextInputGUI.Builder<P>

Type Parameters:

P - The plugin that uses this builder

Enclosing class:

TextInputGUI

public static class TextInputGUI.Builder<P extends org.bukkit.plugin.java.JavaPlugin>
extends BaseAnvilGUI.Builder<TextInputGUI.Builder<P>,TextInputGUI,P>

Builder for creating TextInputGUI

Constructor Summary

Constructors

Constructor	Description
Builder(P plugin, org.bukkit.entity.Player player)	Creates a new Builder

Method Summary

Modifier and Type	Method	Description
TextInputGUI	build()	Builds the instance
TextInputGUI.Builder<P>	onFinish(FinishConsumer onFinish)	Sets the onFinish attribute
TextInputGUI.Builder<P>	onUpdate(Consumer<String> onUpdate)	Sets the onUpdate attribute
protected TextInputGUI.Builder<P>	self()	Returns the Builder instance itself
TextInputGUI.Builder<P>	text(String text)	Sets the text attribute
TextInputGUI.Builder<P>	titleConverter(Function<String,net.kyori.adventure.text.TextComponent> titleConverter)	Sets the titleConverter attribute

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

additionalItem, inputItem, resultItem

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

removeItems, title, type

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(P plugin,
 org.bukkit.entity.Player player)

Creates a new Builder

Parameters:

plugin - The plugin that uses this builder

player - The player this GUI belongs to

Method Details

text

public TextInputGUI.Builder<P> text(String text)

Sets the text attribute

Parameters:

text - The text that is shown in the anvil at the beginning

Returns:

Itself

onFinish

public TextInputGUI.Builder<P> onFinish(FinishConsumer onFinish)

Sets the onFinish attribute

Parameters:

onFinish - Is executed if the text is submitted

Returns:

Itself

onUpdate

public TextInputGUI.Builder<P> onUpdate(Consumer<String> onUpdate)

Sets the onUpdate attribute

Parameters:

onUpdate - Is executed if the text is updated

Returns:

Itself

titleConverter

public TextInputGUI.Builder<P> titleConverter(Function<String,net.kyori.adventure.text.TextComponent> titleConverter)

Sets the titleConverter attribute

Parameters:

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

Returns:

Itself

build

public TextInputGUI build()

Description copied from class: Builder

Builds the instance

Specified by:

build in class Builder<TextInputGUI.Builder<P extends org.bukkit.plugin.java.JavaPlugin>,TextInputGUI>

Returns:

The new instance

self

protected TextInputGUI.Builder<P> self()

Description copied from class: Builder

Returns the Builder instance itself

Specified by:

self in class Builder<TextInputGUI.Builder<P extends org.bukkit.plugin.java.JavaPlugin>,TextInputGUI>

Returns:

the Builder instance itself