Module technology.sola.engine

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

Class ButtonGuiElement

java.lang.Object

technology.sola.engine.graphics.gui.GuiElement<Style,ElementType>

technology.sola.engine.graphics.gui.elements.input.BaseInputGuiElement<BaseStyles,ButtonGuiElement>

technology.sola.engine.graphics.gui.elements.input.ButtonGuiElement

@NullMarked
public class ButtonGuiElement
extends BaseInputGuiElement<BaseStyles,ButtonGuiElement>

ButtonGuiElement is a BaseInputGuiElement that allows users to interact via clicking the button or using keyboard shortcuts.

Field Summary

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

children, contentBounds, styleContainer

Constructor Summary

Constructors

Constructor	Description
ButtonGuiElement()	Creates a ButtonGuiElement and adds default event listeners for handling disabled states and when the Key.SPACE key is pressed.

Method Summary

Modifier and Type	Method	Description
@Nullable GuiElementDimensions	calculateContentDimensions()	Calculates content dimensions for this element.
void	renderContent(Renderer renderer)	Method to render the main content of the gui element (not borders, backgrounds, etc.).
ButtonGuiElement	self()
ButtonGuiElement	setOnAction(Runnable onAction)	Sets the action that fires when the button is interacted with.

Methods inherited from class technology.sola.engine.graphics.gui.elements.input.BaseInputGuiElement

isActive, isDisabled, isFocusable, isHovered, setDisabled

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, isAttached, isFocussed, isLayoutChanged, removeChild, render, renderChildren, requestFocus, setId, styles

Methods inherited from class java.lang.Object

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

Constructor Details

ButtonGuiElement

public ButtonGuiElement()

Creates a ButtonGuiElement and adds default event listeners for handling disabled states and when the Key.SPACE key is pressed.

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,ButtonGuiElement>

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,ButtonGuiElement>

Returns:

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

self

public ButtonGuiElement self()

Specified by:

self in class GuiElement<BaseStyles,ButtonGuiElement>

Returns:

A correctly typed reference to this GuiElement

setOnAction

public ButtonGuiElement setOnAction(Runnable onAction)

Sets the action that fires when the button is interacted with.

Parameters:

onAction - the action to execute on button interaction

Returns:

this