org.cloudburstmc.server.form

Class CustomForm.CustomFormBuilder

java.lang.Object

org.cloudburstmc.server.form.Form.FormBuilder<CustomForm,CustomForm.CustomFormBuilder,CustomFormResponse>

org.cloudburstmc.server.form.CustomForm.CustomFormBuilder

Enclosing class:

CustomForm

public static class CustomForm.CustomFormBuilder
extends Form.FormBuilder<CustomForm,CustomForm.CustomFormBuilder,CustomFormResponse>

Field Summary

Fields inherited from class org.cloudburstmc.server.form.Form.FormBuilder

closeListeners, errorListeners, listeners, title

Constructor Summary

Constructors

Constructor and Description
CustomFormBuilder()

Method Summary

Modifier and Type	Method and Description
CustomForm	build() Builds a new CustomForm instance using builder values
CustomForm.CustomFormBuilder	dropdown(String text, int defaultOption, List<String> options) Add a dropdown element
CustomForm.CustomFormBuilder	dropdown(String text, int defaultOption, String... options) Add a dropdown element
CustomForm.CustomFormBuilder	dropdown(String text, List<String> options) Add a dropdown element
CustomForm.CustomFormBuilder	dropdown(String text, String... options) Add a dropdown element
CustomForm.CustomFormBuilder	element(Element element) Add an element
CustomForm.CustomFormBuilder	elements(Collection<Element> elements) Add list of elements
CustomForm.CustomFormBuilder	elements(Element element, Element... elements) Add one or more elements
CustomForm.CustomFormBuilder	icon(ImageType imageType, String imageData) Set an icon of the form The icon is visible only in case of server settings form
CustomForm.CustomFormBuilder	input(String text) Add an input element
CustomForm.CustomFormBuilder	input(String text, String placeholder) Add an input element
CustomForm.CustomFormBuilder	input(String text, String placeholder, String defaultText) Add an input element
CustomForm.CustomFormBuilder	label(String text) Add a label element
protected CustomForm.CustomFormBuilder	self()
CustomForm.CustomFormBuilder	slider(String elementText) Add a slider element
CustomForm.CustomFormBuilder	slider(String elementText, float minimum, float maximum) Add a slider element
CustomForm.CustomFormBuilder	slider(String elementText, float minimum, float maximum, int stepCount) Add a slider element
CustomForm.CustomFormBuilder	slider(String elementText, float minimum, float maximum, int stepCount, float defaultValue) Add a slider element
CustomForm.CustomFormBuilder	stepSlider(String elementText) Add a step slider element
CustomForm.CustomFormBuilder	stepSlider(String elementText, int defaultStepIndex, List<String> stepOptions) Add a step slider element
CustomForm.CustomFormBuilder	stepSlider(String elementText, int defaultStepIndex, String... stepOptions) Add a step slider element
CustomForm.CustomFormBuilder	stepSlider(String elementText, List<String> stepOptions) Add a step slider element
CustomForm.CustomFormBuilder	stepSlider(String elementText, String... stepOptions) Add a step slider element
CustomForm.CustomFormBuilder	toggle(String elementText) Add a toggle element
CustomForm.CustomFormBuilder	toggle(String elementText, boolean defaultValue) Add a toggle element

Methods inherited from class org.cloudburstmc.server.form.Form.FormBuilder

onClose, onError, onSubmit, title

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFormBuilder

public CustomFormBuilder()

Method Detail

dropdown

public CustomForm.CustomFormBuilder dropdown(@Nonnull
                                             String text,
                                             @Nonnull
                                             String... options)

Add a dropdown element

Parameters:

text - dropdown title

options - dropdown options

Returns:

self builder instance

dropdown

public CustomForm.CustomFormBuilder dropdown(@Nonnull
                                             String text,
                                             @Nonnull
                                             List<String> options)

Add a dropdown element

Parameters:

text - dropdown title

options - dropdown options

Returns:

self builder instance

dropdown

public CustomForm.CustomFormBuilder dropdown(@Nonnull
                                             String text,
                                             int defaultOption,
                                             @Nonnull
                                             String... options)

Add a dropdown element

Parameters:

text - dropdown title

defaultOption - default dropdown option index

options - dropdown options

Returns:

self builder instance

dropdown

public CustomForm.CustomFormBuilder dropdown(@Nonnull
                                             String text,
                                             int defaultOption,
                                             @Nonnull
                                             List<String> options)

Add a dropdown element

Parameters:

text - dropdown title

defaultOption - default dropdown option index

options - dropdown options

Returns:

self builder instance

input

public CustomForm.CustomFormBuilder input(@Nonnull
                                          String text)

Add an input element

Parameters:

text - input title

Returns:

self builder instance

input

public CustomForm.CustomFormBuilder input(@Nonnull
                                          String text,
                                          @Nonnull
                                          String placeholder)

Add an input element

Parameters:

text - input title

placeholder - placeholder text

Returns:

self builder instance

input

public CustomForm.CustomFormBuilder input(@Nonnull
                                          String text,
                                          @Nonnull
                                          String placeholder,
                                          @Nonnull
                                          String defaultText)

Add an input element

Parameters:

text - input title

placeholder - placeholder text

defaultText - default input text

Returns:

self builder instance

label

public CustomForm.CustomFormBuilder label(@Nonnull
                                          String text)

Add a label element

Parameters:

text - label text

Returns:

self builder instance

slider

public CustomForm.CustomFormBuilder slider(@Nonnull
                                           String elementText)

Add a slider element

Parameters:

elementText - slider title

Returns:

self builder instance

slider

public CustomForm.CustomFormBuilder slider(@Nonnull
                                           String elementText,
                                           float minimum,
                                           float maximum)

Add a slider element

Parameters:

elementText - slider title

minimum - minimal slider value

maximum - maximal slider value

Returns:

self builder instance

slider

public CustomForm.CustomFormBuilder slider(@Nonnull
                                           String elementText,
                                           float minimum,
                                           float maximum,
                                           int stepCount)

Add a slider element

Parameters:

elementText - slider title

minimum - minimal slider value

maximum - maximal slider value

stepCount - amount of steps in a given range

Returns:

self builder instance

slider

public CustomForm.CustomFormBuilder slider(@Nonnull
                                           String elementText,
                                           float minimum,
                                           float maximum,
                                           int stepCount,
                                           float defaultValue)

Add a slider element

Parameters:

elementText - slider title

minimum - minimal slider value

maximum - maximal slider value

stepCount - amount of steps in a given range

defaultValue - default slider value

Returns:

self builder instance

stepSlider

public CustomForm.CustomFormBuilder stepSlider(@Nonnull
                                               String elementText)

Add a step slider element

Parameters:

elementText - step slider title

Returns:

self builder instance

stepSlider

public CustomForm.CustomFormBuilder stepSlider(@Nonnull
                                               String elementText,
                                               @Nonnull
                                               String... stepOptions)

Add a step slider element

Parameters:

elementText - step slider title

stepOptions - list of all available steps

Returns:

self builder instance

stepSlider

public CustomForm.CustomFormBuilder stepSlider(@Nonnull
                                               String elementText,
                                               @Nonnull
                                               List<String> stepOptions)

Add a step slider element

Parameters:

elementText - step slider title

stepOptions - list of all available steps

Returns:

self builder instance

stepSlider

public CustomForm.CustomFormBuilder stepSlider(@Nonnull
                                               String elementText,
                                               int defaultStepIndex,
                                               @Nonnull
                                               String... stepOptions)

Add a step slider element

Parameters:

elementText - step slider title

defaultStepIndex - step slider default option index

stepOptions - list of all available steps

Returns:

self builder instance

stepSlider

public CustomForm.CustomFormBuilder stepSlider(@Nonnull
                                               String elementText,
                                               int defaultStepIndex,
                                               @Nonnull
                                               List<String> stepOptions)

Add a step slider element

Parameters:

elementText - step slider title

defaultStepIndex - step slider default option index

stepOptions - list of all available steps

Returns:

self builder instance

toggle

public CustomForm.CustomFormBuilder toggle(@Nonnull
                                           String elementText)

Add a toggle element

Parameters:

elementText - toggle title

Returns:

self builder instance

toggle

public CustomForm.CustomFormBuilder toggle(@Nonnull
                                           String elementText,
                                           boolean defaultValue)

Add a toggle element

Parameters:

elementText - toggle title

defaultValue - default toggle value

Returns:

self builder instance

element

public CustomForm.CustomFormBuilder element(@Nonnull
                                            Element element)

Add an element

Parameters:

element - an element to be added

Returns:

self builder instance

elements

public CustomForm.CustomFormBuilder elements(@Nonnull
                                             Element element,
                                             @Nonnull
                                             Element... elements)

Add one or more elements

Parameters:

element - an element to be added

elements - list of elements to be added

Returns:

self builder instance

elements

public CustomForm.CustomFormBuilder elements(@Nonnull
                                             Collection<Element> elements)

Add list of elements

Parameters:

elements - list of elements to be added

Returns:

self builder instance

icon

public CustomForm.CustomFormBuilder icon(@Nonnull
                                         ImageType imageType,
                                         @Nonnull
                                         String imageData)

Set an icon of the form The icon is visible only in case of server settings form

Parameters:

imageType - icon image type

imageData - icon image data

Returns:

self builder instance

build

public CustomForm build()

Builds a new CustomForm instance using builder values

Specified by:

build in class Form.FormBuilder<CustomForm,CustomForm.CustomFormBuilder,CustomFormResponse>

Returns:

CustomForm instance

self

protected CustomForm.CustomFormBuilder self()

Specified by:

self in class Form.FormBuilder<CustomForm,CustomForm.CustomFormBuilder,CustomFormResponse>