Slideshow.Builder

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

Enclosing class:: Slideshow

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

The Menu.Builder for a Slideshow.

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
`Slideshow.Builder`	`addItems(java.lang.String... items)` Adds String items to the list of items to paginate.
`Slideshow.Builder`	`allowTextInput(boolean allowTextInput)` Sets the `Slideshow` to allow a slide number to be specified by a user via text.
`Slideshow`	`build()` Builds the `Slideshow` with this Builder.
`Slideshow.Builder`	`setBulkSkipNumber(int bulkSkipNumber)` Sets the `Slideshow`'s bulk-skip function to skip multiple pages using alternate forward and backwards
`Slideshow.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`.
`Slideshow.Builder`	`setColor(java.awt.Color color)` Sets the `Color` of the `MessageEmbed`.
`Slideshow.Builder`	`setDescription(java.util.function.BiFunction<java.lang.Integer,java.lang.Integer,java.lang.String> descriptionBiFunction)` Sets the description of the `MessageEmbed` in the `Message` to be displayed relative to the total page number and the current page as determined by the provided `BiFunction`.
`Slideshow.Builder`	`setDescription(java.lang.String description)` Sets the description of the `MessageEmbed` in the `Message` to be displayed when the `Slideshow` is built.
`Slideshow.Builder`	`setFinalAction(java.util.function.Consumer<net.dv8tion.jda.core.entities.Message> finalAction)` Sets the `Consumer` to perform if the `Slideshow` times out.
`Slideshow.Builder`	`setLeftRightText(java.lang.String left, java.lang.String right)` Sets the `Slideshow` 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.
`Slideshow.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`.
`Slideshow.Builder`	`setText(java.lang.String text)` Sets the text of the `Message` to be displayed when the `Slideshow` is built.
`Slideshow.Builder`	`setUrls(java.lang.String... items)` Sets the String list of urls to paginate.
`Slideshow.Builder`	`showPageNumbers(boolean show)` Sets whether or not the page number will be shown.
`Slideshow.Builder`	`waitOnSinglePage(boolean wait)` Sets whether the `Slideshow` will instantly timeout, and possibly run a provided `Runnable`, if only a single slide is available to display.
`Slideshow.Builder`	`wrapPageEnds(boolean wrapPageEnds)` Sets the `Slideshow` 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 Slideshow build()
```
    Builds the Slideshow with this Builder.
    Specified by:
    
    build in class Menu.Builder<Slideshow.Builder,Slideshow>
    
    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 Slideshow.Builder setColor(java.awt.Color color)
```
    Sets the Color of the MessageEmbed.
    
    Parameters:
    
    color - The Color of the MessageEmbed
    
    Returns:
    
    This builder
  - setColor
```
public Slideshow.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 Slideshow.Builder setText(java.lang.String text)
```
    Sets the text of the Message to be displayed when the Slideshow is built.
    This is displayed directly above the embed.
    
    Parameters:
    
    text - The Message content to be displayed above the embed when the Slideshow is built
    
    Returns:
    
    This builder
  - setText
```
public Slideshow.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
  - setDescription
```
public Slideshow.Builder setDescription(java.lang.String description)
```
    Sets the description of the MessageEmbed in the Message to be displayed when the Slideshow is built.
    
    Parameters:
    
    description - The description of the MessageEmbed
    
    Returns:
    
    This builder
  - setDescription
```
public Slideshow.Builder setDescription(java.util.function.BiFunction<java.lang.Integer,java.lang.Integer,java.lang.String> descriptionBiFunction)
```
    Sets the description of the MessageEmbed in 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 description of the MessageEmbed to change depending on the page number.
    
    Parameters:
    
    descriptionBiFunction - The BiFunction that uses both current and total page numbers to get description for the MessageEmbed
    
    Returns:
    
    This builder
  - setFinalAction
```
public Slideshow.Builder setFinalAction(java.util.function.Consumer<net.dv8tion.jda.core.entities.Message> finalAction)
```
    Sets the Consumer to perform if the Slideshow times out.
    
    Parameters:
    
    finalAction - The Consumer action to perform if the Slideshow times out
    
    Returns:
    
    This builder
  - showPageNumbers
```
public Slideshow.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
  - waitOnSinglePage
```
public Slideshow.Builder waitOnSinglePage(boolean wait)
```
    Sets whether the Slideshow will instantly timeout, and possibly run a provided Runnable, if only a single slide is available to display.
    
    Parameters:
    
    wait - true if the Slideshow will still generate
    
    Returns:
    
    This builder
  - addItems
```
public Slideshow.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
  - setUrls
```
public Slideshow.Builder setUrls(java.lang.String... items)
```
    Sets the String list of urls to paginate.
    This method clears all previously set items before setting.
    
    Parameters:
    
    items - The String list of urls to paginate
    
    Returns:
    
    This builder
  - setBulkSkipNumber
```
public Slideshow.Builder setBulkSkipNumber(int bulkSkipNumber)
```
    Sets the Slideshow'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 Slideshow.Builder wrapPageEnds(boolean wrapPageEnds)
```
    Sets the Slideshow 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 Slideshow.Builder allowTextInput(boolean allowTextInput)
```
    Sets the Slideshow to allow a slide number to be specified by a user via text.
    Note that setting this doesn't mean that left and right text inputs provided via Paginator.Builder.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 Slideshow will allow slide-number text input
    
    Returns:
    
    This builder
  - setLeftRightText
```
public Slideshow.Builder setLeftRightText(java.lang.String left,
                                          java.lang.String right)
```
    Sets the Slideshow 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 Slideshow is built.
    
    Parameters:
    
    left - The left text input, causes the Slideshow to traverse one slide left
    
    right - The right text input, causes the Slideshow to traverse one slide right
    
    Returns:
    
    This builder

Class Slideshow.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

setDescription

setDescription

setFinalAction

showPageNumbers

waitOnSinglePage

addItems

setUrls

setBulkSkipNumber

wrapPageEnds

allowTextInput

setLeftRightText