me.leoko.advancedgui.utils.components

Class HoverDetectorComponent

java.lang.Object

me.leoko.advancedgui.utils.components.Component

me.leoko.advancedgui.utils.components.HoverDetectorComponent

public class HoverDetectorComponent
extends Component

The HoverDetectorComponent executes an Action when a player starts or stops hovering its child component.

Field Summary

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

clickAction, hidden, id, interaction

Constructor Summary

Constructors

Constructor and Description
HoverDetectorComponent(String id, Action clickAction, boolean hidden, Interaction interaction, Action onHoverEnter, Action onHoverExit, Component child) Instantiates a new HoverDetectorComponent

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.
HoverDetectorComponent	clone(Interaction interaction) Clone the component with the new interaction.
Component	getChild() Gets child component.
Action	getOnHoverEnter() Gets on hover enter action.
Action	getOnHoverExit() Gets on hover exit action.
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.
HoverDetectorComponent	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	setChild(Component child) Sets child component.
void	setOnHoverEnter(Action onHoverEnter) Sets on hover enter action.
void	setOnHoverExit(Action onHoverExit) Sets on hover exit action.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

HoverDetectorComponent

public HoverDetectorComponent(String id,
                              Action clickAction,
                              boolean hidden,
                              Interaction interaction,
                              Action onHoverEnter,
                              Action onHoverExit,
                              Component child)

Instantiates a new HoverDetectorComponent

Parameters:

id - the id

clickAction - the click action

hidden - the hidden

interaction - the interaction

onHoverEnter - the on hover enter

onHoverExit - the on hover exit

child - the child

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

clone

public HoverDetectorComponent 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 HoverDetectorComponent 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)

getOnHoverEnter

public Action getOnHoverEnter()

Gets on hover enter action.

Returns:

the on hover enter

setOnHoverEnter

public void setOnHoverEnter(Action onHoverEnter)

Sets on hover enter action.

Parameters:

onHoverEnter - the on hover enter

getOnHoverExit

public Action getOnHoverExit()

Gets on hover exit action.

Returns:

the on hover exit

setOnHoverExit

public void setOnHoverExit(Action onHoverExit)

Sets on hover exit action.

Parameters:

onHoverExit - the on hover exit

getChild

public Component getChild()

Gets child component.

Returns:

the child

setChild

public void setChild(Component child)

Sets child component.

Parameters:

child - the child