Package eu.xap3y.xagui.models

Class GuiButton

Object

GuiButton

All Implemented Interfaces:

GuiButtonInterface

public class GuiButton
extends Object
implements GuiButtonInterface

Represents a button in a GUI.

A GuiButton wraps an ItemStack and optional click behavior. It supports:

• Setting item metadata (name, lore, amount, flags)
• Adding/removing enchantments
• A click listener
• An optional redirect to another menu after click
• An optional click sound

All setter-like methods return this for fluent chaining.

Constructor Summary

Constructors

Constructor	Description
GuiButton(XMaterial xmaterial)	Create a new GuiButton with a XMaterial (amount 1).
GuiButton(ItemStack item)	Create a new GuiButton from an ItemStack.
GuiButton(Material material)	Create a new GuiButton with a Material (amount 1).

Method Summary

Modifier and Type	Method	Description
GuiButton	addEnchantment(Enchantment enchantment)	Add an unsafe enchantment at level 1.
GuiButton	addEnchantment(Enchantment enchantment, int level)	Add an unsafe enchantment with a custom level.
GuiButton	addItemFlag(ItemFlag flag)	Add an item flag to the icon.
GuiButton	addLore(String... args)	Append multiple lore lines from varargs, translating color codes with &.
GuiButton	addLoreArray(String[] array)	Append multiple lore lines from an array, translating color codes with &.
GuiButton	addLoreLine(String line)	Append a single lore line, translating color codes with &.
GuiButton	addLoreList(List<String> lines)	Append multiple lore lines, translating color codes with &.
void	callRedirect(Player p)	If a redirect is configured, open that menu for the given player.
GuiButton	clearLore()	Clear all lore from the item.
GuiButton	clone()	Create a shallow copy of this button.
GuiClickInterface	getClickListener()	Get the configured click listener for this button, if any.
Sound	getClickSound()	Get the sound configured to play on click, if any.
float	getClickSoundVolume()	Get the volume configured for the click sound.
Material	getIcon()	Get the material type of this button's icon.
ItemStack	getItem()	Get this button's ItemStack.
GuiButton	removeAllEnchantments()	Remove all enchantments from the icon.
GuiButton	removeEnchantment(Enchantment enchantment)	Remove a specific enchantment from the icon.
GuiButton	removeItemFlag(ItemFlag flag)	Remove an item flag from the icon.
GuiButton	setAmount(int amount)	Set the stack amount of the icon.
GuiButton	setDurability(short durability)	Set the durability (damage) value of the icon.
void	setItem(ItemStack item)	Replace this button's ItemStack.
GuiButton	setLore(String... args)	Set the lore lines from varargs, translating color codes with &.
GuiButton	setLoreArray(String[] array)	Set the lore lines from an array, translating color codes with &.
GuiButton	setLoreList(List<String> newLore)	Set the lore lines of the button, translating color codes with &.
GuiButton	setName(String name)	Set the display name of the button, supporting color codes with &.
GuiButton	withClickSound(Sound sound, float volume)	Configure a sound to play when this button is clicked.
GuiButton	withListener(GuiClickInterface newListener)	Set the click listener for this button.
GuiButton	withRedirect(Supplier<GuiMenuInterface> menu)	Configure a redirect menu supplier to be opened after this button is clicked.

Methods inherited from class Object

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

Methods inherited from interface GuiButtonInterface

withClickSound

Constructor Details

GuiButton

public GuiButton(ItemStack item)

Create a new GuiButton from an ItemStack.

Parameters:

item - the backing ItemStack

GuiButton

public GuiButton(Material material)

Create a new GuiButton with a Material (amount 1).

Parameters:

material - the material to use

GuiButton

public GuiButton(XMaterial xmaterial)

Create a new GuiButton with a XMaterial (amount 1).

Parameters:

xmaterial - the material to use

Method Details

getIcon

public Material getIcon()

Get the material type of this button's icon.

Specified by:

getIcon in interface GuiButtonInterface

Returns:

the Material of the icon

getItem

public ItemStack getItem()

Get this button's ItemStack.

Specified by:

getItem in interface GuiButtonInterface

Returns:

the ItemStack reference

setItem

public void setItem(ItemStack item)

Replace this button's ItemStack.

Specified by:

setItem in interface GuiButtonInterface

Parameters:

item - the new ItemStack

withListener

public GuiButton withListener(GuiClickInterface newListener)

Set the click listener for this button.

Specified by:

withListener in interface GuiButtonInterface

Parameters:

newListener - the listener to invoke on click

Returns:

this button for chaining

setName

public GuiButton setName(String name)

Set the display name of the button, supporting color codes with &.

Specified by:

setName in interface GuiButtonInterface

Parameters:

name - the new display name

Returns:

this button for chaining

setLoreList

public GuiButton setLoreList(List<String> newLore)

Set the lore lines of the button, translating color codes with &.

Specified by:

setLoreList in interface GuiButtonInterface

Parameters:

newLore - list of lore lines

Returns:

this button for chaining

setLore

public GuiButton setLore(String... args)

Set the lore lines from varargs, translating color codes with &.

Specified by:

setLore in interface GuiButtonInterface

Parameters:

args - lore lines

Returns:

this button for chaining

setLoreArray

public GuiButton setLoreArray(String[] array)

Set the lore lines from an array, translating color codes with &.

Specified by:

setLoreArray in interface GuiButtonInterface

Parameters:

array - lore lines

Returns:

this button for chaining

addLoreLine

public GuiButton addLoreLine(String line)

Append a single lore line, translating color codes with &.

Specified by:

addLoreLine in interface GuiButtonInterface

Parameters:

line - the lore line to add

Returns:

this button for chaining

addLoreList

public GuiButton addLoreList(List<String> lines)

Append multiple lore lines, translating color codes with &.

Specified by:

addLoreList in interface GuiButtonInterface

Parameters:

lines - list of lore lines to add

Returns:

this button for chaining

addLore

public GuiButton addLore(String... args)

Append multiple lore lines from varargs, translating color codes with &.

Specified by:

addLore in interface GuiButtonInterface

Parameters:

args - lore lines

Returns:

this button for chaining

addLoreArray

public GuiButton addLoreArray(String[] array)

Append multiple lore lines from an array, translating color codes with &.

Specified by:

addLoreArray in interface GuiButtonInterface

Parameters:

array - lore lines

Returns:

this button for chaining

clearLore

public GuiButton clearLore()

Clear all lore from the item.

Specified by:

clearLore in interface GuiButtonInterface

Returns:

this button for chaining

addItemFlag

public GuiButton addItemFlag(ItemFlag flag)

Add an item flag to the icon.

Specified by:

addItemFlag in interface GuiButtonInterface

Parameters:

flag - the item flag to add

Returns:

this button for chaining

removeItemFlag

public GuiButton removeItemFlag(ItemFlag flag)

Remove an item flag from the icon.

Specified by:

removeItemFlag in interface GuiButtonInterface

Parameters:

flag - the item flag to remove

Returns:

this button for chaining

setAmount

public GuiButton setAmount(int amount)

Set the stack amount of the icon.

Specified by:

setAmount in interface GuiButtonInterface

Parameters:

amount - new amount

Returns:

this button for chaining

addEnchantment

public GuiButton addEnchantment(Enchantment enchantment)

Add an unsafe enchantment at level 1.

Specified by:

addEnchantment in interface GuiButtonInterface

Parameters:

enchantment - the enchantment to add

Returns:

this button for chaining

addEnchantment

public GuiButton addEnchantment(Enchantment enchantment,
 int level)

Add an unsafe enchantment with a custom level.

Specified by:

addEnchantment in interface GuiButtonInterface

Parameters:

enchantment - the enchantment to add

level - the level to apply

Returns:

this button for chaining

removeEnchantment

public GuiButton removeEnchantment(Enchantment enchantment)

Remove a specific enchantment from the icon.

Specified by:

removeEnchantment in interface GuiButtonInterface

Parameters:

enchantment - the enchantment to remove

Returns:

this button for chaining

removeAllEnchantments

public GuiButton removeAllEnchantments()

Remove all enchantments from the icon.

Specified by:

removeAllEnchantments in interface GuiButtonInterface

Returns:

this button for chaining

setDurability

public GuiButton setDurability(short durability)

Set the durability (damage) value of the icon. Note: durability is deprecated for modern versions in favor of Damageable meta.

Specified by:

setDurability in interface GuiButtonInterface

Parameters:

durability - the durability value

Returns:

this button for chaining

getClickListener

public GuiClickInterface getClickListener()

Get the configured click listener for this button, if any.

Specified by:

getClickListener in interface GuiButtonInterface

Returns:

the listener or null

getClickSound

public Sound getClickSound()

Get the sound configured to play on click, if any.

Specified by:

getClickSound in interface GuiButtonInterface

Returns:

the click sound or null

getClickSoundVolume

public float getClickSoundVolume()

Get the volume configured for the click sound.

Specified by:

getClickSoundVolume in interface GuiButtonInterface

Returns:

the click sound volume

clone

public GuiButton clone()

Create a shallow copy of this button.

The copy contains a cloned ItemStack and copies over listener, redirect, and sound references.

Specified by:

clone in interface GuiButtonInterface

Overrides:

clone in class Object

Returns:

a cloned GuiButton

withRedirect

public GuiButton withRedirect(Supplier<GuiMenuInterface> menu)

Configure a redirect menu supplier to be opened after this button is clicked.

Specified by:

withRedirect in interface GuiButtonInterface

Parameters:

menu - supplier that returns a target GuiMenuInterface

Returns:

this button for chaining

withClickSound

public GuiButton withClickSound(Sound sound,
 float volume)

Configure a sound to play when this button is clicked. Use null to disable.

Specified by:

withClickSound in interface GuiButtonInterface

Parameters:

sound - the sound to play, or null

volume - the volume to play the sound at

Returns:

this button for chaining

callRedirect

public void callRedirect(Player p)

If a redirect is configured, open that menu for the given player. Also plays the global redirect sound if configured via XaGui.

Specified by:

callRedirect in interface GuiButtonInterface

Parameters:

p - the player to redirect