Module technology.sola.engine

Package technology.sola.engine.graphics.gui.elements

Class TextGuiElement

java.lang.Object

technology.sola.engine.graphics.gui.GuiElement<TextStyles,TextGuiElement>

technology.sola.engine.graphics.gui.elements.TextGuiElement

@NullMarked
public class TextGuiElement
extends GuiElement<TextStyles,TextGuiElement>

TextGuiElement is a GuiElement that renders text for a GUI. It does not render child elements.

Field Summary

Fields inherited from class technology.sola.engine.graphics.gui.GuiElement

children, contentBounds, styleContainer

Constructor Summary

Constructors

Constructor	Description
TextGuiElement()

Method Summary

Modifier and Type	Method	Description
TextGuiElement	appendChildren(GuiElement<?,?>... children)	TextGuiElement does not render children so this method will do nothing.
GuiElementDimensions	calculateContentDimensions()	Calculates content dimensions for this element.
@Nullable String	getText()
boolean	isFocusable()	TextGuiElement is not focusable so this will return false.
TextGuiElement	removeChild(GuiElement<?,?> child)	TextGuiElement does not render children so this method will do nothing.
void	renderContent(Renderer renderer)	Method to render the main content of the gui element (not borders, backgrounds, etc.).
TextGuiElement	self()
TextGuiElement	setText(String text)	Sets the text that will be rendered.

Methods inherited from class technology.sola.engine.graphics.gui.GuiElement

addStyle, addStyle, addStyles, events, findElementById, findElementsByType, findFocussedChildIndex, getAssetLoaderProvider, getBounds, getContentBounds, getFocusableChildren, getId, getParent, invalidateLayout, isActive, isAttached, isFocussed, isHovered, isLayoutChanged, render, renderChildren, requestFocus, setId, setVirtualKeyboardVisible, styles

Methods inherited from class java.lang.Object

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

Constructor Details

TextGuiElement

public TextGuiElement()

Method Details

renderContent

public void renderContent(Renderer renderer)

Description copied from class: GuiElement

Method to render the main content of the gui element (not borders, backgrounds, etc.).

Specified by:

renderContent in class GuiElement<TextStyles,TextGuiElement>

Parameters:

renderer - the Renderer instance

calculateContentDimensions

public GuiElementDimensions calculateContentDimensions()

Description copied from class: GuiElement

Calculates content dimensions for this element. If its dimensions are derived from only its children then it should return null.

Specified by:

calculateContentDimensions in class GuiElement<TextStyles,TextGuiElement>

Returns:

the dimensions of the content of this element or null if only children dimensions matter

self

public TextGuiElement self()

Specified by:

self in class GuiElement<TextStyles,TextGuiElement>

Returns:

A correctly typed reference to this GuiElement

isFocusable

public boolean isFocusable()

TextGuiElement is not focusable so this will return false.

Overrides:

isFocusable in class GuiElement<TextStyles,TextGuiElement>

Returns:

false

appendChildren

public TextGuiElement appendChildren(GuiElement<?,?>... children)

TextGuiElement does not render children so this method will do nothing.

Overrides:

appendChildren in class GuiElement<TextStyles,TextGuiElement>

Parameters:

children - the child elements to add

Returns:

this

removeChild

public TextGuiElement removeChild(GuiElement<?,?> child)

TextGuiElement does not render children so this method will do nothing.

Overrides:

removeChild in class GuiElement<TextStyles,TextGuiElement>

Parameters:

child - the child element that will not be removed

Returns:

this

getText

public @Nullable String getText()

Returns:

the text that will be rendered

setText

public TextGuiElement setText(String text)

Sets the text that will be rendered.

Parameters:

text - the new text to be rendered

Returns:

this