Class Button.Builder

java.lang.Object

dev.xichil.mvui.Entry.Builder<Button.Builder>

dev.xichil.mvui.Button.Builder

Enclosing class:

Button

public static final class Button.Builder
extends Entry.Builder<Button.Builder>

Builds a Button; from Button.builder(String). Also has the options every entry has (Entry.Builder).

Method Summary

Modifier and Type	Method	Description
Button	build()	Builds the button.
Button.Builder	label(Text label)	A fixed text; see label(Supplier).
Button.Builder	label(Supplier<Text> label)	The text on the button, re-read on every refresh.
Button.Builder	onPress(Runnable onPress)	What a click does, run on the main thread.

Methods inherited from class Entry.Builder

enabled, enabled, tooltip, tooltip, visible

Methods inherited from class Object

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

Method Details

label

public Button.Builder label(Supplier<Text> label)

The text on the button, re-read on every refresh. Required.

Parameters:

label - read on refresh

Returns:

this builder

label

public Button.Builder label(Text label)

A fixed text; see label(Supplier).

Parameters:

label - the text

Returns:

this builder

onPress

public Button.Builder onPress(Runnable onPress)

What a click does, run on the main thread. Required. Typical actions change the mod's state, show a StatusLine message, or navigate with UiHost.open(Screen), UiHost.back() or UiHost.close(). Slow work (file or network IO) belongs in UiHost.runAsync(Callable, BiConsumer). If it throws, the error is logged and the menu stays open.

Parameters:

onPress - the action

Returns:

this builder

build

public Button build()

Builds the button.

Returns:

the button

Throws:

IllegalStateException - if label or onPress is missing