me.leoko.advancedgui.utils.components

Class AdaptiveComponent

java.lang.Object

me.leoko.advancedgui.utils.components.Component

me.leoko.advancedgui.utils.components.AdaptiveComponent

All Implemented Interfaces:

org.bukkit.event.Listener

Direct Known Subclasses:

ViewComponent

public class AdaptiveComponent
extends Component
implements org.bukkit.event.Listener

The AdaptiveComponent can display different components depending on the Interaction

Field Summary

Fields

Modifier and Type	Field and Description
protected Component	component The component used when no adaption is present

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

clickAction, hidden, id, interaction

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	adapt(Component adaption) Change which component will be displayed for an interaction.
void	apply(Graphics graphic, org.bukkit.entity.Player player, GuiPoint cursor) Render the component on the provided graphic context.
AdaptiveComponent	clone(Interaction interaction) Clone the component with the new interaction.
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.
AdaptiveComponent	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.

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

Field Detail

component

protected Component component

The component used when no adaption is present

Constructor Detail

AdaptiveComponent

public AdaptiveComponent(String id,
                         Action clickAction,
                         boolean hidden,
                         Interaction interaction,
                         @NotNull
                         @NotNull Component defaultComponent)

Instantiates a new AdaptiveComponent.

Parameters:

id - the component id

clickAction - the click actions

hidden - the hidden

interaction - the interaction

defaultComponent - the default component

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

adapt

public void adapt(Component adaption)

Change which component will be displayed for an interaction.

Parameters:

adaption - the adaption