me.leoko.advancedgui.utils.components

Class GifComponent

java.lang.Object

me.leoko.advancedgui.utils.components.Component

me.leoko.advancedgui.utils.components.GifComponent

All Implemented Interfaces:

org.bukkit.event.Listener

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

The GifComponent displays an GIF.

Field Summary

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

clickAction, hidden, id, interaction

Constructor Summary

Constructors

Constructor and Description
GifComponent(String id, Action clickAction, boolean hidden, Interaction interaction, int x, int y, GifFrame[] gifFrames, boolean pausedByDefault) Instantiates a new GifComponent.

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.
GifComponent	clone(Interaction interaction) Clone the component with the new interaction.
GifFrame[]	getGifFrames() Get gif frames
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.
GifComponent	locateOn(Interaction interaction) Locate the same component on a different interaction.
void	setFrame(int frame) Sets which frame is currently shown for a certain interaction
void	setGifFrames(GifFrame[] gifFrames) Sets the GIF.
void	setPaused(boolean paused) Sets whether the GIF is paused for a certain interaction

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

Constructor Detail

GifComponent

public GifComponent(String id,
                    Action clickAction,
                    boolean hidden,
                    Interaction interaction,
                    int x,
                    int y,
                    GifFrame[] gifFrames,
                    boolean pausedByDefault)

Instantiates a new GifComponent.

Parameters:

id - the component id

clickAction - the click actions

hidden - the hidden

interaction - the interaction

x - the x

y - the y

gifFrames - the gif frames

pausedByDefault - the paused by default

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 GifComponent 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 GifComponent 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

getGifFrames

public GifFrame[] getGifFrames()

Get gif frames

Returns:

the gif frames

setPaused

public void setPaused(boolean paused)

Sets whether the GIF is paused for a certain interaction

Parameters:

paused - paused

setFrame

public void setFrame(int frame)

Sets which frame is currently shown for a certain interaction

Parameters:

frame - the frame

setGifFrames

public void setGifFrames(GifFrame[] gifFrames)

Sets the GIF.

Parameters:

gifFrames - the image