me.leoko.advancedgui.utils.components

Class RemoteImageComponent

java.lang.Object

me.leoko.advancedgui.utils.components.Component

me.leoko.advancedgui.utils.components.RemoteImageComponent

All Implemented Interfaces:

org.bukkit.event.Listener

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

The RemoteImageComponent loads an image from an URL for each interaction. While the image is being loaded (or if loading the image fails) a loading component is being displayed.

Field Summary

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

clickAction, hidden, id, interaction

Constructor Summary

Constructors

Constructor and Description
RemoteImageComponent(String id, Action clickAction, boolean hidden, Interaction interaction, String imageUrl, Component loading, int x, int y, int width, int height, boolean dithering) Instantiates a new Remote image component.

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.
RemoteImageComponent	clone(Interaction interaction) Clone the component with the new interaction.
RemoteImageComponent	copyWith(String id, String newImageUrl) Create a copy of this component with a new image url
void	dispose() Dispose the component.
String	getImageUrl() Gets image url.
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.
RemoteImageComponent	locateOn(Interaction interaction) Locate the same component on a different interaction.
void	onQuit(org.bukkit.event.player.PlayerQuitEvent event)

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

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

RemoteImageComponent

public RemoteImageComponent(String id,
                            Action clickAction,
                            boolean hidden,
                            Interaction interaction,
                            String imageUrl,
                            Component loading,
                            int x,
                            int y,
                            int width,
                            int height,
                            boolean dithering)

Instantiates a new Remote image component.

Parameters:

id - the id

clickAction - the click action

hidden - the hidden

interaction - the interaction

imageUrl - the image url

loading - the loading

x - the x

y - the y

width - the width

height - the height

dithering - the dithering

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

dispose

public void dispose()

Description copied from class: Component

Dispose the component.

Overrides:

dispose in class Component

onQuit

public void onQuit(org.bukkit.event.player.PlayerQuitEvent event)

getImageUrl

public String getImageUrl()

Gets image url.

Returns:

the image url

copyWith

public RemoteImageComponent copyWith(String id,
                                     String newImageUrl)

Create a copy of this component with a new image url

Parameters:

id - the id of the copy

newImageUrl - the new image url

Returns:

the remote image component copy