Module technology.sola.engine

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

Class SectionGuiElement

java.lang.Object

technology.sola.engine.graphics.gui.GuiElement<BaseStyles,SectionGuiElement>

technology.sola.engine.graphics.gui.elements.SectionGuiElement

@NullMarked
public class SectionGuiElement
extends GuiElement<BaseStyles,SectionGuiElement>

SectionGuiElement is a GuiElement that is simply a container for its children elements. It has various keyboard shortcuts for navigating its children.

Field Summary

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

children, contentBounds, styleContainer

Constructor Summary

Constructors

Constructor	Description
SectionGuiElement()	Creates a new SectionGuiElement instance and registers key pressed events for navigating its children.

Method Summary

Modifier and Type	Method	Description
@Nullable GuiElementDimensions	calculateContentDimensions()	Calculates content dimensions for this element.
boolean	isFocusable()
void	renderContent(Renderer renderer)	Method to render the main content of the gui element (not borders, backgrounds, etc.).
void	requestFocus()	Focuses this element if it is able to have focus.
SectionGuiElement	self()

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

SectionGuiElement

public SectionGuiElement()

Creates a new SectionGuiElement instance and registers key pressed events for navigating its children.

Direction: row, row-reverse

• Key.RIGHT - next element
• Key.LEFT - previous element

Direction: column, column-reverse

• Key.DOWN - next element
• Key.UP - previous element

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<BaseStyles,SectionGuiElement>

Parameters:

renderer - the Renderer instance

calculateContentDimensions

public @Nullable 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<BaseStyles,SectionGuiElement>

Returns:

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

self

public SectionGuiElement self()

Specified by:

self in class GuiElement<BaseStyles,SectionGuiElement>

Returns:

A correctly typed reference to this GuiElement

isFocusable

public boolean isFocusable()

Overrides:

isFocusable in class GuiElement<BaseStyles,SectionGuiElement>

Returns:

true if the element is currently focusable

requestFocus

public void requestFocus()

Description copied from class: GuiElement

Focuses this element if it is able to have focus.

Overrides:

requestFocus in class GuiElement<BaseStyles,SectionGuiElement>