Package io.papermc.paper.registry.data.dialog.input

Interface TextDialogInput.Builder

Enclosing interface:

TextDialogInput

@NonExtendable
public static interface TextDialogInput.Builder

A builder for a text dialog input.

Created via DialogInput.text(String, Component)

Method Summary

Modifier and Type	Method	Description
TextDialogInput	build()	Builds the text dialog input.
TextDialogInput.Builder	initial(String initial)	Sets the initial value of the input.
TextDialogInput.Builder	labelVisible(boolean labelVisible)	Sets whether the label should be visible.
TextDialogInput.Builder	maxLength(@org.checkerframework.checker.index.qual.Positive int maxLength)	Sets the maximum length of the input.
TextDialogInput.Builder	multiline(@Nullable TextDialogInput.MultilineOptions multiline)	Sets the multiline options for the input.
TextDialogInput.Builder	width(@org.jetbrains.annotations.Range(from=1L, to=1024L) int width)	Sets the width of the input.

Method Details

width

@Contract(value="_ -> this",
          mutates="this")
TextDialogInput.Builder width(@org.jetbrains.annotations.Range(from=1L, to=1024L) int width)

Sets the width of the input.

Parameters:

width - the width of the input

Returns:

this builder

labelVisible

@Contract(value="_ -> this",
          mutates="this")
TextDialogInput.Builder labelVisible(boolean labelVisible)

Sets whether the label should be visible.

Parameters:

labelVisible - true if the label should be visible, false otherwise

Returns:

this builder

initial

@Contract(value="_ -> this",
          mutates="this")
TextDialogInput.Builder initial(String initial)

Sets the initial value of the input.

Parameters:

initial - the initial value of the input

Returns:

this builder

maxLength

@Contract(value="_ -> this",
          mutates="this")
TextDialogInput.Builder maxLength(@org.checkerframework.checker.index.qual.Positive int maxLength)

Sets the maximum length of the input.

Parameters:

maxLength - the maximum length of the input

Returns:

this builder

multiline

@Contract(value="_ -> this",
          mutates="this")
TextDialogInput.Builder multiline(@Nullable TextDialogInput.MultilineOptions multiline)

Sets the multiline options for the input.

Parameters:

multiline - the multiline options, or null if not set

Returns:

this builder

build

@Contract(value="-> new",
          pure=true)
TextDialogInput build()

Builds the text dialog input.

Returns:

the text dialog input