Package net.md_5.bungee.api.dialog

Class MultiActionDialog

java.lang.Object

net.md_5.bungee.api.dialog.MultiActionDialog

All Implemented Interfaces:

Dialog

public final class MultiActionDialog
extends Object
implements Dialog

Represents a dialog with text a list of action buttons grouped into columns and scrollable if necessary.

Constructor Summary

Constructors

Constructor	Description
MultiActionDialog(DialogBase base, List<DialogClickAction> actions, int columns, ClickEvent onCancel)
MultiActionDialog(DialogBase base, DialogClickAction... actions)

Method Summary

Modifier and Type	Method	Description
List<DialogClickAction>	actions()	The action buttons in the dialog.
MultiActionDialog	actions(List<DialogClickAction> actions)	The action buttons in the dialog.
int	columns()	The number of columns for the dialog buttons (default: 2).
MultiActionDialog	columns(int columns)	The number of columns for the dialog buttons (default: 2).
boolean	equals(Object o)
DialogBase	getBase()	Gets the dialog base which contains the dialog title and other options common to all types of dialogs.
int	hashCode()
ClickEvent	onCancel()	The ClickEvent activated when the dialog is cancelled.
MultiActionDialog	onCancel(ClickEvent onCancel)	The ClickEvent activated when the dialog is cancelled.
void	setBase(DialogBase base)	Sets the dialog base.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MultiActionDialog

public MultiActionDialog(DialogBase base,
                         DialogClickAction... actions)

MultiActionDialog

public MultiActionDialog(DialogBase base,
                         List<DialogClickAction> actions,
                         int columns,
                         ClickEvent onCancel)

Method Detail

getBase

public DialogBase getBase()

Description copied from interface: Dialog

Gets the dialog base which contains the dialog title and other options common to all types of dialogs.

Specified by:

getBase in interface Dialog

Returns:

mutable reference to the dialog base

actions

public List<DialogClickAction> actions()

The action buttons in the dialog. At least one must be provided.

columns

public int columns()

The number of columns for the dialog buttons (default: 2).

onCancel

public ClickEvent onCancel()

The ClickEvent activated when the dialog is cancelled.

setBase

public void setBase(DialogBase base)

Description copied from interface: Dialog

Sets the dialog base.
For internal use only as this is mandatory and should be specified in the constructor.

Specified by:

setBase in interface Dialog

Parameters:

base - the new dialog base

actions

public MultiActionDialog actions(List<DialogClickAction> actions)

The action buttons in the dialog. At least one must be provided.

Returns:

this.

columns

public MultiActionDialog columns(int columns)

The number of columns for the dialog buttons (default: 2).

Returns:

this.

onCancel

public MultiActionDialog onCancel(ClickEvent onCancel)

The ClickEvent activated when the dialog is cancelled.

Returns:

this.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object