Package com.github.stefvanschie.inventoryframework.gui.type

Class CartographyTableGui

java.lang.Object

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

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

com.github.stefvanschie.inventoryframework.gui.type.CartographyTableGui

All Implemented Interfaces:

InventoryBased, InventoryHolder

public class CartographyTableGui
extends NamedGui
implements InventoryBased

Represents a gui in the form of a cartography table

Since:

0.8.0

Field Summary

Fields inherited from class com.github.stefvanschie.inventoryframework.gui.type.util.Gui

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	click(@NotNull InventoryClickEvent event)	This should delegate the provided inventory click event to the right pane, which can then handle this click event further.
@NotNull CartographyTableGui	copy()	Makes a copy of this gui and returns it.
@NotNull Inventory	createInventory()	Creates a new inventory of the type of the implementing class.
@NotNull Inventory	getInventory()
@NotNull InventoryComponent	getMapComponent()	Gets the inventory component representing the map
@NotNull InventoryComponent	getOutputComponent()	Gets the inventory component representing the output
@NotNull InventoryComponent	getPaperComponent()	Gets the inventory component representing the paper
@NotNull InventoryComponent	getPlayerInventoryComponent()	Gets the inventory component representing the player inventory
int	getViewerCount()	Gets the count of HumanEntity instances that are currently viewing this GUI.
@NotNull List<HumanEntity>	getViewers()	Gets a mutable snapshot of the current HumanEntity viewers of this GUI.
void	handleClickEvent(@NotNull InventoryClickEvent event)	Handles an incoming inventory click event
boolean	isPlayerInventoryUsed()	Gets whether the player inventory is currently in use.
static @Nullable CartographyTableGui	load(@NotNull Object instance, @NotNull InputStream inputStream)	Loads a cartography table gui from an XML file.
static @Nullable CartographyTableGui	load(@NotNull Object instance, @NotNull InputStream inputStream, @NotNull Plugin plugin)	Loads a cartography table gui from an XML file.
static @NotNull CartographyTableGui	load(@NotNull Object instance, @NotNull Element element)	Loads a cartography table gui from the specified element, applying code references to the provided instance.
static @NotNull CartographyTableGui	load(@NotNull Object instance, @NotNull Element element, @NotNull Plugin plugin)	Loads a cartography table gui from the specified element, applying code references to the provided instance.
void	show(@NotNull HumanEntity humanEntity)	Shows a gui to a player

Methods inherited from class com.github.stefvanschie.inventoryframework.gui.type.util.NamedGui

getTitle, getTitleHolder, isDirty, markChanges, setTitle, setTitle

Methods inherited from class com.github.stefvanschie.inventoryframework.gui.type.util.Gui

addInventory, callCallback, callOnBottomClick, callOnBottomDrag, callOnClose, callOnGlobalClick, callOnGlobalDrag, callOnOutsideClick, callOnTopClick, callOnTopDrag, getGui, getHumanEntityCache, initializeOrThrow, isUpdating, loadPane, loadPane, registerGui, registerGui, registerPane, registerPane, registerProperty, setOnBottomClick, setOnBottomDrag, setOnClose, setOnGlobalClick, setOnGlobalDrag, setOnOutsideClick, setOnTopClick, setOnTopDrag, update

Methods inherited from class java.lang.Object

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

Constructor Details

CartographyTableGui

public CartographyTableGui(@NotNull
 @NotNull String title)

Constructs a new GUI

Parameters:

title - the title/name of this gui.

Since:

0.8.0

CartographyTableGui

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

Constructs a new GUI

Parameters:

title - the title/name of this gui.

Since:

0.10.0

CartographyTableGui

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

Constructs a new cartography table gui 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:

• CartographyTableGui(String)

CartographyTableGui

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

Constructs a new cartography table gui 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:

• CartographyTableGui(TextHolder)

Method Details

show

public void show(@NotNull
 @NotNull HumanEntity humanEntity)

Description copied from class: Gui

Shows a gui to a player

Specified by:

show in class Gui

Parameters:

humanEntity - the human entity to show the gui to

copy

@NotNull
@Contract(pure=true)
public @NotNull CartographyTableGui copy()

Description copied from class: Gui

Makes a copy of this gui and returns it. This makes a deep copy of the gui. This entails that the underlying panes will be copied as per their Pane.copy() and miscellaneous data will be copied. The copy of this gui, will however have no viewers even if this gui currently has viewers. With this, cache data for viewers will also be non-existent for the copied gui. The original owning plugin of the gui is preserved, but the plugin will not be deeply copied. The returned gui will never be reference equal to the current gui.

Specified by:

copy in class Gui

Returns:

a copy of the gui

click

public void click(@NotNull
 @NotNull InventoryClickEvent event)

Description copied from class: Gui

This should delegate the provided inventory click event to the right pane, which can then handle this click event further. This should not call any internal click handlers, since those will already have been activated.

Specified by:

click in class Gui

Parameters:

event - the event to delegate

getInventory

@NotNull
public @NotNull Inventory getInventory()

Specified by:

getInventory in interface InventoryHolder

isPlayerInventoryUsed

@Contract(pure=true)
public boolean isPlayerInventoryUsed()

Description copied from class: Gui

Gets whether the player inventory is currently in use. This means whether the player inventory currently has an item in it.

Specified by:

isPlayerInventoryUsed in class Gui

Returns:

true if the player inventory is occupied, false otherwise

createInventory

@NotNull
@Contract(pure=true)
public @NotNull Inventory createInventory()

Description copied from interface: InventoryBased

Creates a new inventory of the type of the implementing class.

Specified by:

createInventory in interface InventoryBased

Returns:

the new inventory

getViewerCount

@Contract(pure=true)
public int getViewerCount()

Description copied from class: Gui

Gets the count of HumanEntity instances that are currently viewing this GUI.

Specified by:

getViewerCount in class Gui

Returns:

the count of viewers

getViewers

@NotNull
@Contract(pure=true)
public @NotNull List<HumanEntity> getViewers()

Description copied from class: Gui

Gets a mutable snapshot of the current HumanEntity viewers of this GUI. This is a snapshot (copy) and not a view, therefore modifications aren't visible.

Specified by:

getViewers in class Gui

Returns:

a snapshot of the current viewers

See Also:

• Gui.getViewerCount()

handleClickEvent

public void handleClickEvent(@NotNull
 @NotNull InventoryClickEvent event)

Handles an incoming inventory click event

Parameters:

event - the event to handle

Since:

0.8.0

getMapComponent

@NotNull
@Contract(pure=true)
public @NotNull InventoryComponent getMapComponent()

Gets the inventory component representing the map

Returns:

the map component

Since:

0.8.0

getPaperComponent

@NotNull
@Contract(pure=true)
public @NotNull InventoryComponent getPaperComponent()

Gets the inventory component representing the paper

Returns:

the paper component

Since:

0.8.0

getOutputComponent

@NotNull
@Contract(pure=true)
public @NotNull InventoryComponent getOutputComponent()

Gets the inventory component representing the output

Returns:

the output component

Since:

0.8.0

getPlayerInventoryComponent

@NotNull
@Contract(pure=true)
public @NotNull InventoryComponent getPlayerInventoryComponent()

Gets the inventory component representing the player inventory

Returns:

the player inventory component

Since:

0.8.0

load

@Nullable
@Contract(pure=true)
public static @Nullable CartographyTableGui load(@NotNull
 @NotNull Object instance,
 @NotNull
 @NotNull InputStream inputStream,
 @NotNull
 @NotNull Plugin plugin)

Loads a cartography table gui from an XML file.

Parameters:

instance - the instance on which to reference fields and methods

inputStream - the input stream containing the XML data

plugin - the plugin that will be the owner of the created gui

Returns:

the loaded cartography table gui

Since:

0.10.8

See Also:

• load(Object, InputStream)

load

@NotNull
public static @NotNull CartographyTableGui load(@NotNull
 @NotNull Object instance,
 @NotNull
 @NotNull Element element,
 @NotNull
 @NotNull Plugin plugin)

Loads a cartography table gui from the specified element, applying code references to the provided instance.

Parameters:

instance - the instance on which to reference fields and methods

element - the element to load the gui from

plugin - the plugin that will be the owner of the created gui

Returns:

the loaded cartography table gui

Since:

0.10.8

See Also:

• load(Object, Element)

load

@Nullable
@Contract(pure=true)
public static @Nullable CartographyTableGui load(@NotNull
 @NotNull Object instance,
 @NotNull
 @NotNull InputStream inputStream)

Loads a cartography table gui from an XML file.

Parameters:

instance - the instance on which to reference fields and methods

inputStream - the input stream containing the XML data

Returns:

the loaded cartography table gui

Since:

0.8.0

load

@NotNull
public static @NotNull CartographyTableGui load(@NotNull
 @NotNull Object instance,
 @NotNull
 @NotNull Element element)

Loads a cartography table gui from the specified element, applying code references to the provided instance.

Parameters:

instance - the instance on which to reference fields and methods

element - the element to load the gui from

Returns:

the loaded cartography table gui

Since:

0.8.0