public static interface PaginationList.Builder extends ResettableBuilder<PaginationList,PaginationList.Builder>
Text
s.Modifier and Type | Method and Description |
---|---|
PaginationList |
build()
Creates a
PaginationList from this pagination builder. |
PaginationList.Builder |
contents(Iterable<Text> contents)
Sets the contents of this output as an iterable.
|
PaginationList.Builder |
contents(Text... contents)
Sets the contents of this output to be the given array of contents.
|
PaginationList.Builder |
footer(Text footer)
Sets the footer to be displayed for this output on all pages after
the contents and page navigation bar.
|
PaginationList.Builder |
header(Text header)
Sets the header to be displayed for this output on all pages after
the title bar but before the contents.
|
PaginationList.Builder |
linesPerPage(int linesPerPage)
Sets the maximum number of lines that can be displayed per page.
|
PaginationList.Builder |
padding(Text padding)
Sets the padding character to be used when centering headers and
footers.
|
default PaginationList |
sendTo(Iterable<MessageReceiver> receivers)
Sends the constructed pagination list to all
MessageReceiver s within an Iterable . |
default PaginationList |
sendTo(MessageReceiver receiver)
Sends the constructed pagination list to the given receiver.
|
PaginationList.Builder |
title(Text title)
Sets the title text to be used in the title bar of this pagination.
|
from, reset
PaginationList.Builder contents(Iterable<Text> contents)
If this Iterable
is a List
, bidirectional
navigation is supported. Otherwise, only going to the next page will
be supported.
contents
- The contents to outputPaginationList.Builder contents(Text... contents)
contents
- The contents to outputPaginationList.Builder title(@Nullable Text title)
This should be less than one line long.
title
- The title to usePaginationList.Builder header(@Nullable Text header)
The header and footer will use this Text's style and color for formatting.
If the header is not specified, or passed in as null
,
it will be omitted when displaying the list.
header
- The header to setPaginationList.Builder footer(@Nullable Text footer)
If the footer is not specified, or passed in as null
,
it will be omitted when displaying the list.
footer
- The footer to setPaginationList.Builder padding(Text padding)
padding
- The padding to usePaginationList.Builder linesPerPage(int linesPerPage)
This defaults to the maximum amount of lines that can be displayed on a source's screen at one time if not specified.
linesPerPage
- The maximum number of lines to display per pagePaginationList build()
PaginationList
from this pagination builder.IllegalStateException
- If no contents were specifieddefault PaginationList sendTo(MessageReceiver receiver)
receiver
- The receiver to send the list todefault PaginationList sendTo(Iterable<MessageReceiver> receivers)
MessageReceiver
s within an Iterable
.receivers
- The message receivers to send the list to