me.leoko.advancedgui.utils.components

Class Component

java.lang.Object

me.leoko.advancedgui.utils.components.Component

Direct Known Subclasses:

AdaptiveComponent, CheckComponent, ClickAnimationComponent, CustomComponent, DummyComponent, GifComponent, GroupComponent, HoverComponent, HoverDetectorComponent, ListComponent, RectangularComponent, RemoteImageComponent, TextComponent, TextInputComponent

public abstract class Component
extends Object

A Component is a part of a Layout. A Component is very versatile it its core its task is to define how it is rendered and when happens when it gets clicked on. Most methods have access to the Player, Interaction and Cursor so they they can implement very advanced logic.

Field Summary

Fields

Modifier and Type	Field and Description
protected Action	clickAction
protected boolean	hidden
protected String	id
protected Interaction	interaction

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Component(String id, Action clickAction, boolean hidden, Interaction interaction) Instantiates a new Component.

Method Summary

Modifier and Type	Method and Description
abstract void	apply(Graphics graphic, org.bukkit.entity.Player player, GuiPoint cursor) Render the component on the provided graphic context.
abstract Component	clone(Interaction interaction) Clone the component with the new interaction.
void	dispose() Dispose the component.
Action	getClickAction() Gets click action.
String	getId() Gets component id.
Interaction	getInteraction() Gets the interaction this component is used in.
abstract String	getState(org.bukkit.entity.Player player, GuiPoint cursor) Gets the current state of the component for the given parameters.
boolean	isHidden() Check whether the component is currently hidden
abstract 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.
<T extends Component> T	locate(String componentId, Class<T> type) Locate the component with the given id and type.
Component	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	setClickAction(Action clickAction) Sets the click action.
void	setHidden(boolean hidden) Sets whether the component is currently hidden.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected final String id

clickAction

protected Action clickAction

interaction

protected final Interaction interaction

hidden

protected boolean hidden

Constructor Detail

Component

protected Component(String id,
                    Action clickAction,
                    boolean hidden,
                    Interaction interaction)

Instantiates a new Component.

Parameters:

id - the components id (should be unique)

clickAction - the click action

hidden - the hidden

interaction - the interaction this component is used in

Method Detail

apply

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

Render the component on the provided graphic context.

Parameters:

graphic - the graphic

player - the player

cursor - the cursor

isInBounds

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

Checks whether the cursor is in bounds of the component.

Parameters:

player - the player

cursor - the cursor

Returns:

the boolean

getState

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

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

Parameters:

player - the player

cursor - the cursor

Returns:

the state

locate

public Component locate(String componentId)

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

Parameters:

componentId - the component id

Returns:

the component

locate

public <T extends Component> T locate(String componentId,
                                      Class<T> type)

Locate the component with the given id and type. If this component contains other components then it should search on those as well. Uses the locate(String) method.

Parameters:

componentId - the component id

Returns:

the component

locateOn

public Component locateOn(Interaction interaction)

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

Parameters:

interaction - the interaction

Returns:

the component

clone

public abstract Component clone(Interaction interaction)

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

Parameters:

interaction - the interaction

Returns:

the component

onClick

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

Called when a player clicks on the 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)

dispose

public void dispose()

Dispose the component.

setClickAction

public void setClickAction(Action clickAction)

Sets the click action.

Parameters:

clickAction - the click action

getId

public String getId()

Gets component id.

Returns:

the id

getClickAction

public Action getClickAction()

Gets click action.

Returns:

the click action

getInteraction

public Interaction getInteraction()

Gets the interaction this component is used in.

Returns:

the interaction

isHidden

public boolean isHidden()

Check whether the component is currently hidden

Returns:

the boolean

setHidden

public void setHidden(boolean hidden)

Sets whether the component is currently hidden.

Parameters:

hidden - the hidden