me.leoko.advancedgui.utils.components

Class ImageComponent

java.lang.Object

me.leoko.advancedgui.utils.components.Component

me.leoko.advancedgui.utils.components.RectangularComponent

me.leoko.advancedgui.utils.components.ImageComponent

public class ImageComponent
extends RectangularComponent

The ImageComponent displays an image.

Field Summary

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

height, width, x, y

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

clickAction, hidden, id, interaction

Constructor Summary

Constructors

Constructor and Description
ImageComponent(String id, Action clickAction, boolean hidden, Interaction interaction, int x, int y, BufferedImage image) Instantiates a new ImageComponent.

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.
ImageComponent	clone(Interaction interaction) Clone the component with the new interaction.
Image	getImage() Gets the image.
String	getState(org.bukkit.entity.Player player, GuiPoint cursor) Gets the current state of the component for the given parameters.
ImageComponent	locateOn(Interaction interaction) Locate the same component on a different interaction.
void	setImage(BufferedImage image) Sets the image.

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

getHeight, getWidth, getX, getY, isInBounds

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

ImageComponent

public ImageComponent(String id,
                      Action clickAction,
                      boolean hidden,
                      Interaction interaction,
                      int x,
                      int y,
                      BufferedImage image)

Instantiates a new ImageComponent.

Parameters:

id - the component id

clickAction - the click actions

hidden - the hidden

interaction - the interaction

x - the x

y - the y

image - the image

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

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

getImage

public Image getImage()

Gets the image.

Returns:

the image

setImage

public void setImage(BufferedImage image)

Sets the image.

Parameters:

image - the image