me.leoko.advancedgui.utils.components

Class TextComponent

java.lang.Object

me.leoko.advancedgui.utils.components.Component

me.leoko.advancedgui.utils.components.TextComponent

Direct Known Subclasses:

PlaceholderTextComponent

public class TextComponent
extends Component

The TextComponent displays text :)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextComponent.Alignment

Field Summary

Fields

Modifier and Type	Field and Description
protected TextComponent.Alignment	alignment

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

clickAction, hidden, id, interaction

Constructor Summary

Constructors

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

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.
TextComponent	clone(Interaction interaction) Clone the component with the new interaction.
TextComponent	copyWith(String id, String newText) Create a copy of this text component with a new text
protected Rectangle2D	getBounds(org.bukkit.entity.Player player)
Color	getColor() Gets color.
Font	getFont() Gets font.
String	getState(org.bukkit.entity.Player player, GuiPoint cursor) Gets the current state of the component for the given parameters.
String	getText() Gets text.
protected String	getText(org.bukkit.entity.Player player)
int	getX() Gets x.
int	getY() Gets y.
boolean	isInBounds(org.bukkit.entity.Player player, GuiPoint cursor) Checks whether the cursor is in bounds of the component.
TextComponent	locateOn(Interaction interaction) Locate the same component on a different interaction.
void	setColor(Color color) Sets color.
void	setFont(Font font) Sets font.
void	setText(String text) Sets text.
void	setX(int x) Sets x.
void	setY(int y) Sets y.

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

dispose, 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

Field Detail

alignment

protected final TextComponent.Alignment alignment

Constructor Detail

TextComponent

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

Instantiates a new TextComponent.

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

TextComponent

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

Instantiates a new TextComponent.

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 text 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.

Specified by:

apply in class Component

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())

Specified by:

getState in class Component

Parameters:

player - the player

cursor - the cursor

Returns:

the state

clone

public TextComponent clone(Interaction interaction)

Description copied from class: Component

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

Specified by:

clone in class Component

Parameters:

interaction - the interaction

Returns:

the component

locateOn

public TextComponent 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 Component

Parameters:

interaction - the interaction

Returns:

the component

getBounds

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

getText

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

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.

Specified by:

isInBounds in class Component

Parameters:

player - the player

cursor - the cursor

Returns:

the boolean

copyWith

public TextComponent copyWith(String id,
                              String newText)

Create a copy of this text component with a new text

Parameters:

id - the id of the copy

newText - the new text

Returns:

the text component

getX

public int getX()

Gets x.

Returns:

the x

setX

public void setX(int x)

Sets x.

Parameters:

x - the x

getY

public int getY()

Gets y.

Returns:

the y

setY

public void setY(int y)

Sets y.

Parameters:

y - the y

getFont

public Font getFont()

Gets font.

Returns:

the font

setFont

public void setFont(Font font)

Sets font.

Parameters:

font - the font

getText

public String getText()

Gets text.

Returns:

the text

setText

public void setText(String text)

Sets text.

Parameters:

text - the text

getColor

public Color getColor()

Gets color.

Returns:

the color

setColor

public void setColor(Color color)

Sets color.

Parameters:

color - the color