Class TContextMenu

java.lang.Object

com.thecsdev.common.scene.Node<TElement>

com.thecsdev.commonmc.api.client.gui.TElement

com.thecsdev.commonmc.api.client.gui.ctxmenu.TContextMenu

All Implemented Interfaces:

INode<TElement>, INodeBounded<TElement,Bounds2i>, INodeRenderable<TElement, TGuiGraphics>, Iterable<TElement>, Collection<TElement>

@Environment(CLIENT)
@Virtual
public class TContextMenu
extends TElement

A TContextMenu is a specialized TElement that represents a context menu GUI. It is designed to handle focus, input events, and screen management to ensure proper behavior when interacting with other GUI elements.

This element's parent must be either a TScreen or another TContextMenu. Attempting to add this element to any other type of parent will throw!

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TContextMenu.Builder	A builder for creating a simple TContextMenu instance.

Field Summary

Fields inherited from class TElement

eInitialized

Constructor Summary

Constructors

Constructor	Description
TContextMenu()

Method Summary

Modifier and Type	Method	Description
final boolean	inputCallback(@NotNull TInputContext.InputDiscoveryPhase phase, @NotNull TInputContext context)	A callback method that is invoked when the user makes an input.
final boolean	isFocusAncestor()	Returns true if TElement.isFocused() or if one this TElement's children or grandchildren TElement.isFocused().
final boolean	isHoverAncestor()	Returns true if TElement.isHovered() or if one this TElement's children or grandchildren TElement.isHovered().
void	renderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked when this Node is being rendered.
protected void	renderShadow(@NotNull TGuiGraphics pencil)	Renders a shadow effect for this context menu.
final NotNullProperty<TContextMenu>	rootContextMenuProperty()	The top-most TContextMenu in the hierarchy of this TElement.
final void	snapToParent()	Snaps this context menu to be fully visible within the bounds of its parent context menu or viewport.

Methods inherited from class TElement

addRel, boundsProperty, clearAndInit, clipsDescendantsProperty, contextMenuProperty, dragEndCallback, dragStartCallback, findElementAt, focusableProperty, focusGainedCallback, focusLostCallback, forEachVisible, getBaseType, getBounds, getClient, getContentBounds, getCursor, getSelf, getTooltip, hoverableProperty, hoverGainedCallback, hoverLostCallback, initCallback, invalidateTooltipCache, isFocusable, isFocused, isHoverable, isHovered, isHoveredOrFocused, isVisible, move, moveChildren, moveTo, postRenderCallback, removeRel, screenProperty, setBounds, setBounds, setBounds, showContextMenu, tickCallback, tooltipProperty, toString, visibleProperty

Methods inherited from class Node

add, addAll, childAddedCallback, childRemovedCallback, clear, contains, containsAll, equals, findChild, findParent, findSibling, forEach, get, getFirst, getLast, getParent, hashCode, indexOf, isEmpty, iterator, parentProperty, remove, remove, remove, removeAll, retainAll, rootProperty, size, toArray, toArray

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface Iterable

forEach

Constructor Details

TContextMenu

public TContextMenu()

Method Details

rootContextMenuProperty

public final NotNullProperty<TContextMenu> rootContextMenuProperty()

The top-most TContextMenu in the hierarchy of this TElement. If this element has no parent context menu, this property will reference this element itself.

API Note:

Owned by TContextMenu.PropertyAccessor.

inputCallback

public final boolean inputCallback(@NotNull TInputContext.InputDiscoveryPhase phase,
 @NotNull
 @NotNull TInputContext context)

Description copied from class: TElement

A callback method that is invoked when the user makes an input.

Overrides:

inputCallback in class TElement

Parameters:

phase - The input discovery phase.

context - Information about the user's input.

Returns:

true if this TElement handled the input.

renderShadow

@Virtual
protected void renderShadow(@NotNull
 @NotNull TGuiGraphics pencil)

Renders a shadow effect for this context menu.

Parameters:

pencil - The TGuiGraphics instance used for rendering.

renderCallback

@Virtual
public void renderCallback(@NotNull
 @NotNull TGuiGraphics pencil)

Description copied from interface: INodeRenderable

Callback method that is invoked when this Node is being rendered.

Specified by:

renderCallback in interface INodeRenderable<TElement, TGuiGraphics>

Overrides:

renderCallback in class TElement

Parameters:

pencil - The rendering context.

isFocusAncestor

public final boolean isFocusAncestor()

Returns true if TElement.isFocused() or if one this TElement's children or grandchildren TElement.isFocused().

isHoverAncestor

public final boolean isHoverAncestor()

Returns true if TElement.isHovered() or if one this TElement's children or grandchildren TElement.isHovered().

snapToParent

public final void snapToParent()

Snaps this context menu to be fully visible within the bounds of its parent context menu or viewport.

See Also:

• TGuiUtils.keepElementWithinBounds(TElement, Bounds2i)