Class NamedGui

java.lang.Object

com.github.stefvanschie.inventoryframework.gui.type.util.Gui

com.github.stefvanschie.inventoryframework.gui.type.util.NamedGui

Direct Known Subclasses:

AnvilGui, BarrelGui, BlastFurnaceGui, BrewingStandGui, CartographyTableGui, ChestGui, CrafterGui, CraftingTableGui, DispenserGui, DropperGui, EnchantingTableGui, EnderChestGui, FurnaceGui, GrindstoneGui, HopperGui, LoomGui, MerchantGui, ModernSmithingTableGui, ShulkerBoxGui, SmithingTableGui, SmokerGui, StonecutterGui

public abstract class NamedGui
extends Gui

Field Summary

Fields inherited from class Gui

dirty, humanEntityCache, inventory, onBottomClick, onBottomDrag, onClose, onGlobalClick, onGlobalDrag, onOutsideClick, onTopClick, onTopDrag, plugin, updating

Constructor Summary

Constructors

Constructor	Description
NamedGui(@NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder title)	Constructs a new gui with a title
NamedGui(@NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder title, @NotNull Plugin plugin)	Constructs a new gui with a title for the given plugin.
NamedGui(@NotNull String title)	Constructs a new gui with a title
NamedGui(@NotNull String title, @NotNull Plugin plugin)	Constructs a new gui with a title for the given plugin.

Method Summary

Modifier and Type	Method	Description
@NotNull String	getTitle()	Returns the title of this gui as a legacy string.
@NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder	getTitleHolder()	Returns the title of this GUI in a wrapped form.
boolean	isDirty()	Deprecated. use Gui.isDirty() instead.
void	markChanges()	Deprecated. use Gui.markChanges() instead.
void	setTitle(@NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder title)	Sets the title for this inventory.
void	setTitle(@NotNull String title)	Sets the title for this inventory.

Methods inherited from class Gui

addInventory, callCallback, callOnBottomClick, callOnBottomDrag, callOnClose, callOnGlobalClick, callOnGlobalDrag, callOnOutsideClick, callOnTopClick, callOnTopDrag, click, copy, getGui, getHumanEntityCache, getItems, getViewerCount, getViewers, initializeOrThrow, isPlayerInventoryUsed, isUpdating, load, load, loadPane, loadPane, navigateToParent, registerGui, registerPane, registerPane, registerProperty, setOnBottomClick, setOnBottomDrag, setOnClose, setOnGlobalClick, setOnGlobalDrag, setOnOutsideClick, setOnTopClick, setOnTopDrag, setParent, show, update

Methods inherited from class Object

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

Constructor Details

NamedGui

public NamedGui(@NotNull
 @NotNull String title)

Constructs a new gui with a title

Parameters:

title - the title/name of this gui

Since:

0.8.0

NamedGui

public NamedGui(@NotNull
 @NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder title)

Constructs a new gui with a title

Parameters:

title - the title/name of this gui

Since:

0.10.0

NamedGui

public NamedGui(@NotNull
 @NotNull String title,
 @NotNull
 @NotNull Plugin plugin)

Constructs a new gui with a title for the given plugin.

Parameters:

title - the title/name of this gui

plugin - the owning plugin of this gui

Since:

0.10.8

See Also:

• NamedGui(String)

NamedGui

public NamedGui(@NotNull
 @NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder title,
 @NotNull
 @NotNull Plugin plugin)

Constructs a new gui with a title for the given plugin.

Parameters:

title - the title/name of this gui

plugin - the owning plugin of this gui

Since:

0.10.8

See Also:

• NamedGui(TextHolder)

Method Details

setTitle

public void setTitle(@NotNull
 @NotNull String title)

Sets the title for this inventory.

Parameters:

title - the title

setTitle

public void setTitle(@NotNull
 @NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder title)

Sets the title for this inventory.

Parameters:

title - the title

Since:

0.10.0

getTitle

@NotNull
@Contract(pure=true)
public @NotNull String getTitle()

Returns the title of this gui as a legacy string.

Returns:

the title

Since:

0.8.0

getTitleHolder

@NotNull
@Contract(pure=true)
public @NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder getTitleHolder()

Returns the title of this GUI in a wrapped form.

Returns:

the title

Since:

0.10.0

isDirty

@Contract(pure=true)
@Deprecated
public boolean isDirty()

Deprecated.

use Gui.isDirty() instead.

Gets whether this title is dirty or not i.e. whether the title has changed.

Overrides:

isDirty in class Gui

Returns:

whether the title is dirty

Since:

0.10.0

markChanges

@Deprecated
public void markChanges()

Deprecated.

use Gui.markChanges() instead.

Marks that the changes present here have been accepted. This sets dirty to false. If dirty was already false, this will do nothing.

Overrides:

markChanges in class Gui

Since:

0.10.0