Pagination (text-feature-pagination 3.0.2 API)

Type Parameters:

T - the content type

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
```
@FunctionalInterface
public interface Pagination<T>
```
Pagination.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Pagination.Builder` A pagination builder.
`static interface`	`Pagination.PageCommandFunction` A page command function.
`static interface`	`Pagination.Renderer` A pagination renderer.

Field Summary

Fields
Modifier and Type	Field and Description
`static Pagination.Renderer`	`DEFAULT_RENDERER` The default interface renderer.
`static char`	`LINE_CHARACTER` The default line character.
`static net.kyori.text.format.Style`	`LINE_STYLE` The default line style.
`static char`	`NEXT_PAGE_BUTTON_CHARACTER` The default character for the next page button.
`static net.kyori.text.format.Style`	`NEXT_PAGE_BUTTON_STYLE` The default style for the next page button.
`static char`	`PREVIOUS_PAGE_BUTTON_CHARACTER` The default character for the previous page button.
`static net.kyori.text.format.Style`	`PREVIOUS_PAGE_BUTTON_STYLE` The default style for the next page button.
`static int`	`RESULTS_PER_PAGE` The default number of results per page.
`static int`	`WIDTH` The default interface width.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static @NonNull Pagination.Builder`	`builder()` Creates a pagination builder.
`@NonNull java.util.List<net.kyori.text.Component>`	`render(@NonNull java.util.Collection<? extends T> content, int page)` Renders.

- Field Detail
  - WIDTH
```
static final int WIDTH
```
    The default interface width.
    
    See Also:
    
    Constant Field Values
  - RESULTS_PER_PAGE
```
static final int RESULTS_PER_PAGE
```
    The default number of results per page.
    
    See Also:
    
    Constant Field Values
  - LINE_CHARACTER
```
static final char LINE_CHARACTER
```
    The default line character.
    
    See Also:
    
    Constant Field Values
  - LINE_STYLE
```
static final net.kyori.text.format.Style LINE_STYLE
```
    The default line style.
  - PREVIOUS_PAGE_BUTTON_CHARACTER
```
static final char PREVIOUS_PAGE_BUTTON_CHARACTER
```
    The default character for the previous page button.
    
    See Also:
    
    Constant Field Values
  - PREVIOUS_PAGE_BUTTON_STYLE
```
static final net.kyori.text.format.Style PREVIOUS_PAGE_BUTTON_STYLE
```
    The default style for the next page button.
  - NEXT_PAGE_BUTTON_CHARACTER
```
static final char NEXT_PAGE_BUTTON_CHARACTER
```
    The default character for the next page button.
    
    See Also:
    
    Constant Field Values
  - NEXT_PAGE_BUTTON_STYLE
```
static final net.kyori.text.format.Style NEXT_PAGE_BUTTON_STYLE
```
    The default style for the next page button.
  - DEFAULT_RENDERER
```
static final Pagination.Renderer DEFAULT_RENDERER
```
    The default interface renderer.
- Method Detail
  - builder
```
static @NonNull Pagination.Builder builder()
```
    Creates a pagination builder.
    
    Returns:
    
    a builder
  - render
```
@NonNull java.util.List<net.kyori.text.Component> render(@NonNull java.util.Collection<? extends T> content,
                                                         int page)
```
    Renders.
    
    Parameters:
    
    content - the content to render
    
    page - the page number
    
    Returns:
    
    the rendered results

Interface Pagination<T>

Nested Class Summary

Field Summary

Method Summary

Field Detail

WIDTH

RESULTS_PER_PAGE

LINE_CHARACTER

LINE_STYLE

PREVIOUS_PAGE_BUTTON_CHARACTER

PREVIOUS_PAGE_BUTTON_STYLE

NEXT_PAGE_BUTTON_CHARACTER

NEXT_PAGE_BUTTON_STYLE

DEFAULT_RENDERER

Method Detail

builder

render