Package dev.triumphteam.gui.guis

Class ScrollingGui

java.lang.Object

dev.triumphteam.gui.guis.BaseGui

dev.triumphteam.gui.guis.PaginatedGui

dev.triumphteam.gui.guis.ScrollingGui

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder

public class ScrollingGui
extends PaginatedGui

GUI that allows you to scroll through items

Constructor Summary

Constructors

Constructor	Description
ScrollingGui(int rows, int pageSize, @NotNull String title)	Deprecated. In favor of ScrollingGui(int, int, String, ScrollType, Set)
ScrollingGui(int rows, int pageSize, @NotNull String title, @NotNull ScrollType scrollType)	Deprecated. In favor of ScrollingGui(int, int, String, ScrollType, Set)
ScrollingGui(int rows, int pageSize, @NotNull String title, @NotNull ScrollType scrollType, @NotNull Set<InteractionModifier> interactionModifiers)	Main constructor of the Scrolling GUI
ScrollingGui(int rows, @NotNull String title)	Deprecated. In favor of ScrollingGui(int, int, String, ScrollType, Set)
ScrollingGui(int rows, @NotNull String title, @NotNull ScrollType scrollType)	Deprecated. In favor of ScrollingGui(int, int, String, ScrollType, Set)
ScrollingGui(@NotNull String title)	Deprecated. In favor of ScrollingGui(int, int, String, ScrollType, Set)
ScrollingGui(@NotNull String title, @NotNull ScrollType scrollType)	Deprecated. In favor of ScrollingGui(int, int, String, ScrollType, Set)

Method Summary

Modifier and Type	Method	Description
boolean	next()	Overrides PaginatedGui.next() to make it work with the specific scrolls
void	open(@NotNull org.bukkit.entity.HumanEntity player)	Overrides PaginatedGui.open(HumanEntity) to make it work with the specific scrolls
void	open(@NotNull org.bukkit.entity.HumanEntity player, int openPage)	Overrides PaginatedGui.open(HumanEntity, int) to make it work with the specific scrolls
boolean	previous()	Overrides PaginatedGui.previous() to make it work with the specific scrolls

Methods inherited from class dev.triumphteam.gui.guis.PaginatedGui

addItem, addItem, clearPageItems, clearPageItems, getCurrentPageItems, getCurrentPageNum, getNextPageNum, getPageItems, getPagesNum, getPrevPageNum, removePageItem, removePageItem, setPageSize, update, updatePageItem, updatePageItem, updatePageItem, updatePageItem, updateTitle

Methods inherited from class dev.triumphteam.gui.guis.BaseGui

addItem, addSlotAction, addSlotAction, allowsOtherActions, canDropItems, canPlaceItems, canSwapItems, canTakeItems, close, close, disableAllInteractions, disableItemDrop, disableItemPlace, disableItemSwap, disableItemTake, disableOtherActions, enableAllInteractions, enableItemDrop, enableItemPlace, enableItemSwap, enableItemTake, enableOtherActions, getFiller, getGuiItem, getGuiItems, getInventory, getRows, getTitle, guiType, isUpdating, removeItem, removeItem, removeItem, removeItem, setCloseGuiAction, setDefaultClickAction, setDefaultTopClickAction, setDragAction, setInventory, setItem, setItem, setItem, setOpenGuiAction, setOutsideClickAction, setPlayerInventoryAction, setUpdating, title, updateItem, updateItem, updateItem, updateItem

Methods inherited from class java.lang.Object

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

Constructor Details

ScrollingGui

public ScrollingGui(int rows,
 int pageSize,
 @NotNull
 @NotNull String title,
 @NotNull
 @NotNull ScrollType scrollType,
 @NotNull
 @NotNull Set<InteractionModifier> interactionModifiers)

Main constructor of the Scrolling GUI

Parameters:

rows - The rows the GUI should have

pageSize - The Page size

title - The title using String

scrollType - The ScrollType

interactionModifiers - A set containing the InteractionModifier this GUI should use

Since:

3.0.3

ScrollingGui

@Deprecated
public ScrollingGui(int rows,
 int pageSize,
 @NotNull
 @NotNull String title,
 @NotNull
 @NotNull ScrollType scrollType)

Deprecated.

In favor of ScrollingGui(int, int, String, ScrollType, Set)

Main constructor of the Scrolling GUI

Parameters:

rows - The rows the GUI should have

pageSize - The Page size

title - The GUI's title

scrollType - The ScrollType

ScrollingGui

@Deprecated
public ScrollingGui(int rows,
 int pageSize,
 @NotNull
 @NotNull String title)

Deprecated.

In favor of ScrollingGui(int, int, String, ScrollType, Set)

Alternative constructor that doesn't require the ScrollType

Parameters:

rows - The rows the GUI should have

pageSize - The Page size

title - The GUI's title

ScrollingGui

@Deprecated
public ScrollingGui(int rows,
 @NotNull
 @NotNull String title)

Deprecated.

In favor of ScrollingGui(int, int, String, ScrollType, Set)

Alternative constructor that doesn't require the ScrollType or page size

Parameters:

rows - The rows the GUI should have

title - The GUI's title

ScrollingGui

@Deprecated
public ScrollingGui(int rows,
 @NotNull
 @NotNull String title,
 @NotNull
 @NotNull ScrollType scrollType)

Deprecated.

In favor of ScrollingGui(int, int, String, ScrollType, Set)

Alternative constructor that doesn't require the page size

Parameters:

rows - The rows the GUI should have

title - The GUI's title

scrollType - The ScrollType

ScrollingGui

@Deprecated
public ScrollingGui(@NotNull
 @NotNull String title)

Deprecated.

In favor of ScrollingGui(int, int, String, ScrollType, Set)

Alternative constructor that only requires title

Parameters:

title - The GUI's title

ScrollingGui

@Deprecated
public ScrollingGui(@NotNull
 @NotNull String title,
 @NotNull
 @NotNull ScrollType scrollType)

Deprecated.

In favor of ScrollingGui(int, int, String, ScrollType, Set)

Alternative constructor that doesn't require the rows or page size

Parameters:

title - The GUI's title

scrollType - The ScrollType

Method Details

next

public boolean next()

Overrides PaginatedGui.next() to make it work with the specific scrolls

Overrides:

next in class PaginatedGui

Returns:

False if there is no next page.

previous

public boolean previous()

Overrides PaginatedGui.previous() to make it work with the specific scrolls

Overrides:

previous in class PaginatedGui

Returns:

False if there is no previous page.

open

public void open(@NotNull
 @NotNull org.bukkit.entity.HumanEntity player)

Overrides PaginatedGui.open(HumanEntity) to make it work with the specific scrolls

Overrides:

open in class PaginatedGui

Parameters:

player - The HumanEntity to open the GUI to

open

public void open(@NotNull
 @NotNull org.bukkit.entity.HumanEntity player,
 int openPage)

Overrides PaginatedGui.open(HumanEntity, int) to make it work with the specific scrolls

Overrides:

open in class PaginatedGui

Parameters:

player - The HumanEntity to open the GUI to

openPage - The page to open on