me.leoko.advancedgui.utils

Class Layout

java.lang.Object

me.leoko.advancedgui.utils.Layout

public class Layout
extends Object

The Layout describes how a GUI looks and behaves.

Constructor Summary

Constructors

Constructor and Description
Layout(String name, Function<Interaction,GroupComponent> templateTreeGenerator, GuiSize size) Instantiates a new Layout.

Method Summary

Modifier and Type	Method and Description
byte[][]	getCachedRenderData(String state) Get render data from cache if available null otherwise.
Interaction	getDefaultInteraction() Gets the default interaction.
String	getName() Gets name.
GuiSize	getSize() Gets size.
GroupComponent	getTemplateComponentTree() Gets component tree.
String	processText(org.bukkit.entity.Player player, Interaction interaction, String text) Applies the layout's text processors to the given text.
void	registerTextProcessor(TextProcessor textProcessor) Register a text processor.
byte[][]	render(org.bukkit.entity.Player player, Interaction interaction, GuiPoint cursor, String state) Render this layout with the given parameters.
Interaction	startNewInteraction() Starts new interaction interaction for this GUI.
void	syncExchange(GroupComponent componentTree, List<Component> defaultHidden) Replace current GUI with a new version on runtime.
void	unregisterTextProcessor(TextProcessor textProcessor) Unregister a text processor.

Methods inherited from class java.lang.Object

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

Constructor Detail

Layout

public Layout(String name,
              Function<Interaction,GroupComponent> templateTreeGenerator,
              GuiSize size)

Instantiates a new Layout.

Parameters:

name - the name

templateTreeGenerator - the template tree generator is only called once with the defaultInteraction

size - the size

Method Detail

startNewInteraction

public Interaction startNewInteraction()

Starts new interaction interaction for this GUI.

Returns:

the new interaction

render

public byte[][] render(org.bukkit.entity.Player player,
                       Interaction interaction,
                       GuiPoint cursor,
                       String state)

Render this layout with the given parameters.

Parameters:

player - the player

interaction - the interaction

cursor - the cursor

state - the state

Returns:

the render data

getCachedRenderData

public byte[][] getCachedRenderData(String state)

Get render data from cache if available null otherwise.

Parameters:

state - state

Returns:

render data

processText

public String processText(org.bukkit.entity.Player player,
                          Interaction interaction,
                          String text)

Applies the layout's text processors to the given text. If available PlaceholderAPI will be applied.

Parameters:

player - the player

interaction - the interaction

text - the text

Returns:

the string

registerTextProcessor

public void registerTextProcessor(TextProcessor textProcessor)

Register a text processor.

Parameters:

textProcessor - the text processor

unregisterTextProcessor

public void unregisterTextProcessor(TextProcessor textProcessor)

Unregister a text processor.

Parameters:

textProcessor - the text processor

getTemplateComponentTree

public GroupComponent getTemplateComponentTree()

Gets component tree.

Returns:

the component tree

getName

public String getName()

Gets name.

Returns:

the name

getSize

public GuiSize getSize()

Gets size.

Returns:

the size

getDefaultInteraction

public Interaction getDefaultInteraction()

Gets the default interaction. This interaction is used to render this layout for players that are in sight but are not interacting.

Returns:

the standby interaction

syncExchange

public void syncExchange(GroupComponent componentTree,
                         List<Component> defaultHidden)

Replace current GUI with a new version on runtime.

Parameters:

componentTree - new component tree

defaultHidden - new components to be hidden by default