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

Class TContextMenuPanel

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

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

All Implemented Interfaces:

TParentElement, ITooltipProvider, IEnableStateProvider

public class TContextMenuPanel
extends TMenuPanel

Nested Class Summary

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

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
final TEvent<TElementEvent_Runnable<TContextMenuPanel>>	eClosed
protected final TElement.TElementEvent_ParentChanged	ehParentChanged
final TEvent<TElementEvent_Runnable<TContextMenuPanel>>	eOpened
protected final int	initHeight
protected final int	initWidh
protected final TElement	target

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

ehChildAR, 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
TContextMenuPanel(TElement target)	Creates a new TContextMenuPanel for a given TContextMenuPanel.

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.
final boolean	canBeAddedTo(TParentElement futureParent)	Returns true if this TElement is okay with being added to a given TParentElement.
final boolean	close()	Closes this TContextMenuPanel by removing it from the TElement.getParent() element.
final boolean	closeIfNotFocused()	Checks if this TContextMenuPanel or one of its children is focused or not.
static @Nullable TContextMenuPanel	findHoveredContextMenu(TScreen targetScreen)	Tries to find any hovered TContextMenuPanels for a given TScreen.
final TElement	getTarget()
boolean	input(TInputContext inputContext, TInputContext.InputDiscoveryPhase inputPhase)	An input handler that handles inputs on all possible TInputContext.InputDiscoveryPhases.
final boolean	isOpen()	Returns true if TElement.getParent() is not null.
final void	onRealignChildren()	Called in TMenuPanel.realignChildren(). Place the child re-aligning logic here.
final boolean	open()	Opens this TContextMenuPanel by adding it to the getTarget()'s parent TScreen.
protected void	realignPositionToTarget()	Automatically invoked by ehParentChanged. Aligns this TContextMenuPanel for the target element. Usually invoked when this TContextMenuPanel is shown on the screen.
static boolean	tryCloseAContextMenu(TScreen targetScreen)	Looks for a TContextMenuPanel in a target TScreen, and if one is found, it gets closed.

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

addSeparator, realignChildren, setScrollFlags, setScrollPadding

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

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

target

protected final TElement target

initWidh

protected final int initWidh

initHeight

protected final int initHeight

eOpened

public final TEvent<TElementEvent_Runnable<TContextMenuPanel>> eOpened

eClosed

public final TEvent<TElementEvent_Runnable<TContextMenuPanel>> eClosed

ehParentChanged

protected final TElement.TElementEvent_ParentChanged ehParentChanged

Constructor Details

TContextMenuPanel

public TContextMenuPanel(TElement target)

Creates a new TContextMenuPanel for a given TContextMenuPanel.

Parameters:

target - The TElement this TContextMenuPanel is for.

Method Details

getTarget

public final TElement getTarget()

canBeAddedTo

public final boolean canBeAddedTo(TParentElement futureParent)

Description copied from class: TElement

Returns true if this TElement is okay with being added to a given TParentElement.

Overrides:

canBeAddedTo in class TElement

Parameters:

futureParent - The TParentElement that is being checked.

addButton

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

Description copied from class: TMenuPanel

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

Overrides:

addButton in class TMenuPanel

Parameters:

text - The menu item Text.

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

Returns:

The created and added TMenuPanelButton.

input

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

Description copied from interface: TParentElement

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

Specified by:

input in interface TParentElement

Overrides:

input in class TPanelElement

Parameters:

inputContext - The TInputContext containing information about a given input.

inputPhase - The current TInputContext.InputDiscoveryPhase.

See Also:

• TInputContext.InputDiscoveryPhase

open

public final boolean open()

Opens this TContextMenuPanel by adding it to the getTarget()'s parent TScreen.

Returns:

this

close

public final boolean close()

Closes this TContextMenuPanel by removing it from the TElement.getParent() element.

isOpen

public final boolean isOpen()

Returns true if TElement.getParent() is not null.

closeIfNotFocused

public final boolean closeIfNotFocused()

Checks if this TContextMenuPanel or one of its children is focused or not. If not, then close() will be called.

realignPositionToTarget

protected void realignPositionToTarget()

Automatically invoked by ehParentChanged.
Aligns this TContextMenuPanel for the target element.
Usually invoked when this TContextMenuPanel is shown on the screen.

onRealignChildren

public final void onRealignChildren()

Description copied from class: TMenuPanel

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

Specified by:

onRealignChildren in class TMenuPanel

findHoveredContextMenu

@Nullable
public static @Nullable TContextMenuPanel findHoveredContextMenu(TScreen targetScreen)

Tries to find any hovered TContextMenuPanels for a given TScreen.

Parameters:

targetScreen - The target TScreen.

tryCloseAContextMenu

public static boolean tryCloseAContextMenu(TScreen targetScreen)

Looks for a TContextMenuPanel in a target TScreen, and if one is found, it gets closed.

Parameters:

targetScreen - The target TScreen.

Returns:

True if a TContextMenuPanel was found and closed.