net.risingworld.api.gui

Class GuiLabel

java.lang.Object

net.risingworld.api.gui.GuiElement

net.risingworld.api.gui.GuiLabel

public class GuiLabel
extends GuiElement

A gui label / text element.

Constructor Summary

Constructors

Constructor and Description
GuiLabel(float x, float y, boolean relativeposition) Creates a new, empty label (i.e. no text).
GuiLabel(java.lang.String text, float x, float y, boolean relativeposition) Creates a new label with the given text.

Method Summary

Modifier and Type	Method and Description
Font	getFont() Gets the current font of this label.
int	getFontColor() Gets the font color.
int	getFontSize() Gets the current font size.
float	getHeight() This method does not work for labels.
java.lang.String	getText() Gets the current text of this label.
float	getWidth() This method does not work for labels.
boolean	isClickable()
boolean	isColorCodesEnabled() Gets whether or not text-embedded color codes are enabled.
boolean	isRelativeSize() This method does not work for labels.
void	refresh() Refreshes this element, i.e. synchronizes it between the client and the server.
void	setClickable(boolean set)
void	setColorCodesEnabled(boolean set) Sets if text-embedded color codes are enabled.
void	setFont(Font font) Sets the font for this label.
void	setFontColor(float r, float g, float b, float a) Sets the font color, defined as an RGBA int (e.g. 0xFF0000FF).
void	setFontColor(int color) Sets the font color, defined as an RGBA int (e.g. 0xFF0000FF).
void	setFontSize(int size) Sets the font size.
void	setSize(float width, float height, boolean relative) This method does not work for labels.
void	setText(java.lang.String text) Sets the text of this label.

Methods inherited from class net.risingworld.api.gui.GuiElement

addChild, destroy, equals, getAlpha, getBorderColor, getBorderThickness, getChildren, getColor, getHoverColor, getID, getParent, getParentID, getPivot, getPositionX, getPositionY, hashCode, isAlwaysInBackground, isAlwaysOnTop, isRelativeBorderThickness, isRelativePosition, isVisible, onClick, removeAllChildren, removeChild, removeFromParent, setAlpha, setAlwaysInBackground, setAlwaysOnTop, setBorderColor, setBorderColor, setBorderThickness, setColor, setColor, setPivot, setPosition, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiLabel

public GuiLabel(float x,
                float y,
                boolean relativeposition)

Creates a new, empty label (i.e. no text).

Parameters:

x - the x screen position (horizontally).

y - the y screen position (vertically).

relativeposition - set to false to use absolute coordinates (i.e. pixel coordinates), or true to use relative coordinates (range between 0 and 1).

Example: Create a new label in the right bottom corner of the screen

1	//Label with relative coordinates. Coordinates start from the bottom
2	//left corner, i.e. the relative coordinates x=0.9 and y=0.1 are close
3	//to the right corner of the screen.
4	GuiLabel label = new GuiLabel(0.9f, 0.1f, true);
5
6	//Set the text of this label
7	label.setText("Hello World!");
8
9	//Change the pivot of this label to "bottom right"
10	label.setPivot(PivotPosition.BottomRight);
11
12	//We want a bold mono font
13	label.setFont(Font.DefaultMono_Bold);
14
15	//Change the font size (default is 12, we want to make it
16	//a little bit bigger
17	label.setFontSize(20);
18
19
20	//Now find a player (so you can attach the label to his screen)
21	Player player = getServer().getPlayer("MrUnkown");
22
23	//It makes sense to check the player for null (if there was no
24	//such player, for example), in order to avoid any exceptions
25	if(player != null){
26
27	//Attach the label to the screen of the player
28	player.addGuiElement(label);
29
30	}

GuiLabel

public GuiLabel(java.lang.String text,
                float x,
                float y,
                boolean relativeposition)

Creates a new label with the given text.

Parameters:

text - the text for this label.

x - the x screen position (horizontally).

y - the y screen position (vertically).

relativeposition - set to false to use absolute coordinates (i.e. pixel coordinates), or true to use relative coordinates (range between 0 and 1).

Example: Create a new label in the right bottom corner of the screen

1	//Label with relative coordinates. Coordinates start from the bottom
2	//left corner, i.e. the relative coordinates x=0.9 and y=0.1 are close
3	//to the right corner of the screen.
4	GuiLabel label = new GuiLabel("Hello World!", 0.9f, 0.1f, true);
5
6	//Change the pivot of this label to "bottom right"
7	label.setPivot(PivotPosition.BottomRight);
8
9	//We want a bold mono font
10	label.setFont(Font.DefaultMono_Bold);
11
12	//Change the font size (default is 12, we want to make it
13	//a little bit bigger)
14	label.setFontSize(20);
15
16
17	//Now find a player (so you can attach the label to his screen)
18	Player player = getServer().getPlayer("MrUnknown");
19
20	//It makes sense to check the player for null (if there was no
21	//such player, for example), in order to avoid any exceptions
22	if(player != null){
23
24	//Attach the label to the screen of the player
25	player.addGuiElement(label);
26
27	}

Method Detail

setText

public void setText(java.lang.String text)

Sets the text of this label.

Parameters:

text - the text to set.

getText

public java.lang.String getText()

Gets the current text of this label.

Returns:

the text of this label.

setFont

public void setFont(Font font)

Sets the font for this label.

Parameters:

font - the new font.

Example: Create a label and set a handdrawn font

1	GuiLabel txt = new GuiLabel("Rising World", 100, 400, false);
2	txt.setFont(Font.Handdrawn);

getFont

public Font getFont()

Gets the current font of this label.

Returns:

the current font.

setFontSize

public void setFontSize(int size)

Sets the font size.

Parameters:

size - the new size.

getFontSize

public int getFontSize()

Gets the current font size.

Returns:

the font size.

setFontColor

public void setFontColor(int color)

Sets the font color, defined as an RGBA int (e.g. 0xFF0000FF).

Parameters:

color - the new int RGBA color value.

setFontColor

public void setFontColor(float r,
                         float g,
                         float b,
                         float a)

Sets the font color, defined as an RGBA int (e.g. 0xFF0000FF).

Parameters:

r - the red color value (0-1)

g - the green color value (0-1)

b - the blue color value (0-1)

a - the alpha value (0-1), 0 makes the font invisible, 1 fully opaque.

getFontColor

public int getFontColor()

Gets the font color.

Returns:

the font color as an RGBA int.

setColorCodesEnabled

public void setColorCodesEnabled(boolean set)

Sets if text-embedded color codes are enabled. Example: "This is [#FF0000]red [#FFFFFF]and this is [#0000FF]blue", the word "red" would be colored red, and "blue" would be colored blue. The rest of the text is white.

Parameters:

set - true to enable color codes, false to disable them.

Example: Create a black text

1	GuiLabel label = new GuiLabel(0.1f, 0.1f, true);
2	label.setText("[#000000]This is a black text");
3	label.setColorCodesEnabled(true);

isColorCodesEnabled

public boolean isColorCodesEnabled()

Gets whether or not text-embedded color codes are enabled.

Returns:

true if color codes are enabled, false if not.

setClickable

public void setClickable(boolean set)

isClickable

public boolean isClickable()

Overrides:

isClickable in class GuiElement

setSize

public void setSize(float width,
                    float height,
                    boolean relative)

This method does not work for labels.

Overrides:

setSize in class GuiElement

Parameters:

width - N/A

height - N/A

relative - N/A

getWidth

public float getWidth()

This method does not work for labels.

Overrides:

getWidth in class GuiElement

Returns:

zero

getHeight

public float getHeight()

This method does not work for labels.

Overrides:

getHeight in class GuiElement

Returns:

zero

isRelativeSize

public boolean isRelativeSize()

This method does not work for labels.

Overrides:

isRelativeSize in class GuiElement

Returns:

false

refresh

public void refresh()

Description copied from class: GuiElement

Refreshes this element, i.e. synchronizes it between the client and the server. There is no need to call this method manually.

Overrides:

refresh in class GuiElement