Package xyz.xenondevs.invui.window

Class AbstractWindow.AbstractBuilder<W extends Window,S extends Window.Builder<W,S>>

java.lang.Object

xyz.xenondevs.invui.window.AbstractWindow.AbstractBuilder<W,S>

Type Parameters:

W - The type of the window.

S - The type of the builder.

All Implemented Interfaces:

Cloneable, Window.Builder<W,S>

Direct Known Subclasses:

AbstractSingleWindow.AbstractBuilder, AbstractSplitWindow.AbstractBuilder

Enclosing class:

AbstractWindow

public abstract static class AbstractWindow.AbstractBuilder<W extends Window,S extends Window.Builder<W,S>>
extends Object
implements Window.Builder<W,S>

Builder for a AbstractWindow.

This class should only be used directly if you're creating a custom AbstractWindow.AbstractBuilder for a custom AbstractWindow implementation. Otherwise, use the static builder functions in the Window interfaces, such as Window.single() to obtain a builder.

Nested Class Summary

Nested classes/interfaces inherited from interface xyz.xenondevs.invui.window.Window.Builder

Window.Builder.Double<W extends Window,S extends Window.Builder.Double<W,S>>, Window.Builder.Normal<V,S extends Window.Builder.Normal<V,S>>, Window.Builder.Single<W extends Window,S extends Window.Builder.Single<W,S>>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	closeable
protected List<Runnable>	closeHandlers
protected List<Consumer<W>>	modifiers
protected List<Runnable>	openHandlers
protected List<Consumer<org.bukkit.event.inventory.InventoryClickEvent>>	outsideClickHandlers
protected xyz.xenondevs.inventoryaccess.component.ComponentWrapper	title
protected org.bukkit.entity.Player	viewer

Constructor Summary

Constructors

Constructor	Description
AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
S	addCloseHandler(@NotNull Runnable closeHandler)	Adds a close handler to the Window.
S	addModifier(@NotNull Consumer<@NotNull W> modifier)	Adds a modifier to the Window.
S	addOpenHandler(@NotNull Runnable openHandler)	Adds an open handler to the Window.
S	addOutsideClickHandler(@NotNull Consumer<@NotNull org.bukkit.event.inventory.InventoryClickEvent> outsideClickHandler)	Adds an outside click handler to the Window.
protected void	applyModifiers(W window)
W	build()	Builds the Window.
S	clone()	Clones the Window Builder.
void	open(org.bukkit.entity.Player viewer)	Builds and shows the Window to the specified viewer.
S	setCloseable(boolean closeable)	Configures if the Window is closeable.
S	setCloseHandlers(@Nullable List<@NotNull Runnable> closeHandlers)	Sets the close handlers of the Window.
S	setModifiers(@Nullable List<@NotNull Consumer<@NotNull W>> modifiers)	Sets the modifiers of the Window.
S	setOpenHandlers(@Nullable List<@NotNull Runnable> openHandlers)	Sets the open handlers of the Window.
S	setOutsideClickHandlers(@NotNull List<@NotNull Consumer<@NotNull org.bukkit.event.inventory.InventoryClickEvent>> outsideClickHandlers)	Sets the outside click handlers of the Window.
S	setTitle(@NotNull String title)	Sets the title of the Window.
S	setTitle(@NotNull net.md_5.bungee.api.chat.BaseComponent @NotNull [] title)	Sets the title of the Window.
S	setTitle(@NotNull xyz.xenondevs.inventoryaccess.component.ComponentWrapper title)	Sets the title of the Window.
S	setViewer(@NotNull org.bukkit.entity.Player viewer)	Sets the viewer of the Window.

Methods inherited from class java.lang.Object

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

Methods inherited from interface xyz.xenondevs.invui.window.Window.Builder

build

Field Details

viewer

protected org.bukkit.entity.Player viewer

title

protected xyz.xenondevs.inventoryaccess.component.ComponentWrapper title

closeable

protected boolean closeable

openHandlers

protected List<Runnable> openHandlers

closeHandlers

protected List<Runnable> closeHandlers

outsideClickHandlers

protected List<Consumer<org.bukkit.event.inventory.InventoryClickEvent>> outsideClickHandlers

modifiers

protected List<Consumer<W extends Window>> modifiers

Constructor Details

AbstractBuilder

public AbstractBuilder()

Method Details

setViewer

@NotNull
public S setViewer(@NotNull
 @NotNull org.bukkit.entity.Player viewer)

Description copied from interface: Window.Builder

Sets the viewer of the Window.

Specified by:

setViewer in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

viewer - The viewer of the Window

Returns:

This Window Builder

setTitle

@NotNull
public S setTitle(@NotNull
 @NotNull xyz.xenondevs.inventoryaccess.component.ComponentWrapper title)

Description copied from interface: Window.Builder

Sets the title of the Window.

Specified by:

setTitle in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

title - The title of the Window

Returns:

This Window Builder

setTitle

@NotNull
public S setTitle(@NotNull
 @NotNull net.md_5.bungee.api.chat.BaseComponent @NotNull [] title)

Description copied from interface: Window.Builder

Sets the title of the Window.

Specified by:

setTitle in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

title - The title of the Window

Returns:

This Window Builder

setTitle

@NotNull
public S setTitle(@NotNull
 @NotNull String title)

Description copied from interface: Window.Builder

Sets the title of the Window.

Specified by:

setTitle in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

title - The title of the Window

Returns:

This Window Builder

setCloseable

@NotNull
public S setCloseable(boolean closeable)

Description copied from interface: Window.Builder

Configures if the Window is closeable.

Specified by:

setCloseable in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

closeable - If the Window is closeable

Returns:

This Window Builder

setOpenHandlers

@NotNull
public S setOpenHandlers(@Nullable
 @Nullable List<@NotNull Runnable> openHandlers)

Description copied from interface: Window.Builder

Sets the open handlers of the Window.

Specified by:

setOpenHandlers in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

openHandlers - The open handlers of the Window

Returns:

This Window Builder

addOpenHandler

@NotNull
public S addOpenHandler(@NotNull
 @NotNull Runnable openHandler)

Description copied from interface: Window.Builder

Adds an open handler to the Window.

Specified by:

addOpenHandler in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

openHandler - The open handler to add

Returns:

This Window Builder

setCloseHandlers

@NotNull
public S setCloseHandlers(@Nullable
 @Nullable List<@NotNull Runnable> closeHandlers)

Description copied from interface: Window.Builder

Sets the close handlers of the Window.

Specified by:

setCloseHandlers in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

closeHandlers - The close handlers of the Window

Returns:

This Window Builder

addCloseHandler

@NotNull
public S addCloseHandler(@NotNull
 @NotNull Runnable closeHandler)

Description copied from interface: Window.Builder

Adds a close handler to the Window.

Specified by:

addCloseHandler in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

closeHandler - The close handler to add

Returns:

This Window Builder

setOutsideClickHandlers

@NotNull
public S setOutsideClickHandlers(@NotNull
 @NotNull List<@NotNull Consumer<@NotNull org.bukkit.event.inventory.InventoryClickEvent>> outsideClickHandlers)

Description copied from interface: Window.Builder

Sets the outside click handlers of the Window.

Specified by:

setOutsideClickHandlers in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

outsideClickHandlers - The outside click handlers of the Window

Returns:

This Window Builder

addOutsideClickHandler

@NotNull
public S addOutsideClickHandler(@NotNull
 @NotNull Consumer<@NotNull org.bukkit.event.inventory.InventoryClickEvent> outsideClickHandler)

Description copied from interface: Window.Builder

Adds an outside click handler to the Window.

Specified by:

addOutsideClickHandler in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

outsideClickHandler - The outside click handler to add

Returns:

This Window Builder

setModifiers

@NotNull
public S setModifiers(@Nullable
 @Nullable List<@NotNull Consumer<@NotNull W>> modifiers)

Description copied from interface: Window.Builder

Sets the modifiers of the Window.

Specified by:

setModifiers in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

modifiers - The modifiers of the Window

Returns:

This Window Builder

addModifier

@NotNull
public S addModifier(@NotNull
 @NotNull Consumer<@NotNull W> modifier)

Description copied from interface: Window.Builder

Adds a modifier to the Window.

Specified by:

addModifier in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

modifier - The modifier to add

Returns:

This Window Builder

applyModifiers

protected void applyModifiers(W window)

build

@NotNull
public W build()

Description copied from interface: Window.Builder

Builds the Window.

Specified by:

build in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Returns:

The built Window

open

public void open(org.bukkit.entity.Player viewer)

Description copied from interface: Window.Builder

Builds and shows the Window to the specified viewer. If this method is used, the viewer does not need to be set using Window.Builder.setViewer(Player).

Specified by:

open in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Parameters:

viewer - The Player to show the Window to.

clone

@NotNull
public S clone()

Description copied from interface: Window.Builder

Clones the Window Builder.

Specified by:

clone in interface Window.Builder<W extends Window,S extends Window.Builder<W,S>>

Overrides:

clone in class Object

Returns:

The cloned Window Builder