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

Class TSelectEnumWidget<E extends Enum<E>>

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

io.github.thecsdev.tcdcommons.api.client.gui.widget.TSelectWidget<TSelectEnumWidget.EnumEntry<E>>

io.github.thecsdev.tcdcommons.api.client.gui.widget.TSelectEnumWidget<E>

All Implemented Interfaces:

TParentElement, ITooltipProvider, IEnableStateProvider, IEnableStateProviderSetter, ITextProvider, ITextProviderSetter, Iterable<TSelectEnumWidget.EnumEntry<E>>

public class TSelectEnumWidget<E extends Enum<E>>
extends TSelectWidget<TSelectEnumWidget.EnumEntry<E>>

A TSelectWidget where the user selects Enum values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TSelectEnumWidget.EnumEntry<E extends Enum<E>>	An Enum-based implementation of TSelectWidget.Entry.

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

TSelectWidget.Entry, TSelectWidget.SimpleEntry, TSelectWidget.TSelectWidgetEvent_SelectionChanged<T extends TSelectWidget.Entry>

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 final Class<E>	enumType

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

contextMenu, DEFAULT_LABEL, ehContextMenu, entries, entryType, eSelectionChanged, selected, TEX_CLOSED, TEX_OPENED

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

icon, iconColor, onClick, 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
TSelectEnumWidget(int x, int y, int width, int height, E enumValue)
TSelectEnumWidget(int x, int y, int width, int height, Class<E> enumType)
TSelectEnumWidget(int x, int y, int width, int height, Class<E> enumType, net.minecraft.text.Text text)

Method Summary

Modifier and Type	Method	Description
final @Nullable TSelectEnumWidget.EnumEntry<E>	entryOf(E enumValue)	Returns an TSelectEnumWidget.EnumEntry that is associated with a given Enum value.
final Class<E>	getEnumType()	Returns the Class object representing the generic type E that extends Enum.
final void	setSelected(E enumValue)	Sets the selected TSelectEnumWidget.EnumEntry using its Enum value.

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

addEntry, createContextMenu, getEntryType, getSelected, iterator, onClick, onSelectionChanged, removeEntry, render, setSelected, setSelected, tick

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

getIcon, getIconColor, getOnClick, getText, renderBackground, renderIcon, setIcon, setIconColor, setIconColor, setOnClick, setText

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

enumType

protected final Class<E extends Enum<E>> enumType

Constructor Details

TSelectEnumWidget

public TSelectEnumWidget(int x,
 int y,
 int width,
 int height,
 E enumValue)

TSelectEnumWidget

public TSelectEnumWidget(int x,
 int y,
 int width,
 int height,
 Class<E> enumType)

TSelectEnumWidget

public TSelectEnumWidget(int x,
 int y,
 int width,
 int height,
 Class<E> enumType,
 net.minecraft.text.Text text)

Method Details

getEnumType

public final Class<E> getEnumType()

Returns the Class object representing the generic type E that extends Enum.

entryOf

@Nullable
public final @Nullable TSelectEnumWidget.EnumEntry<E> entryOf(E enumValue)

Returns an TSelectEnumWidget.EnumEntry that is associated with a given Enum value. Will return null if no such TSelectEnumWidget.EnumEntry exists or if it was removed.

Parameters:

enumValue - The Enum value to look for in the TSelectEnumWidget.EnumEntrys.

See Also:

• TSelectEnumWidget.EnumEntry.getEnumValue()

setSelected

public final void setSelected(E enumValue)
                       throws NoSuchElementException

Sets the selected TSelectEnumWidget.EnumEntry using its Enum value.

Throws:

NoSuchElementException - If this TSelectEnumWidget does not have an TSelectEnumWidget.EnumEntry that corresponds with the given Enum value.

See Also:

• entryOf(Enum)
• TSelectEnumWidget.EnumEntry.getEnumValue()