Package xyz.xenondevs.invui.gui

Class AbstractPagedGui.AbstractBuilder<C>

java.lang.Object

xyz.xenondevs.invui.gui.AbstractGui.AbstractBuilder<PagedGui<C>,PagedGui.Builder<C>>

xyz.xenondevs.invui.gui.AbstractPagedGui.AbstractBuilder<C>

Type Parameters:

C - The content type.

All Implemented Interfaces:

Cloneable, Gui.Builder<PagedGui<C>,PagedGui.Builder<C>>, PagedGui.Builder<C>

Enclosing class:

AbstractPagedGui<C>

public abstract static class AbstractPagedGui.AbstractBuilder<C>
extends AbstractGui.AbstractBuilder<PagedGui<C>,PagedGui.Builder<C>>
implements PagedGui.Builder<C>

Builder for AbstractPagedGui.

This class should only be used directly if you're creating a custom AbstractPagedGui.AbstractBuilder implementation. Otherwise, use the static builder functions from PagedGui, such as PagedGui.items(), PagedGui.guis() or PagedGui.inventories() to obtain a builder instance.

Nested Class Summary

Nested classes/interfaces inherited from interface xyz.xenondevs.invui.gui.Gui.Builder

Gui.Builder.Normal

Field Summary

Fields

Modifier and Type	Field	Description
protected List<C>	content	The content of the AbstractPagedGui.
protected List<BiConsumer<Integer,Integer>>	pageChangeHandlers	The page change handlers of the AbstractPagedGui.

Fields inherited from class xyz.xenondevs.invui.gui.AbstractGui.AbstractBuilder

background, frozen, ignoreObscuredInventorySlots, modifiers, structure

Constructor Summary

Constructors

Constructor	Description
AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
@NotNull PagedGui.Builder<C>	addContent(C content)	Adds content to the PagedGui.
@NotNull PagedGui.Builder<C>	addPageChangeHandler(@NotNull BiConsumer<Integer,Integer> handler)	Adds a page change handler to the PagedGui.
protected void	applyModifiers(@NotNull PagedGui<C> gui)	Applies the AbstractGui.AbstractBuilder.modifiers to the given AbstractGui.
PagedGui.Builder<C>	clone()	Clones the Gui Builder.
@NotNull PagedGui.Builder<C>	setContent(@NotNull List<@NotNull C> content)	Sets the content of the PagedGui for all pages.
@NotNull PagedGui.Builder<C>	setPageChangeHandlers(@NotNull List<@NotNull BiConsumer<Integer,Integer>> handlers)	Sets the page change handlers of the PagedGui.

Methods inherited from class xyz.xenondevs.invui.gui.AbstractGui.AbstractBuilder

addIngredient, addIngredient, addIngredient, addIngredient, addIngredient, addIngredient, addIngredient, addIngredient, addIngredientElementSupplier, addModifier, setBackground, setBackground, setFrozen, setIgnoreObscuredInventorySlots, setModifiers, setStructure, setStructure, setStructure

Methods inherited from class java.lang.Object

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

Methods inherited from interface xyz.xenondevs.invui.gui.Gui.Builder

addIngredient, addIngredient, addIngredient, addIngredient, addIngredient, addIngredient, addIngredient, addIngredient, addIngredientElementSupplier, addModifier, build, setBackground, setBackground, setFrozen, setIgnoreObscuredInventorySlots, setModifiers, setStructure, setStructure, setStructure

Field Details

content

protected List<C> content

The content of the AbstractPagedGui.

pageChangeHandlers

protected List<BiConsumer<Integer,Integer>> pageChangeHandlers

The page change handlers of the AbstractPagedGui.

Constructor Details

AbstractBuilder

public AbstractBuilder()

Method Details

setContent

public @NotNull PagedGui.Builder<C> setContent(@NotNull
 @NotNull List<@NotNull C> content)

Description copied from interface: PagedGui.Builder

Sets the content of the PagedGui for all pages.

Specified by:

setContent in interface PagedGui.Builder<C>

Parameters:

content - The content to set.

Returns:

This Gui Builder.

addContent

public @NotNull PagedGui.Builder<C> addContent(@NotNull
 C content)

Description copied from interface: PagedGui.Builder

Adds content to the PagedGui.

Specified by:

addContent in interface PagedGui.Builder<C>

Parameters:

content - The content to add.

Returns:

This Gui Builder.

setPageChangeHandlers

public @NotNull PagedGui.Builder<C> setPageChangeHandlers(@NotNull
 @NotNull List<@NotNull BiConsumer<Integer,Integer>> handlers)

Description copied from interface: PagedGui.Builder

Sets the page change handlers of the PagedGui.

Specified by:

setPageChangeHandlers in interface PagedGui.Builder<C>

Parameters:

handlers - The page change handlers to set.

Returns:

This Gui Builder.

addPageChangeHandler

public @NotNull PagedGui.Builder<C> addPageChangeHandler(@NotNull
 @NotNull BiConsumer<Integer,Integer> handler)

Description copied from interface: PagedGui.Builder

Adds a page change handler to the PagedGui.

Specified by:

addPageChangeHandler in interface PagedGui.Builder<C>

Parameters:

handler - The page change handler to add.

Returns:

This Gui Builder.

applyModifiers

protected void applyModifiers(@NotNull
 @NotNull PagedGui<C> gui)

Description copied from class: AbstractGui.AbstractBuilder

Applies the AbstractGui.AbstractBuilder.modifiers to the given AbstractGui.

Overrides:

applyModifiers in class AbstractGui.AbstractBuilder<PagedGui<C>,PagedGui.Builder<C>>

Parameters:

gui - The AbstractGui to apply the modifiers to

clone

@NotNull
public PagedGui.Builder<C> clone()

Description copied from interface: Gui.Builder

Clones the Gui Builder.

Specified by:

clone in interface Gui.Builder<PagedGui<C>,PagedGui.Builder<C>>

Overrides:

clone in class AbstractGui.AbstractBuilder<PagedGui<C>,PagedGui.Builder<C>>

Returns:

The cloned Gui Builder