Package io.github.projectunified.unidialog.spigot.action

Class SpigotDialogActionBuilder

java.lang.Object

io.github.projectunified.unidialog.spigot.action.SpigotDialogActionBuilder

All Implemented Interfaces:

DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

public class SpigotDialogActionBuilder
extends Object
implements DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Field Summary

Fields inherited from interface io.github.projectunified.unidialog.core.action.DialogActionBuilder

DEFAULT_WIDTH

Constructor Summary

Constructors

Constructor	Description
SpigotDialogActionBuilder(String defaultNamespace)

Method Summary

Modifier and Type	Method	Description
SpigotDialogActionBuilder	copyToClipboard(String value)	Set the action to be a copy-to-clipboard action
SpigotDialogActionBuilder	dynamicCustom(String id)	Set the action to be a dynamic custom action
SpigotDialogActionBuilder	dynamicCustom(String namespace, String id)	Set the action to be a dynamic custom action with a namespace
SpigotDialogActionBuilder	dynamicRunCommand(String template)	Set the action to be a dynamic run command action
net.md_5.bungee.api.dialog.action.ActionButton	getAction()
SpigotDialogActionBuilder	label(String label)	Set the label for the dialog action
SpigotDialogActionBuilder	label(net.md_5.bungee.api.chat.BaseComponent label)	Set the label for the dialog action
SpigotDialogActionBuilder	openUrl(String url)	Set the action to be an open-URL action
SpigotDialogActionBuilder	runCommand(String command)	Set the action to be a run command action
SpigotDialogActionBuilder	showDialog(DialogOpener dialogOpener)	Set the action to be a show dialog action
SpigotDialogActionBuilder	showDialog(SpigotDialog<?> dialog)	Set the action to be a show dialog action
SpigotDialogActionBuilder	showDialog(String namespace, String dialogId)	Set the action to be a show dialog action
SpigotDialogActionBuilder	suggestCommand(String command)	Set the action to be a suggest command action
SpigotDialogActionBuilder	tooltip(@Nullable String tooltip)	Set the tooltip for the dialog action
SpigotDialogActionBuilder	tooltip(@Nullable net.md_5.bungee.api.chat.BaseComponent tooltip)	Set the tooltip for the dialog action
SpigotDialogActionBuilder	width(int width)	Set the width for the dialog action

Methods inherited from class java.lang.Object

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

Constructor Details

SpigotDialogActionBuilder

public SpigotDialogActionBuilder(String defaultNamespace)

Method Details

label

public SpigotDialogActionBuilder label(net.md_5.bungee.api.chat.BaseComponent label)

Set the label for the dialog action

Parameters:

label - the label to set

Returns:

the current instance of the builder for method chaining

label

public SpigotDialogActionBuilder label(String label)

Description copied from interface: DialogActionBuilder

Set the label for the dialog action

Specified by:

label in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

label - the label to set

Returns:

the current instance of the builder for method chaining

tooltip

public SpigotDialogActionBuilder tooltip(@Nullable
 @Nullable net.md_5.bungee.api.chat.BaseComponent tooltip)

Set the tooltip for the dialog action

Parameters:

tooltip - the tooltip to set, can be null

Returns:

the current instance of the builder for method chaining

tooltip

public SpigotDialogActionBuilder tooltip(@Nullable
 @Nullable String tooltip)

Description copied from interface: DialogActionBuilder

Set the tooltip for the dialog action

Specified by:

tooltip in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

tooltip - the tooltip to set, can be null

Returns:

the current instance of the builder for method chaining

width

public SpigotDialogActionBuilder width(int width)

Description copied from interface: DialogActionBuilder

Set the width for the dialog action

Specified by:

width in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

width - the width to set

Returns:

the current instance of the builder for method chaining

copyToClipboard

public SpigotDialogActionBuilder copyToClipboard(String value)

Description copied from interface: DialogActionBuilder

Set the action to be a copy-to-clipboard action

Specified by:

copyToClipboard in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

value - the value to copy to the clipboard

Returns:

the current instance of the builder for method chaining

dynamicCustom

public SpigotDialogActionBuilder dynamicCustom(String id)

Description copied from interface: DialogActionBuilder

Set the action to be a dynamic custom action

Specified by:

dynamicCustom in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

id - the identifier for the dynamic custom action

Returns:

the current instance of the builder for method chaining

dynamicCustom

public SpigotDialogActionBuilder dynamicCustom(String namespace,
 String id)

Description copied from interface: DialogActionBuilder

Set the action to be a dynamic custom action with a namespace

Specified by:

dynamicCustom in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

namespace - the namespace for the dynamic custom action

id - the identifier for the dynamic custom action

Returns:

the current instance of the builder for method chaining

dynamicRunCommand

public SpigotDialogActionBuilder dynamicRunCommand(String template)

Description copied from interface: DialogActionBuilder

Set the action to be a dynamic run command action

Specified by:

dynamicRunCommand in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

template - the command template to run

Returns:

the current instance of the builder for method chaining

openUrl

public SpigotDialogActionBuilder openUrl(String url)

Description copied from interface: DialogActionBuilder

Set the action to be an open-URL action

Specified by:

openUrl in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

url - the URL to open

Returns:

the current instance of the builder for method chaining

runCommand

public SpigotDialogActionBuilder runCommand(String command)

Description copied from interface: DialogActionBuilder

Set the action to be a run command action

Specified by:

runCommand in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

command - the command to run

Returns:

the current instance of the builder for method chaining

suggestCommand

public SpigotDialogActionBuilder suggestCommand(String command)

Description copied from interface: DialogActionBuilder

Set the action to be a suggest command action

Specified by:

suggestCommand in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

command - the command to suggest

Returns:

the current instance of the builder for method chaining

showDialog

public SpigotDialogActionBuilder showDialog(SpigotDialog<?> dialog)

Description copied from interface: DialogActionBuilder

Set the action to be a show dialog action

Specified by:

showDialog in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

dialog - the dialog to show

Returns:

the current instance of the builder for method chaining

showDialog

public SpigotDialogActionBuilder showDialog(String namespace,
 String dialogId)

Description copied from interface: DialogActionBuilder

Set the action to be a show dialog action

Specified by:

showDialog in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

namespace - the namespace of the dialog

dialogId - the identifier of the dialog to show

Returns:

the current instance of the builder for method chaining

showDialog

public SpigotDialogActionBuilder showDialog(DialogOpener dialogOpener)

Description copied from interface: DialogActionBuilder

Set the action to be a show dialog action

Specified by:

showDialog in interface DialogActionBuilder<SpigotDialog<?>,SpigotDialogActionBuilder>

Parameters:

dialogOpener - the dialog opener to use for showing the dialog

Returns:

the current instance of the builder for method chaining

getAction

public net.md_5.bungee.api.dialog.action.ActionButton getAction()