net.lenni0451.mcstructs_bedrock.forms.types

Class ModalForm

java.lang.Object

net.lenni0451.mcstructs_bedrock.forms.AForm

net.lenni0451.mcstructs_bedrock.forms.types.ModalForm

public class ModalForm
extends AForm

Representation of a modal form.
A modal form has two buttons and a text.

Field Summary

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

DEFAULT_TRANSLATOR, translator

Constructor Summary

Constructors

Constructor and Description
ModalForm(java.lang.String title, java.lang.String text, java.lang.String button1, java.lang.String button2)

Method Summary

Modifier and Type	Method and Description
static ModalFormBuilder	builder()
void	deserializeResponse(java.lang.String response) Deserialize the response of the form from a string.
java.lang.String	getButton1()
java.lang.String	getButton1(boolean translate) Get the text of the first button.
java.lang.String	getButton2()
java.lang.String	getButton2(boolean translate) Get the text of the second button.
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.

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

getTitle, getTitle, getTranslator, getType, setTranslator

Methods inherited from class java.lang.Object

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

Constructor Detail

ModalForm

public ModalForm(@Nonnull
                 java.lang.String title,
                 @Nonnull
                 java.lang.String text,
                 @Nonnull
                 java.lang.String button1,
                 @Nonnull
                 java.lang.String button2)

Parameters:

title - The title of the form

text - The text displayed in the form

button1 - The text of the first button

button2 - The text of the second button

Method Detail

builder

public static ModalFormBuilder builder()

Returns:

A new builder for a modal form

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

getButton1

@Nonnull
public java.lang.String getButton1()

Returns:

The translated text of the first button

getButton1

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

Get the text of the first button.

Parameters:

translate - If the text should be translated

Returns:

The text

getButton2

@Nonnull
public java.lang.String getButton2()

Returns:

The translated text of the second button

getButton2

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

Get the text of the second button.

Parameters:

translate - If the text should be translated

Returns:

The text

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)

Description copied from class: AForm

Deserialize the response of the form from a string.

Specified by:

deserializeResponse in class AForm

Parameters:

response - The serialized response