java.lang.Object

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 java.lang.String title)`	Deprecated. In favor of `ScrollingGui(int, int, Component)`
`ScrollingGui(int rows, int pageSize, @NotNull java.lang.String title, @NotNull ScrollType scrollType)`	Deprecated. In favor of `ScrollingGui(int, int, Component, ScrollType)`
`ScrollingGui(int rows, int pageSize, @NotNull net.kyori.adventure.text.Component title)`	Alternative constructor that doesn't require the `ScrollType`
`ScrollingGui(int rows, int pageSize, @NotNull net.kyori.adventure.text.Component title, @NotNull ScrollType scrollType)`	Alternative constructor of the Scrolling GUI, for when the GUI doesn't require any `InteractionModifier`
`ScrollingGui(int rows, int pageSize, @NotNull net.kyori.adventure.text.Component title, @NotNull ScrollType scrollType, @NotNull java.util.Set<InteractionModifier> interactionModifiers)`	Main constructor of the Scrolling GUI
`ScrollingGui(int rows, @NotNull java.lang.String title)`	Deprecated. In favor of `ScrollingGui(int, Component)`
`ScrollingGui(int rows, @NotNull java.lang.String title, @NotNull ScrollType scrollType)`	Deprecated. In favor of `ScrollingGui(int, Component, ScrollType)`
`ScrollingGui(int rows, @NotNull net.kyori.adventure.text.Component title)`	Alternative constructor that doesn't require the `ScrollType` or page size
`ScrollingGui(int rows, @NotNull net.kyori.adventure.text.Component title, @NotNull ScrollType scrollType)`	Alternative constructor that doesn't require the page size
`ScrollingGui(@NotNull java.lang.String title)`	Deprecated. In favor of `ScrollingGui(Component)`
`ScrollingGui(@NotNull java.lang.String title, @NotNull ScrollType scrollType)`	Deprecated. In favor of `ScrollingGui(Component, ScrollType)`
`ScrollingGui(@NotNull net.kyori.adventure.text.Component title)`	Alternative constructor that only requires title
`ScrollingGui(@NotNull net.kyori.adventure.text.Component title, @NotNull ScrollType scrollType)`	Alternative constructor that doesn't require the rows or page size

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, getCurrentPageItems, getCurrentPageNum, getNextPageNum, getPageItems, getPagesNum, getPrevPageNum, nextPage, prevPage, setPageSize, update, updatePageItem, updatePageItem, updatePageItem, updatePageItem, updateTitle, updateTitle

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

addSlotAction, addSlotAction, canPlaceItems, canSwapItems, canTakeItems, close, close, disableAllInteractions, disableItemPlace, disableItemSwap, disableItemTake, enableAllInteractions, enableItemPlace, enableItemSwap, enableItemTake, getFiller, getGuiItem, getGuiItems, getInventory, getRows, guiType, isUpdating, removeItem, removeItem, setCloseGuiAction, setDefaultClickAction, setDefaultTopClickAction, setDragAction, setInventory, setItem, setItem, setItem, setOpenGuiAction, setOutsideClickAction, setPlayerInventoryAction, setUpdating, updateItem, updateItem, updateItem, updateItem

Methods inherited from class java.lang.Object

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

Constructor Details
- ScrollingGui
  
  public ScrollingGui(int rows, int pageSize, @NotNull @NotNull net.kyori.adventure.text.Component title, @NotNull @NotNull ScrollType scrollType, @NotNull @NotNull java.util.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 Component
  
  scrollType - The ScrollType
  
  interactionModifiers - A set containing the InteractionModifier this GUI should use
  
  Since:
  
  3.0.0
- ScrollingGui
  
  public ScrollingGui(int rows, int pageSize, @NotNull @NotNull net.kyori.adventure.text.Component title, @NotNull @NotNull ScrollType scrollType)
  
  Alternative constructor of the Scrolling GUI, for when the GUI doesn't require any InteractionModifier
  
  Parameters:
  
  rows - The rows the GUI should have
  
  pageSize - The Page size
  
  title - The title using Component
  
  scrollType - The ScrollType
  
  Since:
  
  3.0.0
- ScrollingGui
  
  public ScrollingGui(int rows, int pageSize, @NotNull @NotNull net.kyori.adventure.text.Component title)
  
  Alternative constructor that doesn't require the ScrollType
  
  Parameters:
  
  rows - The rows the GUI should have
  
  pageSize - The Page size
  
  title - The title using Component
  
  Since:
  
  3.0.0
- ScrollingGui
  
  public ScrollingGui(int rows, @NotNull @NotNull net.kyori.adventure.text.Component title, @NotNull @NotNull ScrollType scrollType)
  
  Alternative constructor that doesn't require the page size
  
  Parameters:
  
  rows - The rows the GUI should have
  
  title - The title using Component
  
  scrollType - The ScrollType
  
  Since:
  
  3.0.0
- ScrollingGui
  
  public ScrollingGui(int rows, @NotNull @NotNull net.kyori.adventure.text.Component title)
  
  Alternative constructor that doesn't require the ScrollType or page size
  
  Parameters:
  
  rows - The rows the GUI should have
  
  title - The title using Component
  
  Since:
  
  3.0.0
- ScrollingGui
  
  public ScrollingGui(@NotNull @NotNull net.kyori.adventure.text.Component title, @NotNull @NotNull ScrollType scrollType)
  
  Alternative constructor that doesn't require the rows or page size
  
  Parameters:
  
  title - The title using Component
  
  scrollType - The ScrollType
  
  Since:
  
  3.0.0
- ScrollingGui
  
  public ScrollingGui(@NotNull @NotNull net.kyori.adventure.text.Component title)
  
  Alternative constructor that only requires title
  
  Parameters:
  
  title - The title using Component
- ScrollingGui
  
  @Deprecated public ScrollingGui(int rows, int pageSize, @NotNull @NotNull java.lang.String title, @NotNull @NotNull ScrollType scrollType)
  
  Deprecated.
  In favor of ScrollingGui(int, int, Component, ScrollType)
  
  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 java.lang.String title)
  
  Deprecated.
  In favor of ScrollingGui(int, int, Component)
  
  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 java.lang.String title)
  
  Deprecated.
  In favor of ScrollingGui(int, Component)
  
  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 java.lang.String title, @NotNull @NotNull ScrollType scrollType)
  
  Deprecated.
  In favor of ScrollingGui(int, Component, ScrollType)
  
  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 java.lang.String title)
  
  Deprecated.
  In favor of ScrollingGui(Component)
  
  Alternative constructor that only requires title
  
  Parameters:
  
  title - The GUI's title
- ScrollingGui
  
  @Deprecated public ScrollingGui(@NotNull @NotNull java.lang.String title, @NotNull @NotNull ScrollType scrollType)
  
  Deprecated.
  In favor of ScrollingGui(Component, ScrollType)
  
  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
- previous
  
  public boolean previous()
  
  Overrides PaginatedGui.previous() to make it work with the specific scrolls
  
  Overrides:
  
  previous in class PaginatedGui
- 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

Class ScrollingGui

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Details

Method Details