net.risingworld.api.gui

Class GuiElement

java.lang.Object

net.risingworld.api.gui.GuiElement

Direct Known Subclasses:

GuiFileBrowser, GuiImage, GuiLabel, GuiPaintable, GuiPanel, GuiTextField

public abstract class GuiElement
extends java.lang.Object

Base class for all gui elements.

Method Summary

Modifier and Type	Method and Description
void	addChild(GuiElement child) Attaches another gui element as "child" to this element.
void	destroy() Destroys this element, i.e. remove it from all players.
boolean	equals(java.lang.Object o)
float	getAlpha() Gets the current alpha value of this element.
int	getBorderColor() Gets the current border color.
float	getBorderThickness() Gets the "thickness" of the border.
java.util.List<GuiElement>	getChildren() Returns a list of all children which were added to this element.
int	getColor() Gets the current RGBA color value as an int value.
float	getHeight() Gets the height of this element.
int	getHoverColor()
int	getID() Gets the internal id of this element.
GuiElement	getParent() Gets the parent of this element.
int	getParentID() Gets the id of the parent.
PivotPosition	getPivot() Gets the pivot of this element.
float	getPositionX() Gets the x (horizontal) position of this element.
float	getPositionY() Gets the y (vertical) position of this element.
float	getWidth() Gets the width of this element.
int	hashCode()
boolean	isAlwaysInBackground()
boolean	isAlwaysOnTop()
boolean	isClickable()
boolean	isRelativeBorderThickness() Gets whether or not the border thickness is a relative value.
boolean	isRelativePosition() Gets whether or not the current position coordinates are relative.
boolean	isRelativeSize() Gets wheter or not the current size values are relative.
boolean	isVisible() Gets whether or not this element is visible.
void	onClick(PlayerGuiElementClickEvent event) Override this method if you want to get the click event (when a player clicks on the element) directly, without having to register an event listener.
void	refresh() Refreshes this element, i.e. synchronizes it between the client and the server.
void	removeAllChildren()
void	removeChild(GuiElement child) Removes, i.e. detaches a child element.
void	removeFromParent() Removes an element from its parent.
void	setAlpha(float alpha) Sets the alpha value (opacity) for this element. 0 makes the element invisible, 1 fully opaque.
void	setAlwaysInBackground(boolean set)
void	setAlwaysOnTop(boolean set) Sets the element to be always visible in front of other gui elements.
void	setBorderColor(float r, float g, float b, float a) Sets the color of the border.
void	setBorderColor(int color) Sets the color of the border.
void	setBorderThickness(float thickness, boolean relative) Sets the border of this element.
void	setColor(float r, float g, float b, float a) Sets the color (i.e. background color) of this element.
void	setColor(int color) Sets the color (i.e. background color) of this element.
void	setPivot(PivotPosition pivot) Sets the pivot for this element, this determines the actual location of the position coordinate.
void	setPosition(float x, float y, boolean relative) Sets the screen position of this element.
void	setSize(float width, float height, boolean relative) Sets the size of this element.
void	setVisible(boolean set) Sets the visibility of this element.

Methods inherited from class java.lang.Object

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

Method Detail

setPosition

public void setPosition(float x,
                        float y,
                        boolean relative)

Sets the screen position of this element. By default the position coordinate is at the bottom left of the element, but it depends on the actual position of the pivot (see: setPivot(net.risingworld.api.gui.PivotPosition)).

Parameters:

x - the x (horizontal) position.

y - the y (vertical) position.

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

getPositionX

public float getPositionX()

Gets the x (horizontal) position of this element.

Returns:

the x position.

getPositionY

public float getPositionY()

Gets the y (vertical) position of this element.

Returns:

the y position.

isRelativePosition

public boolean isRelativePosition()

Gets whether or not the current position coordinates are relative.

Returns:

true if the coordinates are relative, false if absolute.

setSize

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

Sets the size of this element.

Parameters:

width - the width of this element.

height - the height of this element.

relative - 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 panel which covers the whole screen

1	GuiPanel panel = new GuiPanel();
2
3	//We use relative coordinates, range is between 0 (smaller than 1 pixel)
4	//and 1 (screen size)
5	panel.setSize(1.0f, 1.0f, true);

getWidth

public float getWidth()

Gets the width of this element.

Returns:

the current width.

getHeight

public float getHeight()

Gets the height of this element.

Returns:

the current height.

isRelativeSize

public boolean isRelativeSize()

Gets wheter or not the current size values are relative.

Returns:

true if the coordinates are relative, false if absolute.

setPivot

public void setPivot(PivotPosition pivot)

Sets the pivot for this element, this determines the actual location of the position coordinate. If the pivot is set to BottomLeft, the position coordinate is at the bottom left corner of the element, if the pivot is set to Center, the position coordinate is in the center of the element etc.

Parameters:

pivot - the pivot. Default pivot is BottomLeft.

Example #1: Place a gui element exactly in the center of the screen

1	//Example panel, we use relative coordinates since we don't know the
2	//players screen size. For the size, we use absolute coordinates in this
3	//example (100x100 pixels)
4	GuiPanel panel = new GuiPanel(0.5f, 0.5f, true, 100, 100, false);
5
6	//Now we set the pivot to the center, in combination with the 0.5f relative
7	//position coordinates, the panel will be placed exactly in the center of
8	//the screen
9	panel.setPivot(PivotPosition.Center);
10
11	//Attach the panel to a player
12	Player p = getServer().getPlayer("DrStrangelove");
13	p.addGuiElement(panel);

Example #2: Place a gui element in the top left corner of the screen

1	//Example label, we use we use relative coordinates since we don't know the
2	//players screen size. We still want some space between the border of the screen
3	//and the label, so we don't use 1.0f coordinates, but 0.95f and 0.9f instead.
4	GuiLabel label = new GuiLabel("This is a test label", 0.95f, 0.9f, true);
5
6	//Pivot of the element will be set to top left
7	label.setPivot(PivotPosition.TopLeft);

getPivot

public PivotPosition getPivot()

Gets the pivot of this element.

Returns:

the pivot.

setColor

public void setColor(int color)

Sets the color (i.e. background color) of this element.

Parameters:

color - an RGBA integer value which specifies the color.

setColor

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

Sets the color (i.e. background color) of this element.

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 element invisible, 1 fully opaque.

Example: Create a red panel, half transparent

1	GuiPanel panel = new GuiPanel();
2	panel.setColor(1f, 0f, 0f, 0.5f);

getColor

public int getColor()

Gets the current RGBA color value as an int value.

Returns:

the current RGBA color.

setBorderThickness

public void setBorderThickness(float thickness,
                               boolean relative)

Sets the border of this element. If set to 0, the border will be disabled.

Parameters:

thickness - the "thickness" of the border. 0 to disable the border.

relative - determines if the provided "thickness" value is an absolute (i.e. pixels) or a relative value (0.0 - 1.0).

getBorderThickness

public float getBorderThickness()

Gets the "thickness" of the border.

Returns:

the border thickness.

isRelativeBorderThickness

public boolean isRelativeBorderThickness()

Gets whether or not the border thickness is a relative value.

Returns:

true if the thickness is a relative value, false if not.

setBorderColor

public void setBorderColor(int color)

Sets the color of the border.

Parameters:

color - the new border color, as an int RGBA value.

setBorderColor

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

Sets the color of the border.

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 border invisible, 1 fully opaque.

getBorderColor

public int getBorderColor()

Gets the current border color.

Returns:

the border color, as an int RGBA value.

setAlpha

public void setAlpha(float alpha)

Sets the alpha value (opacity) for this element. 0 makes the element invisible, 1 fully opaque.

Parameters:

alpha - the alpha value (0-1).

getAlpha

public float getAlpha()

Gets the current alpha value of this element.

Returns:

the alpha value.

getID

public int getID()

Gets the internal id of this element.

Returns:

the internal id.

isClickable

public boolean isClickable()

setVisible

public void setVisible(boolean set)

Sets the visibility of this element.

Parameters:

set - false to hide this element, true to show it.

isVisible

public boolean isVisible()

Gets whether or not this element is visible.

Returns:

true if the element is visible, false if not.

destroy

public void destroy()

Destroys this element, i.e. remove it from all players.

addChild

public void addChild(GuiElement child)

Attaches another gui element as "child" to this element. If you make any changes to this element (i.e. move it, resize it, change visibility), it will affect all childs automatically. In general, all position coordinates of gui elements are always in relation to their parents.
By default, elements have no parents. If an element has no parent, the screen is considered as the parent.
Note: Even if you add an element as a child to another element, you still have to add every element to the player manually (see Player.addGuiElement(net.risingworld.api.gui.GuiElement)). Maybe this will change in future releases.

Parameters:

child - the element you want to attach to this element.

Example: Create a label (as child) in front of a panel (parent)

1	//Create the "parent" panel
2	GuiPanel panel = new GuiPanel(0.25f, 0.25f, true, 0.5f, 0.2f, true);
3
4	//Change color (transparent gray)
5	panel.setColor(0.5f, 0.5f, 0.5f, 0.5f);
6
7	//Add panel to player gui
8	player.addGuiElement(panel);
9
10	//Now create a label exactly in the center of the panel (as a child)
11	//Since the label will be a child, the position is relative to the parent position!
12	GuiLabel label = new GuiLabel("I'm a child element!", 0.5f, 0.5f, true);
13
14	//Select "Center" pivot
15	label.setPivot(PivotPosition.Center);
16
17	//Change font size, for example
18	label.setFontSize(42);
19
20	//Add label as child element to "panel"
21	panel.addChild(label);
22
23	//Remember that you still have to add the label to the player gui!
24	player.addGuiElement(label);

removeChild

public void removeChild(GuiElement child)

Removes, i.e. detaches a child element.

Parameters:

child - the child you want to detach.

See Also:

addChild(net.risingworld.api.gui.GuiElement)

removeAllChildren

public void removeAllChildren()

getChildren

public java.util.List<GuiElement> getChildren()

Returns a list of all children which were added to this element.

Returns:

an unmodifiable list of all child elements. If this element has no children, null is returned.

removeFromParent

public void removeFromParent()

Removes an element from its parent. If this element has no parent, nothing happens.

getParent

public GuiElement getParent()

Gets the parent of this element.

Returns:

the parent of this element, or null if this element has no parent.

getParentID

public int getParentID()

Gets the id of the parent.

Returns:

the parent id, or -1 if this element has no parent.

getHoverColor

public int getHoverColor()

setAlwaysOnTop

public void setAlwaysOnTop(boolean set)

Sets the element to be always visible in front of other gui elements. This also applies to default gui elements of the game, i.e. if you want your element to be visible in front of the inventory, for example, you can set this flag.

Parameters:

set - true to set this element to stay always in front of other elements ("always on top"), false to set it to default behaviour.

See Also:

setAlwaysInBackground(boolean)

isAlwaysOnTop

public boolean isAlwaysOnTop()

setAlwaysInBackground

public void setAlwaysInBackground(boolean set)

isAlwaysInBackground

public boolean isAlwaysInBackground()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

refresh

public void refresh()

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

onClick

public void onClick(PlayerGuiElementClickEvent event)

Override this method if you want to get the click event (when a player clicks on the element) directly, without having to register an event listener.

Parameters:

event - the gui click event.

See Also:

PlayerGuiElementClickEvent

Example:

1	//Create a label as "anonymous class", i.e. override the onClick()
2	//method during initialization. If the player clicks on the label, both
3	//the "PlayerGuiElementClickEvent" and the "onClick()"-method will be called
4	GuiLabel label = new GuiLabel("Click me!", 0.5f, 0.25f, true){
5	@Override
6	public void onClick(PlayerGuiElementClickEvent event){
7	//Do something, e.g. enable wireframe mode for player
8	event.getPlayer().executeConsoleCommand("wireframe");
9
10	//Remove the label from player gui if you want
11	//Since we're "inside" the GuiLabel class, this represents the actual label instance
12	event.getPlayer().removeGuiElement(this);
13	}
14	};
15
16	//Set label clickable
17	label.setClickable(true);
18
19	//Remember to add label to player gui
20	player.addGuiElement(label);