net.kyori.text.feature.pagination

Interface Pagination.Renderer

Enclosing interface:

Pagination<T>

public static interface Pagination.Renderer

A pagination renderer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Pagination.Renderer.RowRenderer<T> A row renderer.

Field Summary

Fields

Modifier and Type	Field and Description
static net.kyori.text.Component	GRAY_FORWARD_SLASH
static net.kyori.text.Component	GRAY_LEFT_ROUND_BRACKET
static net.kyori.text.Component	GRAY_LEFT_SQUARE_BRACKET
static net.kyori.text.Component	GRAY_RIGHT_ROUND_BRACKET
static net.kyori.text.Component	GRAY_RIGHT_SQUARE_BRACKET

Method Summary

Modifier and Type	Method and Description
default @NonNull net.kyori.text.Component	renderEmpty() Renders an empty result.
default @NonNull net.kyori.text.Component	renderHeader(@NonNull net.kyori.text.Component title, int page, int pages) Renders a header.
default @NonNull net.kyori.text.Component	renderNextPageButton(char character, @NonNull net.kyori.text.format.Style style, @NonNull net.kyori.text.event.ClickEvent clickEvent) Renders a next page button.
default @NonNull net.kyori.text.Component	renderPreviousPageButton(char character, @NonNull net.kyori.text.format.Style style, @NonNull net.kyori.text.event.ClickEvent clickEvent) Renders a previous page button.
default @NonNull net.kyori.text.Component	renderUnknownPage(int page, int pages) Renders an unknown page.

Field Detail

GRAY_LEFT_ROUND_BRACKET

static final net.kyori.text.Component GRAY_LEFT_ROUND_BRACKET

GRAY_LEFT_SQUARE_BRACKET

static final net.kyori.text.Component GRAY_LEFT_SQUARE_BRACKET

GRAY_RIGHT_ROUND_BRACKET

static final net.kyori.text.Component GRAY_RIGHT_ROUND_BRACKET

GRAY_RIGHT_SQUARE_BRACKET

static final net.kyori.text.Component GRAY_RIGHT_SQUARE_BRACKET

GRAY_FORWARD_SLASH

static final net.kyori.text.Component GRAY_FORWARD_SLASH

Method Detail

renderEmpty

default @NonNull net.kyori.text.Component renderEmpty()

Renders an empty result.

No header or footer are rendered.

Returns:

the rendered component

renderUnknownPage

default @NonNull net.kyori.text.Component renderUnknownPage(int page,
                                                            int pages)

Renders an unknown page.

No header or footer are rendered.

Parameters:

page - the unknown page

pages - the total number of pages

Returns:

the rendered component

renderHeader

default @NonNull net.kyori.text.Component renderHeader(@NonNull net.kyori.text.Component title,
                                                       int page,
                                                       int pages)

Renders a header.

Parameters:

title - the title

page - the page

pages - the total number of pages

Returns:

the rendered component

renderPreviousPageButton

default @NonNull net.kyori.text.Component renderPreviousPageButton(char character,
                                                                   @NonNull net.kyori.text.format.Style style,
                                                                   @NonNull net.kyori.text.event.ClickEvent clickEvent)

Renders a previous page button.

Parameters:

character - the button character

style - the button style

clickEvent - the click event for the button

Returns:

the rendered component

renderNextPageButton

default @NonNull net.kyori.text.Component renderNextPageButton(char character,
                                                               @NonNull net.kyori.text.format.Style style,
                                                               @NonNull net.kyori.text.event.ClickEvent clickEvent)

Renders a next page button.

Parameters:

character - the button character

style - the button style

clickEvent - the click event for the button

Returns:

the rendered component