Package net.md_5.bungee.api.dialog

Class DialogListDialog

java.lang.Object

net.md_5.bungee.api.dialog.DialogListDialog

All Implemented Interfaces:

Dialog

public final class DialogListDialog
extends Object
implements Dialog

Represents a dialog which contains buttons that link to other dialogs.

Constructor Summary

Constructors

Constructor	Description
DialogListDialog(DialogBase base, List<Dialog> dialogs, ClickEvent onCancel, int columns, int buttonWidth)
DialogListDialog(DialogBase base, Dialog... dialogs)

Method Summary

Modifier and Type	Method	Description
int	buttonWidth()	The width of the dialog buttons (default: 150).
DialogListDialog	buttonWidth(int buttonWidth)	The width of the dialog buttons (default: 150).
int	columns()	The number of columns for the dialog buttons (default: 2).
DialogListDialog	columns(int columns)	The number of columns for the dialog buttons (default: 2).
List<Dialog>	dialogs()	The child dialogs behind each button.
DialogListDialog	dialogs(List<Dialog> dialogs)	The child dialogs behind each button.
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.
DialogListDialog	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

DialogListDialog

public DialogListDialog(DialogBase base,
                        Dialog... dialogs)

DialogListDialog

public DialogListDialog(DialogBase base,
                        List<Dialog> dialogs,
                        ClickEvent onCancel,
                        int columns,
                        int buttonWidth)

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

dialogs

public List<Dialog> dialogs()

The child dialogs behind each button.

onCancel

public ClickEvent onCancel()

The ClickEvent activated when the dialog is cancelled.

columns

public int columns()

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

buttonWidth

public int buttonWidth()

The width of the dialog buttons (default: 150).

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

dialogs

public DialogListDialog dialogs(List<Dialog> dialogs)

The child dialogs behind each button.

Returns:

this.

onCancel

public DialogListDialog onCancel(ClickEvent onCancel)

The ClickEvent activated when the dialog is cancelled.

Returns:

this.

columns

public DialogListDialog columns(int columns)

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

Returns:

this.

buttonWidth

public DialogListDialog buttonWidth(int buttonWidth)

The width of the dialog buttons (default: 150).

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