Module technology.sola.engine

Package technology.sola.engine.graphics.gui

Class GuiDocument

java.lang.Object

technology.sola.engine.graphics.gui.GuiDocument

@NullMarked
public class GuiDocument
extends Object

GuiDocument is a container for GuiElement that also handles passing various key and mouse events to the currently active root element set via setRootElement(GuiElement).

Constructor Summary

Constructors

Constructor	Description
GuiDocument(SolaPlatform platform, AssetLoaderProvider assetLoaderProvider, MouseInput mouseInput)	Creates a new GuiDocument instance, registering listeners for key and mouse-related events.

Method Summary

Modifier and Type	Method	Description
<T extends GuiElement<?, ?>> @Nullable T	findElementById(String id, Class<T> elementClass)	Searches the document for a GuiElement with the desired id.
boolean	isFocussed(GuiElement<?,?> guiElement)	Checks to see if a GuiElement currently has focus.
boolean	isVisible()
void	render(Renderer renderer)	Renders the root element to the Renderer.
void	requestFocus(GuiElement<?,?> guiElement)	Gives the desired GuiElement focus.
void	setRootElement(GuiElement<?,?> rootEle)	Sets the current root element used for rendering and receiving events to the desired GuiElement.
void	setVirtualKeyboardVisible(boolean visible)	Sets the visibility of the virtual keyboard.
void	setVisible(boolean isVisible)	Sets whether the GuiDocument will render or not.
void	update()	Updates the GuiDocument's layout state.

Methods inherited from class java.lang.Object

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

Constructor Details

GuiDocument

public GuiDocument(SolaPlatform platform,
 AssetLoaderProvider assetLoaderProvider,
 MouseInput mouseInput)

Creates a new GuiDocument instance, registering listeners for key and mouse-related events.

Parameters:

platform - the SolaPlatform

assetLoaderProvider - the AssetLoaderProvider

mouseInput - the MouseInput

Method Details

isVisible

public boolean isVisible()

Returns:

Whether the GuiDocument will render or not

setVisible

public void setVisible(boolean isVisible)

Sets whether the GuiDocument will render or not.

Parameters:

isVisible - the new visible state

setRootElement

public void setRootElement(GuiElement<?,?> rootEle)

Sets the current root element used for rendering and receiving events to the desired GuiElement. Also updates the currently focused element.

Parameters:

rootEle - the new root element

findElementById

public <T extends GuiElement<?,
?>> @Nullable T findElementById(String id,
 Class<T> elementClass)

Searches the document for a GuiElement with the desired id.

Type Parameters:

T - the type of the element

Parameters:

id - the id of the element

elementClass - the class of the element

Returns:

the element

isFocussed

public boolean isFocussed(GuiElement<?,?> guiElement)

Checks to see if a GuiElement currently has focus.

Parameters:

guiElement - the element to check

Returns:

true if the element is currently focussed

requestFocus

public void requestFocus(GuiElement<?,?> guiElement)

Gives the desired GuiElement focus.

Parameters:

guiElement - the new element to be focussed

setVirtualKeyboardVisible

public void setVirtualKeyboardVisible(boolean visible)

Sets the visibility of the virtual keyboard.

Parameters:

visible - whether the virtual keyboard should be visible or not

update

public void update()

Updates the GuiDocument's layout state. This is usually called via GuiDocumentSystem and should not be called manually.

render

public void render(Renderer renderer)

Renders the root element to the Renderer.

Parameters:

renderer - the renderer