Package xyz.gmitch215.socketmc.screen.builder

Class ScreenBuilder

java.lang.Object

xyz.gmitch215.socketmc.screen.builder.ScreenBuilder

public final class ScreenBuilder
extends Object

Represents a builder for creating a CustomScreen.

Method Summary

Modifier and Type	Method	Description
@NotNull ScreenBuilder	background(@NotNull ScreenBackground background)	Sets the background of the screen.
@NotNull CustomScreen	build()	Builds the screen.
static @NotNull ScreenBuilder	builder()	Creates a new ScreenBuilder with a new CustomScreen, with an empty title.
static @NotNull ScreenBuilder	builder(@NotNull Text title)	Creates a new ScreenBuilder with a new CustomScreen, with the given title.
@NotNull ScreenBuilder	element(@NotNull Supplier<Positionable> element)	Adds a new element to the screen.
@NotNull ScreenBuilder	element(@NotNull Positionable element)	Adds a new element to the screen.
@NotNull ScreenBuilder	focusedTextWidget(@NotNull Consumer<FocusedTextWidgetBuilder> widget)	Adds a new element to the screen.
@NotNull ScreenBuilder	imageButton(@NotNull Consumer<ImageButtonBuilder> button)	Adds a new element to the screen.
@NotNull ScreenBuilder	imageWidget(@NotNull Consumer<ImageWidgetBuilder> widget)	Adds a new element to the screen.
@NotNull ScreenBuilder	layout(@NotNull Supplier<Layout> layout)	Sets the layout of the screen.
@NotNull ScreenBuilder	layout(@Nullable Layout layout)	Sets the layout of the screen.
@NotNull ScreenBuilder	textButton(@NotNull Consumer<TextButtonBuilder> button)	Adds a new element to the screen.
@NotNull ScreenBuilder	textWidget(@NotNull Consumer<TextWidgetBuilder> widget)	Adds a new element to the screen.
@NotNull ScreenBuilder	title(@NotNull String title)	Sets the title of the screen.
@NotNull ScreenBuilder	title(@NotNull Text title)	Sets the title of the screen.

Methods inherited from class java.lang.Object

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

Method Details

title

@NotNull
public @NotNull ScreenBuilder title(@NotNull
 @NotNull Text title)

Sets the title of the screen.

Parameters:

title - The title of the screen.

Returns:

this class, for chaining

title

@NotNull
public @NotNull ScreenBuilder title(@NotNull
 @NotNull String title)

Sets the title of the screen.

Parameters:

title - The title of the screen.

Returns:

this class, for chaining

element

@NotNull
public @NotNull ScreenBuilder element(@NotNull
 @NotNull Supplier<Positionable> element)

Adds a new element to the screen.

Parameters:

element - The element to add.

Returns:

this class, for chaining

element

@NotNull
public @NotNull ScreenBuilder element(@NotNull
 @NotNull Positionable element)

Adds a new element to the screen.

Parameters:

element - The element to add.

Returns:

this class, for chaining

focusedTextWidget

@NotNull
public @NotNull ScreenBuilder focusedTextWidget(@NotNull
 @NotNull Consumer<FocusedTextWidgetBuilder> widget)

Adds a new element to the screen.

Parameters:

widget - Constructor for a FocusedTextWidget

Returns:

this class, for chaining

textWidget

@NotNull
public @NotNull ScreenBuilder textWidget(@NotNull
 @NotNull Consumer<TextWidgetBuilder> widget)

Adds a new element to the screen.

Parameters:

widget - Constructor for a TextWidget

Returns:

this class, for chaining

textButton

@NotNull
public @NotNull ScreenBuilder textButton(@NotNull
 @NotNull Consumer<TextButtonBuilder> button)

Adds a new element to the screen.

Parameters:

button - Constructor for a TextButton

Returns:

this class, for chaining

imageWidget

@NotNull
public @NotNull ScreenBuilder imageWidget(@NotNull
 @NotNull Consumer<ImageWidgetBuilder> widget)

Adds a new element to the screen.

Parameters:

widget - Constructor for a ImageWidget

Returns:

this class, for chaining

imageButton

@NotNull
public @NotNull ScreenBuilder imageButton(@NotNull
 @NotNull Consumer<ImageButtonBuilder> button)

Adds a new element to the screen.

Parameters:

button - Constructor for a ImageButton

Returns:

this class, for chaining

background

@NotNull
public @NotNull ScreenBuilder background(@NotNull
 @NotNull ScreenBackground background)
                                  throws IllegalArgumentException

Sets the background of the screen.

Parameters:

background - The background of the screen.

Returns:

this class, for chaining

Throws:

IllegalArgumentException - if the background is null

layout

@NotNull
public @NotNull ScreenBuilder layout(@Nullable
 @Nullable Layout layout)

Sets the layout of the screen.

Parameters:

layout - The layout of the screen.

Returns:

this class, for chaining

layout

@NotNull
public @NotNull ScreenBuilder layout(@NotNull
 @NotNull Supplier<Layout> layout)
                              throws IllegalArgumentException

Sets the layout of the screen.

Parameters:

layout - The generator for the screen layout.

Returns:

this class, for chaining

Throws:

IllegalArgumentException - if the generator is null

build

@NotNull
public @NotNull CustomScreen build()

Builds the screen.

Returns:

The built screen.

builder

@NotNull
public static @NotNull ScreenBuilder builder()

Creates a new ScreenBuilder with a new CustomScreen, with an empty title.

Returns:

ScreenBuilder

builder

@NotNull
public static @NotNull ScreenBuilder builder(@NotNull
 @NotNull Text title)

Creates a new ScreenBuilder with a new CustomScreen, with the given title.

Parameters:

title - The title of the screen.

Returns:

ScreenBuilder