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
@NotNull ScrollingGui	create()	Creates a new ScrollingGui
@NotNull ScrollingBuilder	pageSize(int pageSize)	Sets the desirable page size, most of the times this isn't needed
@NotNull ScrollingBuilder	scrollType(@NotNull ScrollType scrollType)	Sets the ScrollType to be used

Methods inherited from class dev.triumphteam.gui.builder.gui.BaseGuiBuilder

apply, disableAllInteractions, disableItemDrop, disableItemPlace, disableItemSwap, disableItemTake, disableOtherActions, enableAllInteractions, enableItemDrop, enableItemPlace, enableItemSwap, enableItemTake, enableOtherActions, getConsumer, getModifiers, getRows, getTitle, rows, title

Methods inherited from class java.lang.Object

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

Constructor Details

ScrollingBuilder

public ScrollingBuilder(@NotNull
 @NotNull ScrollType scrollType)

Main constructor

Parameters:

scrollType - The ScrollType to default to

Method Details

scrollType

@NotNull
@Contract("_ -> this")
public @NotNull ScrollingBuilder scrollType(@NotNull
 @NotNull ScrollType scrollType)

Sets the ScrollType to be used

Parameters:

scrollType - Either horizontal or vertical scrolling

Returns:

The current builder

pageSize

@NotNull
@Contract("_ -> this")
public @NotNull ScrollingBuilder pageSize(int 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

@NotNull
@Contract(" -> new")
public @NotNull ScrollingGui create()

Creates a new ScrollingGui

Specified by:

create in class BaseGuiBuilder<ScrollingGui,ScrollingBuilder>

Returns:

A new ScrollingGui