Class TButtonWidget

java.lang.Object

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

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

com.thecsdev.commonmc.api.client.gui.widget.TClickableWidget

com.thecsdev.commonmc.api.client.gui.widget.TButtonWidget

All Implemented Interfaces:

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

Direct Known Subclasses:

TBlockStatsWidget, TButtonWidget.Flat, TButtonWidget.Paintable, TButtonWidget.Transparent, TDropdownWidget, TEntityStatsWidget, TItemStatsWidget, TSliderWidget, TTextualStatWidget, TToggleButtonWidget

@Environment(CLIENT)
@Virtual
public class TButtonWidget
extends TClickableWidget

A TClickableWidget implementation that looks and behaves like a regular button you'd see in-game's GUI.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TButtonWidget.Flat	TButtonWidget whose visual appearance is more flat and does not use the vanilla button texture.
static class	TButtonWidget.Paintable	TButtonWidget implementation that allows you to customize its background and outline colors.
static class	TButtonWidget.Transparent	TButtonWidget that does not have a visual appearance aside from its label and focus outline.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LBL_PAD_X	Default horizontal padding that is applied to the button's getLabel().
static final int	LBL_PAD_Y	Default vertical padding that is applied to the button's getLabel().

Fields inherited from class TClickableWidget

eClicked, ONCLICK_SOUND

Fields inherited from class TElement

eInitialized

Constructor Summary

Constructors

Constructor	Description
TButtonWidget()

Method Summary

Modifier and Type	Method	Description
final TLabelElement	getLabel()	Returns the TLabelElement used by this TButtonWidget.
protected void	initCallback()	Callback method that is invoked when this TElement is initializing.
void	renderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked when this Node is being rendered.

Methods inherited from class TClickableWidget

click, clickCallback, dragEndCallback, dragStartCallback, enabledProperty, focusLostCallback, getCursor, hoverGainedCallback, inputCallback, isFocusable, postRenderCallback, pressedProperty

Methods inherited from class TElement

addRel, boundsProperty, clearAndInit, clipsDescendantsProperty, contextMenuProperty, findElementAt, focusableProperty, focusGainedCallback, forEachVisible, getBaseType, getBounds, getClient, getContentBounds, getSelf, getTooltip, hoverableProperty, hoverLostCallback, invalidateTooltipCache, isFocused, isHoverable, isHovered, isHoveredOrFocused, isVisible, move, moveChildren, moveTo, 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

Field Details

LBL_PAD_X

public static final int LBL_PAD_X

Default horizontal padding that is applied to the button's getLabel().

See Also:

• Constant Field Values

LBL_PAD_Y

public static final int LBL_PAD_Y

Default vertical padding that is applied to the button's getLabel().

See Also:

• Constant Field Values

Constructor Details

TButtonWidget

public TButtonWidget()

Method Details

getLabel

public final TLabelElement getLabel()

Returns the TLabelElement used by this TButtonWidget. Use this to customize the button overlay text.

initCallback

@Virtual
protected void initCallback()

Description copied from class: TElement

Callback method that is invoked when this TElement is initializing. You may override this method to create and add child TElements.

Overrides:

initCallback in class TElement

See Also:

• TElement.clearAndInit()

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.