Package io.rhythmknights.coreapi.component.module

Class DynamicTitle.PaginatedDynamicTitle

java.lang.Object

io.rhythmknights.coreapi.component.module.DynamicTitle.PaginatedDynamicTitle

All Implemented Interfaces:

DynamicTitle

Enclosing interface:

DynamicTitle

public static class DynamicTitle.PaginatedDynamicTitle
extends Object
implements DynamicTitle

Implementation for paginated modals that shows current page / total pages

Nested Class Summary

Nested classes/interfaces inherited from interface io.rhythmknights.coreapi.component.module.DynamicTitle

DynamicTitle.DynamicTitleImpl, DynamicTitle.InteractionDynamicTitle, DynamicTitle.InteractionState, DynamicTitle.PaginatedDynamicTitle, DynamicTitle.PaginationState

Constructor Summary

Constructors

Constructor	Description
PaginatedDynamicTitle(@NotNull String baseTitle, int currentPage, int totalPages)	Creates a paginated dynamic title
PaginatedDynamicTitle(@NotNull Function<DynamicTitle.PaginationState,net.kyori.adventure.text.Component> titleFunction, @NotNull String baseTitle, int currentPage, int totalPages)	Creates a paginated dynamic title with custom formatting

Method Summary

Modifier and Type	Method	Description
String	getBaseTitle()	Get the base title
int	getCurrentPage()	Get the current page
@NotNull net.kyori.adventure.text.Component	getDynamicTitle()	Get the current dynamic title based on modal state
int	getTotalPages()	Get the total number of pages
@NotNull net.kyori.adventure.text.Component	update(int currentPage, int totalPages)	Update pagination state and get new title
@NotNull net.kyori.adventure.text.Component	update(@NotNull Object state)	Update the dynamic title with a new state object

Methods inherited from class java.lang.Object

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

Constructor Details

PaginatedDynamicTitle

public PaginatedDynamicTitle(@NotNull
 @NotNull String baseTitle,
 int currentPage,
 int totalPages)

Creates a paginated dynamic title

Parameters:

baseTitle - Base title text

currentPage - Initial current page

totalPages - Initial total pages

PaginatedDynamicTitle

public PaginatedDynamicTitle(@NotNull
 @NotNull Function<DynamicTitle.PaginationState,net.kyori.adventure.text.Component> titleFunction,
 @NotNull
 @NotNull String baseTitle,
 int currentPage,
 int totalPages)

Creates a paginated dynamic title with custom formatting

Parameters:

titleFunction - Function to create title from pagination state

baseTitle - Base title text

currentPage - Initial current page

totalPages - Initial total pages

Method Details

getDynamicTitle

@NotNull
public @NotNull net.kyori.adventure.text.Component getDynamicTitle()

Description copied from interface: DynamicTitle

Get the current dynamic title based on modal state

Specified by:

getDynamicTitle in interface DynamicTitle

Returns:

Current component title

update

@NotNull
public @NotNull net.kyori.adventure.text.Component update(@NotNull
 @NotNull Object state)

Description copied from interface: DynamicTitle

Update the dynamic title with a new state object

Specified by:

update in interface DynamicTitle

Parameters:

state - Object containing state information for the update

Returns:

Updated component title

update

@NotNull
public @NotNull net.kyori.adventure.text.Component update(int currentPage,
 int totalPages)

Update pagination state and get new title

Parameters:

currentPage - New current page

totalPages - New total pages

Returns:

Updated component title

getCurrentPage

public int getCurrentPage()

Get the current page

Returns:

Current page number

getTotalPages

public int getTotalPages()

Get the total number of pages

Returns:

Total pages

getBaseTitle

public String getBaseTitle()

Get the base title

Returns:

Base title text