me.mattstudios.mfgui.gui.guis

Class ScrollingGui

java.lang.Object

me.mattstudios.mfgui.gui.guis.BaseGui

me.mattstudios.mfgui.gui.guis.PaginatedGui

me.mattstudios.mfgui.gui.guis.ScrollingGui

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder

public final class ScrollingGui
extends PaginatedGui

GUI that allows you to scroll through items

Constructor Summary

Constructors

Constructor and Description
ScrollingGui(int rows, int pageSize, @NotNull String title) Alternative constructor that doesn't require the ScrollType
ScrollingGui(int rows, int pageSize, @NotNull String title, @NotNull ScrollType scrollType) Main constructor of the Scrolling GUI
ScrollingGui(int rows, @NotNull String title) Alternative constructor that doesn't require the ScrollType or page size
ScrollingGui(int rows, @NotNull String title, @NotNull ScrollType scrollType) Alternative constructor that doesn't require the page size
ScrollingGui(@NotNull String title) Alternative constructor that only requires title
ScrollingGui(@NotNull String title, @NotNull ScrollType scrollType) Alternative constructor that doesn't require the rows or page size

Method Summary

Modifier and Type	Method and 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 me.mattstudios.mfgui.gui.guis.PaginatedGui

addItem, addItem, getCurrentPageItems, getCurrentPageNum, getNextPageNum, getPageItems, getPrevPageNum, nextPage, prevPage, setPageSize, update, updatePageItem, updatePageItem, updatePageItem, updatePageItem, updateTitle

Methods inherited from class me.mattstudios.mfgui.gui.guis.BaseGui

addSlotAction, addSlotAction, close, getFiller, getGuiItem, getGuiItems, getInventory, getRows, isUpdating, setCloseGuiAction, setDefaultClickAction, setDefaultTopClickAction, setDragAction, setItem, setItem, setItem, setOpenGuiAction, setOutsideClickAction, setRows, setUpdating, updateItem, updateItem, updateItem, updateItem

Methods inherited from class java.lang.Object

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

Constructor Detail

ScrollingGui

public ScrollingGui(int rows,
                    int pageSize,
                    @NotNull
                    @NotNull String title,
                    @NotNull
                    @NotNull ScrollType 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

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

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

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

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

public ScrollingGui(int rows,
                    @NotNull
                    @NotNull String title,
                    @NotNull
                    @NotNull ScrollType 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

public ScrollingGui(@NotNull
                    @NotNull String title)

Alternative constructor that only requires title

Parameters:

title - The GUI's title

ScrollingGui

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

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

Parameters:

title - The GUI's title

scrollType - The ScrollType

Method Detail

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