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

Class TMenuPanel

java.lang.Object

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

io.github.thecsdev.tcdcommons.api.client.gui.panel.TPanelElement

io.github.thecsdev.tcdcommons.api.client.gui.panel.menu.TMenuPanel

All Implemented Interfaces:

TParentElement, ITooltipProvider, IEnableStateProvider

Direct Known Subclasses:

TContextMenuPanel, TMenuBarPanel

public abstract class TMenuPanel
extends TPanelElement

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TMenuPanel.TMenuPanelEvent_ReAlignChildren

Nested classes/interfaces inherited from class io.github.thecsdev.tcdcommons.api.client.gui.panel.TPanelElement

TPanelElement.TPanelElementEvent_Scrolled

Nested classes/interfaces inherited from class io.github.thecsdev.tcdcommons.api.client.gui.TElement

TElement.TElementEvent_ChildAR, TElement.TElementEvent_ContextMenu, TElement.TElementEvent_Moved, TElement.TElementEvent_ParentChanged, TElement.TElementEvent_Resized

Field Summary

Fields

Modifier and Type	Field	Description
protected final TElement.TElementEvent_ChildAR	ehChildAR
final TEvent<TMenuPanel.TMenuPanelEvent_ReAlignChildren>	eRealignChildren

Fields inherited from class io.github.thecsdev.tcdcommons.api.client.gui.panel.TPanelElement

backgroundColor, COLOR_BACKGROUND, COLOR_OUTLINE, COLOR_OUTLINE_FOCUSED, eScrolledHorizontally, eScrolledVertically, outlineColor, SCROLL_BOTH, SCROLL_HORIZONTAL, SCROLL_VERTICAL, scrollDragX, scrollDragY, scrollFlags, scrollPadding, scrollSensitivity, scrollVelocityX, scrollVelocityY, smoothScroll, smoothScrollSpeed, topmosts

Fields inherited from class io.github.thecsdev.tcdcommons.api.client.gui.TElement

alpha, eChildAdded, eChildRemoved, eContextMenu, eMoved, eParentChanged, eResized, height, SP_ALL, SP_INVOKE_EVENT, SP_MOVE_CHILDREN, SP_RELATIVE, SP_UPDATE_TOPMOST, SS_ALL, SS_INVOKE_EVENT, SS_UPDATE_TOPMOST, tooltip, tooltipPositioner, width, x, y, zOffset

Fields inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.TParentElement

MAX_CHILD_NESTING_DEPTH

Constructor Summary

Constructors

Constructor	Description
TMenuPanel(int x, int y, int width, int height)

Method Summary

Modifier and Type	Method	Description
TMenuPanelButton	addButton(net.minecraft.text.Text text, Consumer<TButtonWidget> onClick)	Creates and adds a new TMenuPanelButton with the given text and on-click action.
TMenuPanelSeparator	addSeparator()	Creates and adds a new TMenuPanelSeparator.
abstract void	onRealignChildren()	Called in realignChildren(). Place the child re-aligning logic here.
final void	realignChildren()	Re-aligns the child elements of this TMenuPanel in accordance with its preferred layout.
final void	setScrollFlags(int flags)	Defines the scroll behavior for this TPanelElement. See TPanelElement.scrollFlags.
final void	setScrollPadding(int scrollPadding)

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.panel.TPanelElement

__getHorizontalSeCnvElm, __getVerticalSeCnvElm, applyScrollDrag, getBackgroundColor, getHorizontalScrollAmount, getHorizontalScrollKnobSize01, getOutlineColor, getScrollFlags, getScrollPadding, getScrollSensitivity, getSmoothScroll, getVerticalScrollAmount, getVerticalScrollKnobSize01, hasScrollFlag, input, input, inputHorizontalScroll, inputScroll, inputScroll, inputSmoothScroll, inputSmoothScroll, inputVerticalScroll, isScrollable, postRender, render, renderSmoothScroll, scrollToChild, setBackgroundColor, setHorizontalScrollAmount, setOutlineColor, setScrollSensitivity, setSmoothScroll, setVerticalScrollAmount

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.TElement

canBeAddedTo, createContextMenu, getAlpha, getChildren, getEnabled, getHeight, getItemRenderer, getParent, getParentTElement, getParentTScreen, getTextRenderer, getTooltip, getTooltipPositioner, getWidth, getX, getY, getZIndex, getZOffset, isDragging, isEnabled, isEnabledAndVisible, isFocusable, isFocused, isFocusedOrHovered, isHoverable, isHovered, isVisible, move, moveChildren, next, previous, setAlpha, setPosition, setPosition, setSize, setSize, setTooltip, setZOffset, tick, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.TParentElement

addChild, addChild, clearChildren, findChild, findLastChild, findParent, findParentTElement, forEachChild, getEndX, getEndY, removeChild, removeChild

Field Details

ehChildAR

protected final TElement.TElementEvent_ChildAR ehChildAR

eRealignChildren

public final TEvent<TMenuPanel.TMenuPanelEvent_ReAlignChildren> eRealignChildren

Constructor Details

TMenuPanel

public TMenuPanel(int x,
 int y,
 int width,
 int height)

Method Details

setScrollFlags

public final void setScrollFlags(int flags)
                          throws UnsupportedOperationException

Description copied from class: TPanelElement

Defines the scroll behavior for this TPanelElement.
See TPanelElement.scrollFlags.

Overrides:

setScrollFlags in class TPanelElement

Parameters:

flags - The scroll settings.

Throws:

UnsupportedOperationException

setScrollPadding

public final void setScrollPadding(int scrollPadding)
                            throws UnsupportedOperationException

Overrides:

setScrollPadding in class TPanelElement

Throws:

UnsupportedOperationException

realignChildren

public final void realignChildren()

Re-aligns the child elements of this TMenuPanel in accordance with its preferred layout.

It ensures the event handlers are properly registered, performs the realignment by invoking the abstract onRealignChildren() method, and finally invokes the event to signal the realignment.

See Also:

• onRealignChildren()
• eRealignChildren

onRealignChildren

public abstract void onRealignChildren()

Called in realignChildren().
Place the child re-aligning logic here.

addButton

public TMenuPanelButton addButton(net.minecraft.text.Text text,
 Consumer<TButtonWidget> onClick)

Creates and adds a new TMenuPanelButton with the given text and on-click action.

Parameters:

text - The menu item Text.

onClick - The on-click action for the menu item.

Returns:

The created and added TMenuPanelButton.

addSeparator

public TMenuPanelSeparator addSeparator()

Creates and adds a new TMenuPanelSeparator.