com.jagrosh.jdautilities.menu

Class OrderedMenu

java.lang.Object

com.jagrosh.jdautilities.menu.Menu

com.jagrosh.jdautilities.menu.OrderedMenu

public class OrderedMenu
extends Menu

A Menu of ordered buttons signified by numbers or letters, each with a reaction linked to it for users to click.

Up to ten text choices can be set in the OrderedMenu.Builder, and additional methods for handling the resulting choice made by a user using the menu may also be attached via the OrderedMenu.Builder.setSelection(BiConsumer) and OrderedMenu.Builder.setCancel(Consumer) methods.

Author:

John Grosh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrderedMenu.Builder The Menu.Builder for an OrderedMenu.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CANCEL
static java.lang.String[]	LETTERS
static java.lang.String[]	NUMBERS

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) Displays this OrderedMenu by editing the provided Message.
void	display(net.dv8tion.jda.core.entities.MessageChannel channel) Shows the OrderedMenu as a new Message in the provided MessageChannel.

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

NUMBERS

public static final java.lang.String[] NUMBERS

LETTERS

public static final java.lang.String[] LETTERS

CANCEL

public static final java.lang.String CANCEL

See Also:

Constant Field Values

Method Detail

display

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

Shows the OrderedMenu as a new Message in the provided MessageChannel.

Specified by:

display in class Menu

Parameters:

channel - The MessageChannel to send the new Message to

Throws:

java.lang.IllegalArgumentException - If all of the following are violated simultaneously:

• Being sent to a TextChannel.
• This OrderedMenu does not allow typed input.
• The bot doesn't have Permission.MESSAGE_ADD_REACTION in the channel this menu is being sent to.

display

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

Displays this OrderedMenu by editing the provided Message.

Specified by:

display in class Menu

Parameters:

message - The Message to display the Menu in

Throws:

java.lang.IllegalArgumentException - If all of the following are violated simultaneously:

• Being sent to a TextChannel.
• This OrderedMenu does not allow typed input.
• The bot doesn't have Permission.MESSAGE_ADD_REACTION in the channel this menu is being sent to.