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(@NonNull DialogBase base, List<Dialog> dialogs, ActionButton exitAction, Integer columns, Integer buttonWidth)
DialogListDialog(@NonNull DialogBase base, Dialog... dialogs)

Method Summary

Modifier and Type	Method	Description
Integer	buttonWidth()	The width of the dialog buttons (default: 150, minimum: 1, maximum: 1024).
DialogListDialog	buttonWidth(Integer buttonWidth)
Integer	columns()	The number of columns for the dialog buttons (default: 2).
DialogListDialog	columns(Integer columns)
List<Dialog>	dialogs()	The child dialogs behind each button.
DialogListDialog	dialogs(List<Dialog> dialogs)	The child dialogs behind each button.
boolean	equals(Object o)
ActionButton	exitAction()	The ActionButton activated when the dialog is exited.
DialogListDialog	exitAction(ActionButton exitAction)	The ActionButton activated when the dialog is exited.
@NonNull DialogBase	getBase()	Gets the dialog base which contains the dialog title and other options common to all types of dialogs.
int	hashCode()
void	setBase(@NonNull DialogBase base)	Sets the dialog base.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DialogListDialog

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

DialogListDialog

public DialogListDialog(@NonNull
 @NonNull DialogBase base,
 List<Dialog> dialogs,
 ActionButton exitAction,
 Integer columns,
 Integer buttonWidth)

Method Details

columns

public DialogListDialog columns(Integer columns)

buttonWidth

public DialogListDialog buttonWidth(Integer buttonWidth)

getBase

@NonNull
public @NonNull 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.

exitAction

public ActionButton exitAction()

The ActionButton activated when the dialog is exited.

columns

public Integer columns()

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

buttonWidth

public Integer buttonWidth()

The width of the dialog buttons (default: 150, minimum: 1, maximum: 1024).

setBase

public void setBase(@NonNull
 @NonNull 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.

exitAction

public DialogListDialog exitAction(ActionButton exitAction)

The ActionButton activated when the dialog is exited.

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