Package io.github.mqzn.commands.utilities.text

Class PaginatedText<S,T extends TextConvertible<S>>

java.lang.Object

io.github.mqzn.commands.utilities.text.PaginatedText<S,T>

public final class PaginatedText<S,T extends TextConvertible<S>>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_ITEMS_PER_PAGE

Method Summary

Modifier and Type	Method	Description
void	add(T object)
static <S, T extends TextConvertible<S>> PaginatedText<S,T>	create(@NotNull CommandHelpStyle<S> provider, @NotNull SenderWrapper<S> wrapper)
static <S, T extends TextConvertible<S>> PaginatedText<S,T>	create(@NotNull CommandHelpStyle<S> provider, @NotNull SenderWrapper<S> wrapper, int itemsPerPage)
void	displayPage(@NotNull String label, S sender, int page)
int	getItemsPerPage()
@Nullable TextPage<S,T>	getPage(int index)
int	maxPages()
void	paginate()
PaginatedText<S,T>	remove(T object)
PaginatedText<S,T>	withDisplayer(@NotNull ItemPageTextDisplayer<S,T> displayer)
PaginatedText<S,T>	withHeaderLine(@NotNull String line)
PaginatedText<S,T>	withPrimaryColor(@NotNull net.kyori.adventure.text.format.NamedTextColor primaryColor)
PaginatedText<S,T>	withSecondaryColor(@NotNull net.kyori.adventure.text.format.NamedTextColor secondaryColor)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ITEMS_PER_PAGE

public static final int DEFAULT_ITEMS_PER_PAGE

See Also:

• Constant Field Values

Method Details

create

public static <S,
T extends TextConvertible<S>>
PaginatedText<S,T> create(@NotNull
 @NotNull CommandHelpStyle<S> provider,
 @NotNull
 @NotNull SenderWrapper<S> wrapper)

create

public static <S,
T extends TextConvertible<S>>
PaginatedText<S,T> create(@NotNull
 @NotNull CommandHelpStyle<S> provider,
 @NotNull
 @NotNull SenderWrapper<S> wrapper,
 int itemsPerPage)

getItemsPerPage

public int getItemsPerPage()

add

public void add(T object)

remove

public PaginatedText<S,T> remove(@NotNull
 T object)

withHeaderLine

public PaginatedText<S,T> withHeaderLine(@NotNull
 @NotNull String line)

withPrimaryColor

public PaginatedText<S,T> withPrimaryColor(@NotNull
 @NotNull net.kyori.adventure.text.format.NamedTextColor primaryColor)

withSecondaryColor

public PaginatedText<S,T> withSecondaryColor(@NotNull
 @NotNull net.kyori.adventure.text.format.NamedTextColor secondaryColor)

withDisplayer

public PaginatedText<S,T> withDisplayer(@NotNull
 @NotNull ItemPageTextDisplayer<S,T> displayer)

paginate

public void paginate()

getPage

@Nullable
public @Nullable TextPage<S,T> getPage(int index)

maxPages

public int maxPages()

displayPage

public void displayPage(@NotNull
 @NotNull String label,
 @NotNull
 S sender,
 int page)