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

Class TClickableWidget

java.lang.Object

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

io.github.thecsdev.tcdcommons.api.client.gui.widget.TClickableWidget

All Implemented Interfaces:

TParentElement, ITooltipProvider, IEnableStateProvider, IEnableStateProviderSetter

Direct Known Subclasses:

TButtonWidget, TTextFieldWidget

public abstract class TClickableWidget
extends TElement
implements IEnableStateProviderSetter

An abstract class representing a clickable widget that extends TElement.

A TClickableWidget can be interacted with either by clicking it with the mouse or by pressing the enter key when it is focused. This class provides methods to handle the click action and to process input events.

Subclasses of TClickableWidget need to implement the onClick() method to define the behavior when the widget is clicked.

See Also:

• TElement

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TClickableWidget.TClickableWidgetEvent_Clicked

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
static final int	BUTTON_TEXTURE_SLICE_SIZE
static final net.minecraft.client.gui.screen.ButtonTextures	BUTTON_TEXTURES	Vanilla-game button textures.
TEvent<TClickableWidget.TClickableWidgetEvent_Clicked>	eClicked
protected boolean	enabled
static final net.minecraft.util.Identifier	T_WIDGETS_TEXTURE	TCDCommons's widget textures image.

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
TClickableWidget(int x, int y, int width, int height)

Method Summary

Modifier and Type	Method	Description
final void	click(boolean playClickSound)	Clicks this TClickableWidget.
final boolean	getEnabled()	Returns true if this Object is enabled.
boolean	input(TInputContext inputContext)	An input handler that handles inputs on the TInputContext.InputDiscoveryPhase.MAIN input phase.
boolean	isFocusable()
protected abstract void	onClick()	Called when this TClickableWidget is clicked, either by a mouse or a keyboard input, or by click(boolean).
void	setEnabled(boolean enabled)	Sets the "enabled" state for this Object.

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

canBeAddedTo, createContextMenu, getAlpha, getChildren, getHeight, getItemRenderer, getParent, getParentTElement, getParentTScreen, getTextRenderer, getTooltip, getTooltipPositioner, getWidth, getX, getY, getZIndex, getZOffset, isDragging, isEnabled, isEnabledAndVisible, isFocused, isFocusedOrHovered, isHoverable, isHovered, isVisible, move, moveChildren, next, postRender, previous, render, 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, input, removeChild, removeChild

Field Details

BUTTON_TEXTURE_SLICE_SIZE

public static final int BUTTON_TEXTURE_SLICE_SIZE

See Also:

• Constant Field Values

BUTTON_TEXTURES

public static final net.minecraft.client.gui.screen.ButtonTextures BUTTON_TEXTURES

Vanilla-game button textures.

T_WIDGETS_TEXTURE

public static final net.minecraft.util.Identifier T_WIDGETS_TEXTURE

TCDCommons's widget textures image.

enabled

protected boolean enabled

eClicked

public TEvent<TClickableWidget.TClickableWidgetEvent_Clicked> eClicked

Constructor Details

TClickableWidget

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

Method Details

isFocusable

public boolean isFocusable()

Overrides:

isFocusable in class TElement

getEnabled

public final boolean getEnabled()

Description copied from interface: IEnableStateProvider

Returns true if this Object is enabled.

Specified by:

getEnabled in interface IEnableStateProvider

Specified by:

getEnabled in interface TParentElement

Overrides:

getEnabled in class TElement

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: IEnableStateProviderSetter

Sets the "enabled" state for this Object.

Specified by:

setEnabled in interface IEnableStateProviderSetter

Parameters:

enabled - Whether or not this Object will be enabled.

click

public final void click(boolean playClickSound)

Clicks this TClickableWidget.

Parameters:

playClickSound - Whether or not to play the GUI button click sound.

onClick

protected abstract void onClick()

Called when this TClickableWidget is clicked, either by a mouse or a keyboard input, or by click(boolean).

input

public boolean input(TInputContext inputContext)

Description copied from interface: TParentElement

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

Specified by:

input in interface TParentElement

Overrides:

input in class TElement

Parameters:

inputContext - The TInputContext containing information about a given input.

See Also:

• TParentElement.input(TInputContext, TInputContext.InputDiscoveryPhase)