Package net.wesjd.anvilgui

Class AnvilGUI

java.lang.Object

net.wesjd.anvilgui.AnvilGUI

public class AnvilGUI
extends Object

An anvil gui, used for gathering a user's input

Since:

1.0

Author:

Wesley Smith

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnvilGUI.Builder	A builder class for an AnvilGUI object
static interface	AnvilGUI.ClickHandler	A handler that is called when the user clicks a slot.
static class	AnvilGUI.Response	Deprecated. Since 1.6.2, use AnvilGUI.ResponseAction
static interface	AnvilGUI.ResponseAction	An action to run in response to a player clicking the output slot in the GUI.
static class	AnvilGUI.Slot	Class wrapping the magic constants of slot numbers in an anvil GUI
static final class	AnvilGUI.StateSnapshot	Represents a snapshot of the state of an AnvilGUI

Method Summary

Modifier and Type	Method	Description
void	closeInventory()	Closes the inventory if it's open.
org.bukkit.inventory.Inventory	getInventory()	Returns the Bukkit inventory for this anvil gui
void	setJsonTitle(String json, boolean preserveRenameText)	Updates the title of the AnvilGUI to the new one.
void	setTitle(String literalTitle, boolean preserveRenameText)	Updates the title of the AnvilGUI to the new one.

Methods inherited from class java.lang.Object

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

Method Details

closeInventory

public void closeInventory()

Closes the inventory if it's open.

setTitle

public void setTitle(String literalTitle,
 boolean preserveRenameText)

Updates the title of the AnvilGUI to the new one.

Parameters:

literalTitle - The title to use as literal text

preserveRenameText - Whether to preserve the entered rename text

Throws:

IllegalArgumentException - when literalTitle is null

See Also:

• AnvilGUI.Builder.title(String)

setJsonTitle

public void setJsonTitle(String json,
 boolean preserveRenameText)

Updates the title of the AnvilGUI to the new one.

Parameters:

json - The json used to parse into a rich chat component

preserveRenameText - Whether to preserve the entered rename text

Throws:

IllegalArgumentException - when json is null

See Also:

• AnvilGUI.Builder.jsonTitle(String)

getInventory

public org.bukkit.inventory.Inventory getInventory()

Returns the Bukkit inventory for this anvil gui

Returns:

the Inventory for this anvil gui