me.leoko.advancedgui.utils.components

Class RectComponent

java.lang.Object

me.leoko.advancedgui.utils.components.Component

me.leoko.advancedgui.utils.components.RectangularComponent

me.leoko.advancedgui.utils.components.RectComponent

public class RectComponent
extends RectangularComponent

The RectComponent displays a colored rectangle.

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
RectComponent(String id, Action clickAction, boolean hidden, Interaction interaction, int x, int y, int width, int height, Color color) Instantiates a new RectComponent (same as RectComponent(String, Action, boolean, Interaction, int, int, int, int, Color) with 0 border radius)
RectComponent(String id, Action clickAction, boolean hidden, Interaction interaction, int x, int y, int width, int height, Color color, int radius) Instantiates a new RectComponent.

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.
RectComponent	clone(Interaction interaction) Clone the component with the new interaction.
Color	getColor() Gets the color.
String	getState(org.bukkit.entity.Player player, GuiPoint cursor) Gets the current state of the component for the given parameters.
RectComponent	locateOn(Interaction interaction) Locate the same component on a different interaction.
void	setColor(Color color) Sets the color.
void	setHeight(int height) Sets the height.
void	setWidth(int width) Sets the width.
void	setX(int x) Sets the x position.
void	setY(int y) Sets the y position.

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

RectComponent

public RectComponent(String id,
                     Action clickAction,
                     boolean hidden,
                     Interaction interaction,
                     int x,
                     int y,
                     int width,
                     int height,
                     Color color)

Instantiates a new RectComponent (same as RectComponent(String, Action, boolean, Interaction, int, int, int, int, Color) with 0 border radius)

RectComponent

public RectComponent(String id,
                     Action clickAction,
                     boolean hidden,
                     Interaction interaction,
                     int x,
                     int y,
                     int width,
                     int height,
                     Color color,
                     int radius)

Instantiates a new RectComponent.

Parameters:

id - the component id

clickAction - the click actions

hidden - the hidden

interaction - the interaction

x - the x

y - the y

width - the width

height - the height

color - the color

radius - the border radius used to round the corners

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

getColor

public Color getColor()

Gets the color.

Returns:

the color

setColor

public void setColor(Color color)

Sets the color.

Parameters:

color - the color

setX

public void setX(int x)

Sets the x position.

Parameters:

x - the x position

setY

public void setY(int y)

Sets the y position.

Parameters:

y - the y position

setWidth

public void setWidth(int width)

Sets the width.

Parameters:

width - the width

setHeight

public void setHeight(int height)

Sets the height.

Parameters:

height - the height