me.leoko.advancedgui.utils.components

Class PlaceholderTextComponent

java.lang.Object

me.leoko.advancedgui.utils.components.Component

me.leoko.advancedgui.utils.components.TextComponent

me.leoko.advancedgui.utils.components.PlaceholderTextComponent

All Implemented Interfaces:

org.bukkit.event.Listener

public class PlaceholderTextComponent
extends TextComponent
implements org.bukkit.event.Listener

The PlaceholderTextComponent is a TextComponent that parses placeholders from the PlaceholderAPI.

Nested Class Summary

Nested classes/interfaces inherited from class me.leoko.advancedgui.utils.components.TextComponent

TextComponent.Alignment

Field Summary

Fields inherited from class me.leoko.advancedgui.utils.components.TextComponent

alignment

Fields inherited from class me.leoko.advancedgui.utils.components.Component

clickAction, hidden, id, interaction

Constructor Summary

Constructors

Constructor and Description
PlaceholderTextComponent(String id, Action clickAction, boolean hidden, Interaction interaction, int x, int y, Font font, String text, Color color, TextComponent.Alignment alignment) Instantiates a new PlaceholderText component.

Method Summary

Modifier and Type	Method and Description
void	apply(Graphics graphic, org.bukkit.entity.Player player, GuiPoint cursor) Render the component on the provided graphic context.
PlaceholderTextComponent	clone(Interaction interaction) Clone the component with the new interaction.
void	dispose() Dispose the component.
protected Rectangle2D	getBounds(org.bukkit.entity.Player player)
String	getState(org.bukkit.entity.Player player, GuiPoint cursor) Gets the current state of the component for the given parameters.
protected String	getText(org.bukkit.entity.Player player)
boolean	isInBounds(org.bukkit.entity.Player player, GuiPoint cursor) Checks whether the cursor is in bounds of the component.
PlaceholderTextComponent	locateOn(Interaction interaction) Locate the same component on a different interaction.
void	onQuit(org.bukkit.event.player.PlayerQuitEvent event)

Methods inherited from class me.leoko.advancedgui.utils.components.TextComponent

copyWith, getColor, getFont, getText, getX, getY, setColor, setFont, setText, setX, setY

Methods inherited from class me.leoko.advancedgui.utils.components.Component

getClickAction, getId, getInteraction, isHidden, locate, locate, onClick, setClickAction, setHidden

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaceholderTextComponent

public PlaceholderTextComponent(String id,
                                Action clickAction,
                                boolean hidden,
                                Interaction interaction,
                                int x,
                                int y,
                                Font font,
                                String text,
                                Color color,
                                TextComponent.Alignment alignment)

Instantiates a new PlaceholderText component.

Parameters:

id - the component id

clickAction - the click actions

hidden - the hidden

interaction - the interaction

x - the x

y - the y

font - the font

text - the text

color - the color

alignment - the alignment

Method Detail

apply

public void apply(Graphics graphic,
                  org.bukkit.entity.Player player,
                  GuiPoint cursor)

Description copied from class: Component

Render the component on the provided graphic context.

Overrides:

apply in class TextComponent

Parameters:

graphic - the graphic

player - the player

cursor - the cursor

getState

public String getState(org.bukkit.entity.Player player,
                       GuiPoint cursor)

Description copied from class: Component

Gets the current state of the component for the given parameters. This methods main purpose is to allow caching and reduce the need to render and send data. This method can be executed very frequently (by default every 50ms for every interacting player) so don't do any heavy calculations here.
If Component.apply(Graphics, Player, GuiPoint) renders different content, then the this method should return different strings. If it renders the same the return value should be the same.
A good way to achieve this is to just 'describe' what you would render. (e.g. the RectComponent returns x+"*"+y+"*"+width+"*"+height+"*"+color.getRGB())

Overrides:

getState in class TextComponent

Parameters:

player - the player

cursor - the cursor

Returns:

the state

isInBounds

public boolean isInBounds(org.bukkit.entity.Player player,
                          GuiPoint cursor)

Description copied from class: Component

Checks whether the cursor is in bounds of the component.

Overrides:

isInBounds in class TextComponent

Parameters:

player - the player

cursor - the cursor

Returns:

the boolean

clone

public PlaceholderTextComponent clone(Interaction interaction)

Description copied from class: Component

Clone the component with the new interaction. Used to copy component tree when initializing new interactions.

Overrides:

clone in class TextComponent

Parameters:

interaction - the interaction

Returns:

the component

locateOn

public PlaceholderTextComponent locateOn(Interaction interaction)

Description copied from class: Component

Locate the same component on a different interaction.
In most cases return value can safely be casted to concrete component class.
Alias for:
interaction.getComponentTree().locate(component.getId())

Overrides:

locateOn in class TextComponent

Parameters:

interaction - the interaction

Returns:

the component

getText

protected String getText(org.bukkit.entity.Player player)

Overrides:

getText in class TextComponent

getBounds

protected Rectangle2D getBounds(org.bukkit.entity.Player player)

Overrides:

getBounds in class TextComponent

dispose

public void dispose()

Description copied from class: Component

Dispose the component.

Overrides:

dispose in class Component

onQuit

public void onQuit(org.bukkit.event.player.PlayerQuitEvent event)