Package xyz.xenondevs.invui.gui

Interface ScrollGui<C>

All Superinterfaces:

Gui

All Known Implementing Classes:

AbstractScrollGui

public interface ScrollGui<C>
extends Gui

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ScrollGui.Builder<C>	A ScrollGui builder.

Method Summary

Modifier and Type	Method	Description
void	addScrollHandler(@NotNull BiConsumer<Integer,Integer> scrollHandler)	Adds a scroll handler to this ScrollGui.
void	bake()	Bakes the elements of this PagedGui based on the current content.
boolean	canScroll(int lines)	Checks if it is possible to scroll the specified amount of lines.
int	getCurrentLine()	Gets the current line of this ScrollGui.
int	getMaxLine()	Gets the max line index of this ScrollGui.
static @NotNull ScrollGui.Builder<@NotNull Gui>	guis()	Creates a new Gui Builder for a ScrollGui that uses Guis as content.
static @NotNull ScrollGui<@NotNull Gui>	guis(@NotNull Consumer<@NotNull ScrollGui.Builder<@NotNull Gui>> consumer)	Creates a new ScrollGui that uses Guis as content after configuring a Gui Builder using the given Consumer.
static @NotNull ScrollGui.Builder<@NotNull Inventory>	inventories()	Creates a new Gui Builder for a ScrollGui that uses VirtualInventories as content.
static @NotNull ScrollGui<@NotNull Inventory>	inventories(@NotNull Consumer<@NotNull ScrollGui.Builder<@NotNull Inventory>> consumer)	Creates a new ScrollGui that uses VirtualInventories as content after configuring a Gui Builder using the given Consumer.
static @NotNull ScrollGui.Builder<@NotNull Item>	items()	Creates a new Gui Builder for a ScrollGui that uses Items as content.
static @NotNull ScrollGui<@NotNull Item>	items(@NotNull Consumer<@NotNull ScrollGui.Builder<@NotNull Item>> consumer)	Creates a new ScrollGui that uses Items as content after configuring a Gui Builder using the given Consumer.
static @NotNull ScrollGui<@NotNull Gui>	ofGuis(int width, int height, @NotNull List<@NotNull Gui> guis, int... contentListSlots)	Creates a new ScrollGui.
static @NotNull ScrollGui<@NotNull Gui>	ofGuis(Structure structure, @NotNull List<@NotNull Gui> guis)	Creates a new ScrollGui.
static @NotNull ScrollGui<@NotNull Inventory>	ofInventories(int width, int height, @NotNull List<@NotNull Inventory> inventories, int... contentListSlots)	Creates a new ScrollGui.
static @NotNull ScrollGui<@NotNull Inventory>	ofInventories(@NotNull Structure structure, @NotNull List<@NotNull Inventory> inventories)	Creates a new ScrollGui.
static @NotNull ScrollGui<@NotNull Item>	ofItems(int width, int height, @NotNull List<@NotNull Item> items, int... contentListSlots)	Creates a new ScrollGui.
static @NotNull ScrollGui<@NotNull Item>	ofItems(@NotNull Structure structure, @NotNull List<@NotNull Item> items)	Creates a new ScrollGui.
void	removeScrollHandler(@NotNull BiConsumer<Integer,Integer> scrollHandler)	Removes the specified scroll handler from this ScrollGui.
void	scroll(int lines)	Scrolls the specified amount of lines.
void	setContent(@Nullable List<@NotNull C> content)	Sets the content of this ScrollGui for all lines.
void	setCurrentLine(int line)	Sets the current line of this ScrollGui.
void	setScrollHandlers(@NotNull List<@NotNull BiConsumer<Integer,Integer>> scrollHandlers)	Replaces the currently registered scroll handlers with the specified ones.

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

addItems, addSlotElements, applyStructure, cancelAnimation, closeForAllViewers, fill, fill, fillBorders, fillColumn, fillRectangle, fillRectangle, fillRectangle, fillRectangle, fillRow, findAllCurrentViewers, findAllWindows, getBackground, getHeight, getItem, getItem, getSize, getSlotElement, getSlotElement, getSlotElements, getWidth, hasSlotElement, hasSlotElement, isFrozen, isIgnoreObscuredInventorySlots, playAnimation, remove, remove, setBackground, setFrozen, setIgnoreObscuredInventorySlots, setItem, setItem, setSlotElement, setSlotElement

Method Details

items

@NotNull
static @NotNull ScrollGui.Builder<@NotNull Item> items()

Creates a new Gui Builder for a ScrollGui that uses Items as content.

Returns:

The new Gui Builder.

items

@NotNull
static @NotNull ScrollGui<@NotNull Item> items(@NotNull
 @NotNull Consumer<@NotNull ScrollGui.Builder<@NotNull Item>> consumer)

Creates a new ScrollGui that uses Items as content after configuring a Gui Builder using the given Consumer.

Parameters:

consumer - The Consumer to configure the Gui Builder.

Returns:

The created ScrollGui.

ofItems

@NotNull
static @NotNull ScrollGui<@NotNull Item> ofItems(int width,
 int height,
 @NotNull
 @NotNull List<@NotNull Item> items,
 int... contentListSlots)

Creates a new ScrollGui.

Parameters:

width - The width of the ScrollGui.

height - The height of the ScrollGui.

items - The Items to use.

contentListSlots - The slots where content should be displayed.

Returns:

The created ScrollGui.

ofItems

@NotNull
static @NotNull ScrollGui<@NotNull Item> ofItems(@NotNull
 @NotNull Structure structure,
 @NotNull
 @NotNull List<@NotNull Item> items)

Creates a new ScrollGui.

Parameters:

structure - The Structure to use.

items - The Items to use.

Returns:

The created ScrollGui.

guis

@NotNull
static @NotNull ScrollGui.Builder<@NotNull Gui> guis()

Creates a new Gui Builder for a ScrollGui that uses Guis as content.

Returns:

The new Gui Builder.

guis

@NotNull
static @NotNull ScrollGui<@NotNull Gui> guis(@NotNull
 @NotNull Consumer<@NotNull ScrollGui.Builder<@NotNull Gui>> consumer)

Creates a new ScrollGui that uses Guis as content after configuring a Gui Builder using the given Consumer.

Parameters:

consumer - The Consumer to configure the Gui Builder.

Returns:

The created ScrollGui.

ofGuis

@NotNull
static @NotNull ScrollGui<@NotNull Gui> ofGuis(int width,
 int height,
 @NotNull
 @NotNull List<@NotNull Gui> guis,
 int... contentListSlots)

Creates a new ScrollGui.

Parameters:

width - The width of the ScrollGui.

height - The height of the ScrollGui.

guis - The Guis to use.

contentListSlots - The slots where content should be displayed.

Returns:

The created ScrollGui.

ofGuis

@NotNull
static @NotNull ScrollGui<@NotNull Gui> ofGuis(Structure structure,
 @NotNull
 @NotNull List<@NotNull Gui> guis)

Creates a new ScrollGui.

Parameters:

structure - The Structure to use.

guis - The Guis to use.

Returns:

The created ScrollGui.

inventories

@NotNull
static @NotNull ScrollGui.Builder<@NotNull Inventory> inventories()

Creates a new Gui Builder for a ScrollGui that uses VirtualInventories as content.

Returns:

The new Gui Builder.

inventories

@NotNull
static @NotNull ScrollGui<@NotNull Inventory> inventories(@NotNull
 @NotNull Consumer<@NotNull ScrollGui.Builder<@NotNull Inventory>> consumer)

Creates a new ScrollGui that uses VirtualInventories as content after configuring a Gui Builder using the given Consumer.

Parameters:

consumer - The Consumer to configure the Gui Builder.

Returns:

The created ScrollGui.

ofInventories

@NotNull
static @NotNull ScrollGui<@NotNull Inventory> ofInventories(int width,
 int height,
 @NotNull
 @NotNull List<@NotNull Inventory> inventories,
 int... contentListSlots)

Creates a new ScrollGui.

Parameters:

width - The width of the ScrollGui.

height - The height of the ScrollGui.

inventories - The VirtualInventories to use.

contentListSlots - The slots where content should be displayed.

Returns:

The created ScrollGui.

ofInventories

@NotNull
static @NotNull ScrollGui<@NotNull Inventory> ofInventories(@NotNull
 @NotNull Structure structure,
 @NotNull
 @NotNull List<@NotNull Inventory> inventories)

Creates a new ScrollGui.

Parameters:

structure - The Structure to use.

inventories - The VirtualInventories to use.

Returns:

The created ScrollGui.

getCurrentLine

int getCurrentLine()

Gets the current line of this ScrollGui.

Returns:

The current line of this ScrollGui.

getMaxLine

int getMaxLine()

Gets the max line index of this ScrollGui.

Returns:

The max line index of this ScrollGui.

setCurrentLine

void setCurrentLine(int line)

Sets the current line of this ScrollGui.

Parameters:

line - The line to set.

canScroll

boolean canScroll(int lines)

Checks if it is possible to scroll the specified amount of lines.

Parameters:

lines - The amount of lines to check.

Returns:

Whether it is possible to scroll the specified amount of lines.

scroll

void scroll(int lines)

Scrolls the specified amount of lines.

Parameters:

lines - The amount of lines to scroll.

setContent

void setContent(@Nullable
 @Nullable List<@NotNull C> content)

Sets the content of this ScrollGui for all lines.

Parameters:

content - The content to set.

bake

void bake()

Bakes the elements of this PagedGui based on the current content.

This method does not need to be called when using setContent(List), but is required when the size of the content itself changes.

setScrollHandlers

void setScrollHandlers(@NotNull
 @NotNull List<@NotNull BiConsumer<Integer,Integer>> scrollHandlers)

Replaces the currently registered scroll handlers with the specified ones.

Parameters:

scrollHandlers - The new scroll handlers.

addScrollHandler

void addScrollHandler(@NotNull
 @NotNull BiConsumer<Integer,Integer> scrollHandler)

Adds a scroll handler to this ScrollGui.

Parameters:

scrollHandler - The scroll handler to add.

removeScrollHandler

void removeScrollHandler(@NotNull
 @NotNull BiConsumer<Integer,Integer> scrollHandler)

Removes the specified scroll handler from this ScrollGui.

Parameters:

scrollHandler - The scroll handler to remove.