Class MenuScreen.Builder

java.lang.Object

dev.xichil.mvui.MenuScreen.Builder

Enclosing class:

MenuScreen

public static final class MenuScreen.Builder
extends Object

Builds a MenuScreen; from MenuScreen.builder(String). Setters return the builder for chaining.

Method Summary

Modifier and Type	Method	Description
MenuScreen.Builder	add(Entry entry)	Appends an entry to the list.
MenuScreen.Builder	add(StringListEditor editor)	Appends a StringListEditor's entries (its list, input, Add and Remove buttons), in that order.
MenuScreen	build()	Builds the screen.
MenuScreen.Builder	footer(Entry entry)	Appends an entry to the footer row at the bottom of the screen, which stays in place while the list scrolls.
MenuScreen.Builder	title(Text title)	The title shown at the top of the screen.

Methods inherited from class Object

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

Method Details

title

public MenuScreen.Builder title(Text title)

The title shown at the top of the screen. Required.

Parameters:

title - the title

Returns:

this builder

add

public MenuScreen.Builder add(Entry entry)

Appends an entry to the list. A Section is appended together with its children, right after it.

Parameters:

entry - any entry that is not a section's child

Returns:

this builder

Throws:

IllegalStateException - if entry is null or is a child of a section (add the section instead)

add

public MenuScreen.Builder add(StringListEditor editor)

Appends a StringListEditor's entries (its list, input, Add and Remove buttons), in that order.

Parameters:

editor - the editor

Returns:

this builder

footer

public MenuScreen.Builder footer(Entry entry)

Appends an entry to the footer row at the bottom of the screen, which stays in place while the list scrolls. Use it for the screen's main actions: "Done", "Save", "Cancel"…

Allowed are Button, Toggle, Cycle, Dropdown, TextInput, NumberField, Label, SelectList and StatusLine, as long as they have no visible supplier and are not in a section. Not allowed: Section, Slider, Checkbox, Keybind, MultiLineInput, ColorPicker. In practice, keep the footer to a few buttons.

Parameters:

entry - the footer entry

Returns:

this builder

Throws:

IllegalStateException - if entry is null or not allowed in the footer

build

public MenuScreen build()

Builds the screen.

Returns:

the screen

Throws:

IllegalStateException - if the title is missing or two entries share an id