com.jagrosh.jdautilities.menu

Class Slideshow

java.lang.Object

com.jagrosh.jdautilities.menu.Menu

com.jagrosh.jdautilities.menu.Slideshow

public class Slideshow
extends Menu

A Menu implementation, nearly identical to Paginator, that displays an individual image on each page instead of a list of text items.

Like Paginator, reaction functions allow the user to traverse to the last page using the left arrow, the next page using the right arrow, and to stop the Slideshow prematurely using the stop reaction.

Author:

John Grosh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Slideshow.Builder The Menu.Builder for a Slideshow.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BIG_LEFT
static java.lang.String	BIG_RIGHT
static java.lang.String	LEFT
static java.lang.String	RIGHT
static java.lang.String	STOP

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

roles, timeout, unit, users, waiter

Method Summary

Modifier and Type	Method and Description
void	display(net.dv8tion.jda.core.entities.Message message) Begins pagination on page 1 displaying this by editing the provided Message.
void	display(net.dv8tion.jda.core.entities.MessageChannel channel) Begins pagination on page 1 as a new Message in the provided MessageChannel.
void	paginate(net.dv8tion.jda.core.entities.MessageChannel channel, int pageNum) Begins pagination as a new Message in the provided MessageChannel, starting on whatever page number is provided.
void	paginate(net.dv8tion.jda.core.entities.Message message, int pageNum) Begins pagination displaying this by editing the provided Message, starting on whatever page number is provided.

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

isValidUser, isValidUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BIG_LEFT

public static final java.lang.String BIG_LEFT

See Also:

Constant Field Values

LEFT

public static final java.lang.String LEFT

See Also:

Constant Field Values

STOP

public static final java.lang.String STOP

See Also:

Constant Field Values

RIGHT

public static final java.lang.String RIGHT

See Also:

Constant Field Values

BIG_RIGHT

public static final java.lang.String BIG_RIGHT

See Also:

Constant Field Values

Method Detail

display

public void display(net.dv8tion.jda.core.entities.MessageChannel channel)

Begins pagination on page 1 as a new Message in the provided MessageChannel.

Specified by:

display in class Menu

Parameters:

channel - The MessageChannel to send the new Message to

display

public void display(net.dv8tion.jda.core.entities.Message message)

Begins pagination on page 1 displaying this by editing the provided Message.

Specified by:

display in class Menu

Parameters:

message - The Message to display the Menu in

paginate

public void paginate(net.dv8tion.jda.core.entities.MessageChannel channel,
                     int pageNum)

Begins pagination as a new Message in the provided MessageChannel, starting on whatever page number is provided.

Parameters:

channel - The MessageChannel to send the new Message to

pageNum - The page number to begin on

paginate

public void paginate(net.dv8tion.jda.core.entities.Message message,
                     int pageNum)

Begins pagination displaying this by editing the provided Message, starting on whatever page number is provided.

Parameters:

message - The MessageChannel to send the new Message to

pageNum - The page number to begin on