Package dev.triumphteam.gui.builder.gui
Class ScrollingBuilder
java.lang.Object
dev.triumphteam.gui.builder.gui.BaseGuiBuilder<ScrollingGui,ScrollingBuilder>
dev.triumphteam.gui.builder.gui.ScrollingBuilder
public final class ScrollingBuilder extends BaseGuiBuilder<ScrollingGui,ScrollingBuilder>
The simple GUI builder is used for creating a
ScrollingGui
that uses Component
for title
TODO This class needs more work to remove the redundant pageSize since it's the same as the paginated builder-
Constructor Summary
Constructors Constructor Description ScrollingBuilder(@NotNull ScrollType scrollType)
Main constructor -
Method Summary
Modifier and Type Method Description ScrollingGui
create()
Creates a newScrollingGui
ScrollingBuilder
pageSize(int pageSize)
Sets the desirable page size, most of the times this isn't neededScrollingBuilder
scrollType(@NotNull ScrollType scrollType)
Sets theScrollType
to be usedMethods inherited from class dev.triumphteam.gui.builder.gui.BaseGuiBuilder
apply, disableAllInteractions, disableItemPlace, disableItemSwap, disableItemTake, enableAllInteractions, enableItemPlace, enableItemSwap, enableItemTake, rows, title
-
Constructor Details
-
ScrollingBuilder
Main constructor- Parameters:
scrollType
- TheScrollType
to default to
-
-
Method Details
-
scrollType
Sets theScrollType
to be used- Parameters:
scrollType
- Either horizontal or vertical scrolling- Returns:
- The current builder
-
pageSize
Sets the desirable page size, most of the times this isn't needed- Parameters:
pageSize
- The amount of free slots that page items should occupy- Returns:
- The current builder
-
create
Creates a newScrollingGui
- Specified by:
create
in classBaseGuiBuilder<ScrollingGui,ScrollingBuilder>
- Returns:
- A new
ScrollingGui
-