net.risingworld.api.gui

Class GuiTextField

java.lang.Object

net.risingworld.api.gui.GuiElement

net.risingworld.api.gui.GuiTextField

public class GuiTextField
extends GuiElement

A text field gui element, which allows the player to enter some text. After the player entered some text, the onInput() method will be called and a PlayerGuiInputEvent will be triggered (apart from that, you can get the current text at any time of course).

Constructor Summary

Constructors

Constructor and Description
GuiTextField(float x, float y, boolean relativeposition, float width, float height, boolean relativesize)

Method Summary

Modifier and Type	Method and Description
int	getBackgroundPreset()
void	getCurrentText(Player player, Callback<java.lang.String> callback) Gets the current text of the textfield.
java.lang.String	getDefaultText()
Font	getFont() Gets the current font of this textfield.
int	getFontColor() Gets the font color.
int	getMaxCharacters()
boolean	isClickable()
boolean	isEditable() Gets whether or not the textfield is editable.
boolean	isListeningForInput()
void	onInput(PlayerGuiInputEvent event)
void	refresh() Refreshes this element, i.e. synchronizes it between the client and the server.
void	setBackgroundPreset(int preset) Sets a preset background image for the textfield, i.e. a basic gradient image.
void	setClickable(boolean set)
void	setEditable(boolean set) Sets whether or not the textfield is supposed to be editable.
void	setFont(Font font) Sets the font for this textfield.
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	setListenForInput(boolean set) If set to true, a PlayerGuiInputEvent event will be triggered once the player either presses his enter key (while the textfield was focused), or once the textfield loses the focus (i.e. the player clicks somewhere else).
void	setMaxCharacters(int maxchars)
void	setText(java.lang.String text) Sets the default text of this textfield.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiTextField

public GuiTextField(float x,
                    float y,
                    boolean relativeposition,
                    float width,
                    float height,
                    boolean relativesize)

Method Detail

setText

public void setText(java.lang.String text)

Sets the default text of this textfield.

Parameters:

text - the text to set.

getDefaultText

public java.lang.String getDefaultText()

getCurrentText

public void getCurrentText(Player player,
                           Callback<java.lang.String> callback)

Gets the current text of the textfield. Since the text will be received from the client, you have to work with callbacks.

Parameters:

player - the player you want to get the text from.

callback - the callback which will be called once the text has been received from the client.

Example: Get text from textfield using lambda expression

1	textField.getCurrentText(player, (String txt) -> {
2	System.out.println(txt);
3	});

setFont

public void setFont(Font font)

Sets the font for this textfield.

Parameters:

font - the new font.

getFont

public Font getFont()

Gets the current font of this textfield.

Returns:

the current font.

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.

setBackgroundPreset

public void setBackgroundPreset(int preset)

Sets a preset background image for the textfield, i.e. a basic gradient image. Value may be between 0 (no background preset) and 5. Most textfields ingame use preset 5 for the background.

Parameters:

preset - the preset background (0-5).

getBackgroundPreset

public int getBackgroundPreset()

setEditable

public void setEditable(boolean set)

Sets whether or not the textfield is supposed to be editable. True by default.

Parameters:

set - true if this textfield is supposed to be editable, false if not.

isEditable

public boolean isEditable()

Gets whether or not the textfield is editable. True by default.

Returns:

true if it is editable, false if not.

setMaxCharacters

public void setMaxCharacters(int maxchars)

getMaxCharacters

public int getMaxCharacters()

setListenForInput

public void setListenForInput(boolean set)

If set to true, a PlayerGuiInputEvent event will be triggered once the player either presses his enter key (while the textfield was focused), or once the textfield loses the focus (i.e. the player clicks somewhere else). You can retrieve the current text of the textfield from the event.
Note: By default this is set to false!

Parameters:

set - true to listen for input, false if not.

isListeningForInput

public boolean isListeningForInput()

setClickable

public void setClickable(boolean set)

isClickable

public boolean isClickable()

Overrides:

isClickable in class GuiElement

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

onInput

public void onInput(PlayerGuiInputEvent event)