org.spongepowered.api.service.pagination

Interface PaginationList

public interface PaginationList

Represents an immutable iterable of Texts, which can be sent to a MessageReceiver.

An instance of this class may be obtained using PaginationList.Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PaginationList.Builder Builds a paginated output for an iterable of Texts.

Method Summary

Modifier and Type	Method and Description
static PaginationList.Builder	builder() Creates a new PaginationList.Builder to build a pagination list.
Iterable<Text>	getContents() Gets the contents of this pagination list.
Optional<Text>	getFooter() Gets the footer to be displayed for this output on all pages after the contents and page navigation bar, if available.
Optional<Text>	getHeader() Gets the header to be displayed for this output on all pages after the title bar but before the contents, if available.
int	getLinesPerPage() Gets the maximum amount of lines that will be sent per page.
Text	getPadding() Gets the padding character to be used when centering headers and footers.
Optional<Text>	getTitle() Gets the title text to be used in the title bar of this pagination.
default void	sendTo(Iterable<MessageReceiver> receivers) Sends the first page of the constructed pagination list to all MessageReceivers within an Iterable.
default void	sendTo(Iterable<MessageReceiver> receivers, int page) Sends the specified page of the constructed pagination list all MessageReceivers within an Iterable.
default void	sendTo(MessageReceiver receiver) Sends the first page of the constructed pagination list to the specified message receiver.
void	sendTo(MessageReceiver receiver, int page) Send the specified page of the constructed pagination list to the specified message receiver.

Method Detail

builder

static PaginationList.Builder builder()

Creates a new PaginationList.Builder to build a pagination list.

Returns:

The new builder

getContents

Iterable<Text> getContents()

Gets the contents of this pagination list.

Returns:

The contents of this pagination list

getTitle

Optional<Text> getTitle()

Gets the title text to be used in the title bar of this pagination.

Returns:

The title text

getHeader

Optional<Text> getHeader()

Gets the header to be displayed for this output on all pages after the title bar but before the contents, if available.

Header and footer will use this Text's style and color for formatting.

Returns:

The header to be displayed

getFooter

Optional<Text> getFooter()

Gets the footer to be displayed for this output on all pages after the contents and page navigation bar, if available.

Returns:

The footer

getPadding

Text getPadding()

Gets the padding character to be used when centering headers and footers.

Returns:

The padding character

getLinesPerPage

int getLinesPerPage()

Gets the maximum amount of lines that will be sent per page.

This defaults to the maximum amount of lines that can be displayed on a source's screen at one time if not specified.

Returns:

The maximum amount of lines that will be sent per page

sendTo

default void sendTo(MessageReceiver receiver)

Sends the first page of the constructed pagination list to the specified message receiver.

Parameters:

receiver - The receiver to send the first page to

See Also:

to send a specific page

sendTo

void sendTo(MessageReceiver receiver,
            int page)

Send the specified page of the constructed pagination list to the specified message receiver.

A page that is out of bounds will result in a friendly error message being sent to the receiver.

Pages start at an index of 1.

Parameters:

receiver - The receiver to send the page to

page - The page to send, starting at an index of 1

sendTo

default void sendTo(Iterable<MessageReceiver> receivers)

Sends the first page of the constructed pagination list to all MessageReceivers within an Iterable.

Parameters:

receivers - The message receivers to send the first page to

See Also:

to send a specific page

sendTo

default void sendTo(Iterable<MessageReceiver> receivers,
                    int page)

Sends the specified page of the constructed pagination list all MessageReceivers within an Iterable.

Parameters:

receivers - The message receivers to send the page to

page - The page to send