me.leoko.advancedgui.utils.components

Class HoverComponent

java.lang.Object

me.leoko.advancedgui.utils.components.Component

me.leoko.advancedgui.utils.components.HoverComponent

public class HoverComponent
extends Component

The HoverComponent displays a certain component depending on whether the cursor is in-bounds.

Field Summary

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

clickAction, hidden, id, interaction

Constructor Summary

Constructors

Constructor and Description
HoverComponent(String id, Action clickAction, boolean hidden, Interaction interaction, @NotNull Component normal, @NotNull Component hovered) Instantiates a new HoverComponent.

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.
HoverComponent	clone(Interaction interaction) Clone the component with the new interaction.
Component	getHovered() Gets the hovered component.
Component	getNormal() Gets the normal component.
String	getState(org.bukkit.entity.Player player, GuiPoint cursor) Gets the current state of the component for the given parameters.
boolean	isInBounds(org.bukkit.entity.Player player, GuiPoint cursor) Checks whether the cursor is in bounds of the component.
Component	locate(String componentId) Locate the component with the given id.
HoverComponent	locateOn(Interaction interaction) Locate the same component on a different interaction.
void	onClick(org.bukkit.entity.Player player, GuiPoint cursor, boolean isPrimary) Called when a player clicks on the component.
void	setHovered(Component hovered) Sets the hovered component.
void	setNormal(Component normal) Sets the normal component.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

HoverComponent

public HoverComponent(String id,
                      Action clickAction,
                      boolean hidden,
                      Interaction interaction,
                      @NotNull
                      @NotNull Component normal,
                      @NotNull
                      @NotNull Component hovered)

Instantiates a new HoverComponent.

Parameters:

id - the component id

clickAction - the click actions

hidden - the hidden

interaction - the interaction

normal - the normal

hovered - the hovered

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

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

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

locate

public Component locate(String componentId)

Description copied from class: Component

Locate the component with the given id. If this component contains other components then it should search on those as well.

Overrides:

locate in class Component

Parameters:

componentId - the component id

Returns:

the component

clone

public HoverComponent 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 HoverComponent 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

onClick

public void onClick(org.bukkit.entity.Player player,
                    GuiPoint cursor,
                    boolean isPrimary)

Description copied from class: Component

Called when a player clicks on the component.

Overrides:

onClick in class Component

Parameters:

player - the player

cursor - the cursor

isPrimary - whether the click is primary (i.e. whether there was no other component in the way)

getNormal

public Component getNormal()

Gets the normal component.

Returns:

the normal component

setNormal

public void setNormal(Component normal)

Sets the normal component.

Parameters:

normal - the normal component

getHovered

public Component getHovered()

Gets the hovered component.

Returns:

the hovered component

setHovered

public void setHovered(Component hovered)

Sets the hovered component.

Parameters:

hovered - the hovered component