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

Class TButtonWidget

java.lang.Object

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

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

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

All Implemented Interfaces:

TParentElement, ITooltipProvider, IEnableStateProvider, IEnableStateProviderSetter, ITextProvider, ITextProviderSetter

Direct Known Subclasses:

FileListItem, TCheckboxWidget, TitleBar.TitleBarSquareButton, TMenuPanelButton, TSelectWidget, TSliderWidget

public class TButtonWidget
extends TClickableWidget
implements ITextProviderSetter

A TButtonWidget is a TClickableWidget that looks and behaves like a vanilla button.

Nested Class Summary

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

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
protected @Nullable UITexture	icon
protected final float[]	iconColor
protected @Nullable Consumer<TButtonWidget>	onClick
protected @Nullable net.minecraft.text.Text	text

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

BUTTON_TEXTURE_SLICE_SIZE, BUTTON_TEXTURES, eClicked, enabled, T_WIDGETS_TEXTURE

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
TButtonWidget(int x, int y, int width, int height)
TButtonWidget(int x, int y, int width, int height, net.minecraft.text.Text text)
TButtonWidget(int x, int y, int width, int height, net.minecraft.text.Text text, Consumer<TButtonWidget> onClick)

Method Summary

Modifier and Type	Method	Description
final @Nullable UITexture	getIcon()
final float[]	getIconColor()
final @Nullable Consumer<TButtonWidget>	getOnClick()
final @Nullable net.minecraft.text.Text	getText()
protected void	onClick()	Called when this TClickableWidget is clicked, either by a mouse or a keyboard input, or by TClickableWidget.click(boolean).
void	render(TDrawContext pencil)	Renders this GUI element on the screen.
protected void	renderBackground(TDrawContext pencil)	By default, renders the "background" texture and icon for this TButtonWidget.
protected void	renderIcon(TDrawContext pencil)	By default, renders the "background" icon for this TButtonWidget.
void	setIcon(@Nullable UITexture icon)
final void	setIconColor(float r, float g, float b)
void	setIconColor(float r, float g, float b, float a)
void	setOnClick(@Nullable Consumer<TButtonWidget> onClick)
void	setText(@Nullable net.minecraft.text.Text text)

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

click, getEnabled, input, isFocusable, setEnabled

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

text

@Nullable
protected @Nullable net.minecraft.text.Text text

onClick

@Nullable
protected @Nullable Consumer<TButtonWidget> onClick

icon

@Nullable
protected @Nullable UITexture icon

iconColor

protected final float[] iconColor

Constructor Details

TButtonWidget

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

TButtonWidget

public TButtonWidget(int x,
 int y,
 int width,
 int height,
 net.minecraft.text.Text text)

TButtonWidget

public TButtonWidget(int x,
 int y,
 int width,
 int height,
 net.minecraft.text.Text text,
 Consumer<TButtonWidget> onClick)

Method Details

getText

@Nullable
public final @Nullable net.minecraft.text.Text getText()

Specified by:

getText in interface ITextProvider

setText

public void setText(@Nullable
 @Nullable net.minecraft.text.Text text)

Specified by:

setText in interface ITextProviderSetter

getOnClick

@Nullable
public final @Nullable Consumer<TButtonWidget> getOnClick()

setOnClick

public void setOnClick(@Nullable
 @Nullable Consumer<TButtonWidget> onClick)

getIcon

@Nullable
public final @Nullable UITexture getIcon()

setIcon

public void setIcon(@Nullable
 @Nullable UITexture icon)

getIconColor

public final float[] getIconColor()

setIconColor

public final void setIconColor(float r,
 float g,
 float b)

setIconColor

public void setIconColor(float r,
 float g,
 float b,
 float a)

onClick

protected void onClick()

Description copied from class: TClickableWidget

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

Specified by:

onClick in class TClickableWidget

render

public void render(TDrawContext pencil)

Description copied from interface: TParentElement

Renders this GUI element on the screen.

Specified by:

render in interface TParentElement

Specified by:

render in class TElement

Parameters:

pencil - The TDrawContext.

renderBackground

protected void renderBackground(TDrawContext pencil)

By default, renders the "background" texture and icon for this TButtonWidget.

Parameters:

pencil - The TDrawContext.

renderIcon

protected void renderIcon(TDrawContext pencil)

By default, renders the "background" icon for this TButtonWidget.

Parameters:

pencil - The TDrawContext.