Package io.github.thecsdev.tcdcommons.api.client.gui

Interface TParentElement

All Superinterfaces:

IEnableStateProvider

All Known Subinterfaces:

IMenuPanelItem

All Known Implementing Classes:

AbstractFileListPanel, ActionBar, ActionBar.FileNameInputField, FileListItem, FileListPanel, NavigationBar, SidebarPanel, TBlankElement, TButtonWidget, TCheckboxWidget, TClickableWidget, TContextMenuPanel, TElement, TEntityRendererElement, TestTScreen, TestTWidgetHudScreen, TFileChooserScreen, TFileExplorerPanel, TFillColorElement, TitleBar, TitleBar.TitleBarSquareButton, TLabelElement, TMenuBarPanel, TMenuPanel, TMenuPanelButton, TMenuPanelSeparator, TPanelElement, TRefreshablePanelElement, TScreen, TScreenPlus, TScrollBarWidget, TSelectEnumWidget, TSelectFileFilterWidget, TSelectWidget, TSliderWidget, TStackTraceScreen, TTextFieldWidget, TTextureElement, TWidgetHudScreen

public interface TParentElement
extends IEnableStateProvider

The TParentElement interface represents a GUI element in the TCDCommons framework. Implementations of this interface can act as parent elements for other GUI elements, providing a structural hierarchy for GUI representation and interaction.

Each TParentElement has an X and Y coordinate, as well as a width and height. These attributes define the element's position and size within the GUI layout.

Implementing classes should ensure these properties are correctly maintained to ensure accurate representation and interaction within the GUI.

See Also:

• TScreen
• TElement

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_CHILD_NESTING_DEPTH	The maximum depth of nested children that can be iterated over by the __findChild(TParentElement, Predicate, boolean, int) method.

Method Summary

Modifier and Type	Method	Description
default boolean	addChild(TElement child)
default boolean	addChild(TElement child, boolean reposition)
default void	clearChildren()
default @Nullable TElement	findChild(Predicate<TElement> predicate, boolean nested)	Iterates over every child in getChildren(), and applies a Predicate to it.
default @Nullable TElement	findLastChild(Predicate<TElement> predicate, boolean nested)	Similar to findChild(Predicate, boolean), but it returns the last instance that matches a given predicate.
default @Nullable TParentElement	findParent(Predicate<TParentElement> predicate)	Finds and returns the first TParentElement for which the provided action returns true.
default @Nullable TElement	findParentTElement(Predicate<TElement> predicate)	Finds and returns the first parent TElement for which the provided action returns true.
default void	forEachChild(Consumer<TElement> action, boolean nested)	Iterates over every child in getChildren(), and applies a Consumer to it.
TElementList	getChildren()
default boolean	getEnabled()	Returns true if this Object is enabled.
default int	getEndX()
default int	getEndY()
int	getHeight()
@Nullable TParentElement	getParent()
int	getWidth()
int	getX()
int	getY()
default float	getZIndex()	Returns the Z-index for this TParentElement. Should be between 0 (inclusive) and 100 (also inclusive), as any other values may cause this element to not render properly or to not render at all.
default boolean	input(TInputContext inputContext)	An input handler that handles inputs on the TInputContext.InputDiscoveryPhase.MAIN input phase.
default boolean	input(TInputContext inputContext, TInputContext.InputDiscoveryPhase inputPhase)	An input handler that handles inputs on all possible TInputContext.InputDiscoveryPhases.
default boolean	isEnabled()	Returns true if getEnabled() returns true, and getParent()'s isEnabled() also returns true.
default boolean	removeChild(TElement child)
default boolean	removeChild(TElement child, boolean reposition)
void	render(TDrawContext pencil)	Renders this GUI element on the screen.

Field Details

MAX_CHILD_NESTING_DEPTH

static final int MAX_CHILD_NESTING_DEPTH

The maximum depth of nested children that can be iterated over by the __findChild(TParentElement, Predicate, boolean, int) method.

This limit is enforced to prevent several potential issues:

• Stack overflow due to excessive recursion
• Performance degradation from handling an excessive number of nested children
• Infinite recursion resulting from a child element containing itself as one of its children

If the iteration depth exceeds this limit, the __findChild(TParentElement, Predicate, boolean, int) method will return null.

See Also:

• Constant Field Values

Method Details

getX

int getX()

getY

int getY()

getWidth

int getWidth()

getHeight

int getHeight()

getEndX

default int getEndX()

getEndY

default int getEndY()

render

void render(TDrawContext pencil)

Renders this GUI element on the screen.

Parameters:

pencil - The TDrawContext.

getZIndex

default float getZIndex()

Returns the Z-index for this TParentElement.
Should be between 0 (inclusive) and 100 (also inclusive), as any other values may cause this element to not render properly or to not render at all.

input

default boolean input(TInputContext inputContext)

An input handler that handles inputs on the TInputContext.InputDiscoveryPhase.MAIN input phase.

Parameters:

inputContext - The TInputContext containing information about a given input.

See Also:

• input(TInputContext, TInputContext.InputDiscoveryPhase)

input

default boolean input(TInputContext inputContext,
 TInputContext.InputDiscoveryPhase inputPhase)

An input handler that handles inputs on all possible TInputContext.InputDiscoveryPhases.

Parameters:

inputContext - The TInputContext containing information about a given input.

inputPhase - The current TInputContext.InputDiscoveryPhase.

See Also:

• TInputContext.InputDiscoveryPhase

getParent

@Nullable
@Nullable TParentElement getParent()

getChildren

TElementList getChildren()

addChild

default boolean addChild(TElement child)

addChild

default boolean addChild(TElement child,
 boolean reposition)

removeChild

default boolean removeChild(TElement child)

removeChild

default boolean removeChild(TElement child,
 boolean reposition)

clearChildren

default void clearChildren()

isEnabled

default boolean isEnabled()

Returns true if getEnabled() returns true, and getParent()'s isEnabled() also returns true.

In other words, this will return true if both this element and all of its TParentElements are enabled.

getEnabled

default boolean getEnabled()

Description copied from interface: IEnableStateProvider

Returns true if this Object is enabled.

Specified by:

getEnabled in interface IEnableStateProvider

findParent

@Nullable
default @Nullable TParentElement findParent(Predicate<TParentElement> predicate)

Finds and returns the first TParentElement for which the provided action returns true.

Parameters:

predicate - A predicate that takes a TParentElement and returns a Boolean. This predicate is applied to each parent element in the hierarchy until it returns true or no more parent elements are found.

Returns:

The first TParentElement for which the action returns true, or null if no such element is found.

findParentTElement

@Nullable
default @Nullable TElement findParentTElement(Predicate<TElement> predicate)

Finds and returns the first parent TElement for which the provided action returns true.

Parameters:

predicate - A predicate that takes a TElement and returns a Boolean. This predicate is applied to each parent element in the hierarchy that is an instance of TElement until it returns true or no more parent elements are found.

Returns:

The first parent TElement for which the action returns true, or null if no such element is found.

forEachChild

default void forEachChild(Consumer<TElement> action,
 boolean nested)

Iterates over every child in getChildren(), and applies a Consumer to it.

This is similar to findChild(Predicate, boolean), except the Consumer does not return 'true' or 'false', and therefore there's no way to end the loop here.

Parameters:

action - The Consumer to apply for each child element.

nested - Will this Consumer be applied to the children of children?

findChild

@Nullable
default @Nullable TElement findChild(Predicate<TElement> predicate,
 boolean nested)

Iterates over every child in getChildren(), and applies a Predicate to it.

When the Predicate returns true for child TElement, the "for-each" operation will terminate, and the child TElement will be returned.

Parameters:

predicate - The Predicate to apply for each child element.

nested - Will this Predicate be applied to the children of children?

Returns:

The first TElement for which the Predicate returns true.

findLastChild

@Nullable
default @Nullable TElement findLastChild(Predicate<TElement> predicate,
 boolean nested)

Similar to findChild(Predicate, boolean), but it returns the last instance that matches a given predicate.

Parameters:

predicate - The Predicate to apply for each child element.

nested - Will this Predicate be applied to the children of children?