Module technology.sola.engine

Package technology.sola.engine.graphics.gui.navigation

Class GuiNavigator

java.lang.Object

technology.sola.engine.graphics.gui.navigation.GuiNavigator

@NullMarked
public class GuiNavigator
extends Object

GuiNavigator is a class that manages navigation between GuiNavigationScreens.

Constructor Summary

Constructors

Constructor	Description
GuiNavigator(GuiDocument guiDocument)	Creates an instance for a GuiDocument.

Method Summary

Modifier and Type	Method	Description
<Element extends GuiElement<?, Element>, T extends GuiNavigatorScreenWithoutPayload<Element>> void	navigate(Class<T> navigationScreenClass)	Navigates to a registered GuiNavigatorScreenWithoutPayload.
<Element extends GuiElement<?, Element>, Payload, T extends GuiNavigationScreen<Element, Payload>> void	navigate(Class<T> navigationScreenClass, Payload payload)	Navigates to a registered GuiNavigationScreen passing it a payload.
void	register(GuiNavigationScreen<?,?> navigationScreen)	Registers a GuiNavigationScreen to be navigated to.

Methods inherited from class java.lang.Object

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

Constructor Details

GuiNavigator

public GuiNavigator(GuiDocument guiDocument)

Creates an instance for a GuiDocument.

Parameters:

guiDocument - the GuiDocument that will update when navigating

Method Details

register

public void register(GuiNavigationScreen<?,?> navigationScreen)

Registers a GuiNavigationScreen to be navigated to.

Parameters:

navigationScreen - the GuiNavigationScreen to register

navigate

public <Element extends GuiElement<?,
Element>,
T extends GuiNavigatorScreenWithoutPayload<Element>>
void navigate(Class<T> navigationScreenClass)

Navigates to a registered GuiNavigatorScreenWithoutPayload.

Type Parameters:

Element - the type of GuiElement the GuiNavigatorScreenWithoutPayload uses

T - the type of GuiNavigatorScreenWithoutPayload to navigate to

Parameters:

navigationScreenClass - the class of the GuiNavigatorScreenWithoutPayload to navigate to

navigate

public <Element extends GuiElement<?,
Element>,
Payload,
T extends GuiNavigationScreen<Element,
Payload>>
void navigate(Class<T> navigationScreenClass,
 Payload payload)

Navigates to a registered GuiNavigationScreen passing it a payload.

Type Parameters:

Element - the type of GuiElement the GuiNavigationScreen uses

Payload - the type of payload to pass to the GuiNavigationScreen

T - the type of GuiNavigationScreen to navigate to

Parameters:

navigationScreenClass - the class of the GuiNavigationScreen to navigate to

payload - the payload to pass to the GuiNavigationScreen