net.lenni0451.mcstructs_bedrock.forms.types

Class ActionForm

java.lang.Object

net.lenni0451.mcstructs_bedrock.forms.AForm

net.lenni0451.mcstructs_bedrock.forms.types.ActionForm

public class ActionForm
extends AForm

Representation of an action form.
An action form has multiple buttons and a text.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActionForm.Button A button of an action form.

Field Summary

Fields inherited from class net.lenni0451.mcstructs_bedrock.forms.AForm

DEFAULT_TRANSLATOR, translator

Constructor Summary

Constructors

Constructor and Description
ActionForm(java.lang.String title, java.lang.String text, ActionForm.Button... buttons)

Method Summary

Modifier and Type	Method and Description
static ActionFormBuilder	builder()
void	deserializeResponse(java.lang.String response) Deserialize the response of the form from a string.
ActionForm.Button[]	getButtons()
int	getClickedButton() Get the clicked button of the form.
java.lang.String	getText()
java.lang.String	getText(boolean translate) Get the text of the form.
java.lang.String	serializeResponse() Serialize the response of the form to a string.
void	setClickedButton(int clickedButton) Set the clicked button of the form.
void	setTranslator(java.util.function.Function<java.lang.String,java.lang.String> translator) Set the translator for the form.

Methods inherited from class net.lenni0451.mcstructs_bedrock.forms.AForm

getTitle, getTitle, getTranslator, getType

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionForm

public ActionForm(@Nonnull
                  java.lang.String title,
                  @Nonnull
                  java.lang.String text,
                  @Nonnull
                  ActionForm.Button... buttons)

Parameters:

title - The title of the form

text - The text displayed in the form

buttons - The buttons of the form

Method Detail

builder

public static ActionFormBuilder builder()

Returns:

A new builder for an action form

setTranslator

public void setTranslator(@Nonnull
                          java.util.function.Function<java.lang.String,java.lang.String> translator)

Description copied from class: AForm

Set the translator for the form.

Overrides:

setTranslator in class AForm

Parameters:

translator - The translator

getText

public java.lang.String getText()

Returns:

The translated text of the form

getText

@Nonnull
public java.lang.String getText(boolean translate)

Get the text of the form.

Parameters:

translate - If the text should be translated

Returns:

The content

getButtons

@Nonnull
public ActionForm.Button[] getButtons()

Returns:

The buttons of the form

setClickedButton

public void setClickedButton(int clickedButton)

Set the clicked button of the form.
This is required for the response.

Parameters:

clickedButton - The clicked button

getClickedButton

public int getClickedButton()

Get the clicked button of the form.
This is required for the response.

Returns:

The clicked button

serializeResponse

public java.lang.String serializeResponse()

Description copied from class: AForm

Serialize the response of the form to a string.

Specified by:

serializeResponse in class AForm

Returns:

The serialized response

deserializeResponse

public void deserializeResponse(java.lang.String response)

Deserialize the response of the form from a string.

Specified by:

deserializeResponse in class AForm

Parameters:

response - The serialized response

Throws:

java.lang.NumberFormatException - If the response is not a number