Paginator.Builder

java.lang.Object
- com.jagrosh.jdautilities.menu.Menu.Builder<Paginator.Builder,Paginator>
- - com.jagrosh.jdautilities.menu.Paginator.Builder

Enclosing class:: Paginator

public static class Paginator.Builder
extends Menu.Builder<Paginator.Builder,Paginator>

The Menu.Builder for a Paginator.

Author:: John Grosh

Field Summary
- Fields inherited from class com.jagrosh.jdautilities.menu.Menu.Builder
  roles, timeout, unit, users, waiter

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Paginator.Builder`	`addItems(java.lang.String... items)` Adds String items to the list of items to paginate.
`Paginator.Builder`	`allowTextInput(boolean allowTextInput)` Sets the `Paginator` to allow a page number to be specified by a user via text.
`Paginator`	`build()` Builds the `Paginator` with this Builder.
`Paginator.Builder`	`clearItems()` Clears the list of String items to paginate.
`Paginator.Builder`	`setBulkSkipNumber(int bulkSkipNumber)` Sets the `Paginator`'s bulk-skip function to skip multiple pages using alternate forward and backwards
`Paginator.Builder`	`setColor(java.util.function.BiFunction<java.lang.Integer,java.lang.Integer,java.awt.Color> colorBiFunction)` Sets the `Color` of the `MessageEmbed`, relative to the total page number and the current page as determined by the provided `BiFunction`.
`Paginator.Builder`	`setColor(java.awt.Color color)` Sets the `Color` of the `MessageEmbed`.
`Paginator.Builder`	`setColumns(int columns)` Sets the number of columns each page will have.
`Paginator.Builder`	`setFinalAction(java.util.function.Consumer<net.dv8tion.jda.core.entities.Message> finalAction)` Sets the `Consumer` to perform if the `Paginator` times out.
`Paginator.Builder`	`setItems(java.lang.String... items)` Sets the String list of items to paginate.
`Paginator.Builder`	`setItemsPerPage(int num)` Sets the number of items that will appear on each page.
`Paginator.Builder`	`setLeftRightText(java.lang.String left, java.lang.String right)` Sets the `Paginator` to traverse left or right when a provided text input is sent in the form of a Message to the `Channel` the menu is displayed in.
`Paginator.Builder`	`setText(java.util.function.BiFunction<java.lang.Integer,java.lang.Integer,java.lang.String> textBiFunction)` Sets the text of the `Message` to be displayed relative to the total page number and the current page as determined by the provided `BiFunction`.
`Paginator.Builder`	`setText(java.lang.String text)` Sets the text of the `Message` to be displayed when the `Paginator` is built.
`Paginator.Builder`	`showPageNumbers(boolean show)` Sets whether or not the page number will be shown.
`Paginator.Builder`	`useNumberedItems(boolean number)` Sets whether or not the items will be automatically numbered.
`Paginator.Builder`	`waitOnSinglePage(boolean wait)` Sets whether the `Paginator` will instantly timeout, and possibly run a provided `Runnable`, if only a single slide is available to display.
`Paginator.Builder`	`wrapPageEnds(boolean wrapPageEnds)` Sets the `Paginator` to wrap from the last page to the first when traversing right and visa versa from the left.

Methods inherited from class com.jagrosh.jdautilities.menu.Menu.Builder
addRoles, addUsers, setEventWaiter, setRoles, setTimeout, setUsers

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - build
```
public Paginator build()
```
    Builds the Paginator with this Builder.
    Specified by:
    
    build in class Menu.Builder<Paginator.Builder,Paginator>
    
    Returns:
    
    The Paginator built from this Builder.
    
    Throws:
    java.lang.IllegalArgumentException - If one of the following is violated:
    
    No EventWaiter was set.
    
    No items were set to paginate.
  - setColor
```
public Paginator.Builder setColor(java.awt.Color color)
```
    Sets the Color of the MessageEmbed.
    
    Parameters:
    
    color - The Color of the MessageEmbed
    
    Returns:
    
    This builder
  - setColor
```
public Paginator.Builder setColor(java.util.function.BiFunction<java.lang.Integer,java.lang.Integer,java.awt.Color> colorBiFunction)
```
    Sets the Color of the MessageEmbed, relative to the total page number and the current page as determined by the provided BiFunction.
    As the page changes, the BiFunction will re-process the current page number and the total page number, allowing for the color of the embed to change depending on the page number.
    
    Parameters:
    
    colorBiFunction - A BiFunction that uses both current and total page numbers to get a Color for the MessageEmbed
    
    Returns:
    
    This builder
  - setText
```
public Paginator.Builder setText(java.lang.String text)
```
    Sets the text of the Message to be displayed when the Paginator is built.
    This is displayed directly above the embed.
    
    Parameters:
    
    text - The Message content to be displayed above the embed when the Paginator is built
    
    Returns:
    
    This builder
  - setText
```
public Paginator.Builder setText(java.util.function.BiFunction<java.lang.Integer,java.lang.Integer,java.lang.String> textBiFunction)
```
    Sets the text of the Message to be displayed relative to the total page number and the current page as determined by the provided BiFunction.
    As the page changes, the BiFunction will re-process the current page number and the total page number, allowing for the displayed text of the Message to change depending on the page number.
    
    Parameters:
    
    textBiFunction - The BiFunction that uses both current and total page numbers to get text for the Message
    
    Returns:
    
    This builder
  - setFinalAction
```
public Paginator.Builder setFinalAction(java.util.function.Consumer<net.dv8tion.jda.core.entities.Message> finalAction)
```
    Sets the Consumer to perform if the Paginator times out.
    
    Parameters:
    
    finalAction - The Consumer action to perform if the Paginator times out
    
    Returns:
    
    This builder
  - setColumns
```
public Paginator.Builder setColumns(int columns)
```
    Sets the number of columns each page will have.
    By default this is 1.
    
    Parameters:
    
    columns - The number of columns
    
    Returns:
    
    This builder
  - setItemsPerPage
```
public Paginator.Builder setItemsPerPage(int num)
```
    Sets the number of items that will appear on each page.
    
    Parameters:
    
    num - Always positive, never-zero number of items per page
    
    Returns:
    
    This builder
    
    Throws:
    
    java.lang.IllegalArgumentException - If the provided number is less than 1
  - showPageNumbers
```
public Paginator.Builder showPageNumbers(boolean show)
```
    Sets whether or not the page number will be shown.
    
    Parameters:
    
    show - true if the page number should be shown, false if it should not
    
    Returns:
    
    This builder
  - useNumberedItems
```
public Paginator.Builder useNumberedItems(boolean number)
```
    Sets whether or not the items will be automatically numbered.
    
    Parameters:
    
    number - true if the items should be numbered, false if it should not
    
    Returns:
    
    This builder
  - waitOnSinglePage
```
public Paginator.Builder waitOnSinglePage(boolean wait)
```
    Sets whether the Paginator will instantly timeout, and possibly run a provided Runnable, if only a single slide is available to display.
    
    Parameters:
    
    wait - true if the Paginator will still generate
    
    Returns:
    
    This builder
  - clearItems
```
public Paginator.Builder clearItems()
```
    Clears the list of String items to paginate.
    
    Returns:
    
    This builder
  - addItems
```
public Paginator.Builder addItems(java.lang.String... items)
```
    Adds String items to the list of items to paginate.
    
    Parameters:
    
    items - The String list of items to add
    
    Returns:
    
    This builder
  - setItems
```
public Paginator.Builder setItems(java.lang.String... items)
```
    Sets the String list of items to paginate.
    This method clears all previously set items before setting.
    
    Parameters:
    
    items - The String list of items to paginate
    
    Returns:
    
    This builder
  - setBulkSkipNumber
```
public Paginator.Builder setBulkSkipNumber(int bulkSkipNumber)
```
    Sets the Paginator's bulk-skip function to skip multiple pages using alternate forward and backwards
    
    Parameters:
    
    bulkSkipNumber - The number of pages to skip when the bulk-skip reactions are used.
    
    Returns:
    
    This builder
  - wrapPageEnds
```
public Paginator.Builder wrapPageEnds(boolean wrapPageEnds)
```
    Sets the Paginator to wrap from the last page to the first when traversing right and visa versa from the left.
    
    Parameters:
    
    wrapPageEnds - true to enable wrapping.
    
    Returns:
    
    This builder
  - allowTextInput
```
public Paginator.Builder allowTextInput(boolean allowTextInput)
```
    Sets the Paginator to allow a page number to be specified by a user via text.
    Note that setting this doesn't mean that left and right text inputs provided via setLeftRightText(String, String) will be invalidated if they were set previously! To invalidate those, provide null for one or both of the parameters of that method.
    
    Parameters:
    
    allowTextInput - true if the Paginator will allow page-number text input
    
    Returns:
    
    This builder
  - setLeftRightText
```
public Paginator.Builder setLeftRightText(java.lang.String left,
                                          java.lang.String right)
```
    Sets the Paginator to traverse left or right when a provided text input is sent in the form of a Message to the Channel the menu is displayed in.
    If one or both these parameters are provided null this resets both of them and they will no longer be available when the Paginator is built.
    
    Parameters:
    
    left - The left text input, causes the Paginator to traverse one page left
    
    right - The right text input, causes the Paginator to traverse one page right
    
    Returns:
    
    This builder

Class Paginator.Builder

Field Summary

Fields inherited from class com.jagrosh.jdautilities.menu.Menu.Builder

Constructor Summary

Method Summary

Methods inherited from class com.jagrosh.jdautilities.menu.Menu.Builder

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

setColor

setColor

setText

setText

setFinalAction

setColumns

setItemsPerPage

showPageNumbers

useNumberedItems

waitOnSinglePage

clearItems

addItems

setItems

setBulkSkipNumber

wrapPageEnds

allowTextInput

setLeftRightText