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

Class TSelectWidget<T extends TSelectWidget.Entry>

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

All Implemented Interfaces:

TParentElement, ITooltipProvider, IEnableStateProvider, IEnableStateProviderSetter, ITextProvider, ITextProviderSetter, Iterable<T>

Direct Known Subclasses:

TSelectEnumWidget, TSelectFileFilterWidget

public class TSelectWidget<T extends TSelectWidget.Entry>
extends TButtonWidget
implements Iterable<T>

A TButtonWidget that features a dropdown item selection menu.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TSelectWidget.Entry	Represents a TSelectWidget dropdown menu entry.
static final class	TSelectWidget.SimpleEntry	A simple TSelectWidget.Entry implementation featuring getters and setters.
static interface	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 @Nullable TContextMenuPanel	contextMenu
static final net.minecraft.text.Text	DEFAULT_LABEL
protected final TElement.TElementEvent_ContextMenu	ehContextMenu
protected final IdealList<T>	entries	This is where the TSelectWidget keeps track of all selectable TSelectWidget.Entrys added to this element.
protected final Class<T>	entryType
final TEvent<TSelectWidget.TSelectWidgetEvent_SelectionChanged<T>>	eSelectionChanged
protected T	selected
static final UITexture	TEX_CLOSED
static final UITexture	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
TSelectWidget(int x, int y, int width, int height, net.minecraft.text.Text text, T... entryTypeClassGetter)
TSelectWidget(int x, int y, int width, int height, T... entryTypeClassGetter)

Method Summary

Modifier and Type	Method	Description
final boolean	addEntry(T entry)	Adds an TSelectWidget.Entry to this TSelectWidget. Can not be null.
TContextMenuPanel	createContextMenu()	A utility method that creates and returns a new TContextMenuPanel instance for this TElement.
final Class<T>	getEntryType()	Returns the Class object representing the generic type T that extends TSelectWidget.Entry.
final T	getSelected()	Returns the TSelectWidget.Entry that is currently selected, or null if no TSelectWidget.Entry is selected at the moment.
final Iterator<T>	iterator()
protected void	onClick()	Called when this TClickableWidget is clicked, either by a mouse or a keyboard input, or by TClickableWidget.click(boolean).
protected void	onSelectionChanged()
final boolean	removeEntry(T entry)	Removes an TSelectWidget.Entry from this TSelectWidget.
void	render(TDrawContext pencil)	Renders this GUI element on the screen.
final void	setSelected(T selected)	Sets an TSelectWidget.Entry as the "selected" TSelectWidget.Entry.
final void	setSelected(T selected, boolean invokeEvent)	Sets an TSelectWidget.Entry as the "selected" TSelectWidget.Entry.
void	tick()	Used for periodic updates for this TElement.

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

DEFAULT_LABEL

public static final net.minecraft.text.Text DEFAULT_LABEL

TEX_OPENED

public static final UITexture TEX_OPENED

TEX_CLOSED

public static final UITexture TEX_CLOSED

entryType

protected final Class<T extends TSelectWidget.Entry> entryType

entries

protected final IdealList<T extends TSelectWidget.Entry> entries

This is where the TSelectWidget keeps track of all selectable TSelectWidget.Entrys added to this element.

selected

@Nullable
protected T extends TSelectWidget.Entry selected

contextMenu

@Nullable
protected @Nullable TContextMenuPanel contextMenu

ehContextMenu

protected final TElement.TElementEvent_ContextMenu ehContextMenu

eSelectionChanged

public final TEvent<TSelectWidget.TSelectWidgetEvent_SelectionChanged<T extends TSelectWidget.Entry>> eSelectionChanged

Constructor Details

TSelectWidget

@SafeVarargs
public TSelectWidget(int x,
 int y,
 int width,
 int height,
 T... entryTypeClassGetter)

TSelectWidget

@SafeVarargs
public TSelectWidget(int x,
 int y,
 int width,
 int height,
 net.minecraft.text.Text text,
 T... entryTypeClassGetter)

Method Details

tick

public void tick()

Description copied from class: TElement

Used for periodic updates for this TElement.

Overrides:

tick in class TElement

getEntryType

public final Class<T> getEntryType()

Returns the Class object representing the generic type T that extends TSelectWidget.Entry.

iterator

public final Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends TSelectWidget.Entry>

render

public void render(TDrawContext pencil)

Description copied from interface: TParentElement

Renders this GUI element on the screen.

Specified by:

render in interface TParentElement

Overrides:

render in class TButtonWidget

Parameters:

pencil - The TDrawContext.

onClick

protected void onClick()

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

For TSelectWidget, it also creates the context menu using createContextMenu(), and then the context menu is opened.

Overrides:

onClick in class TButtonWidget

createContextMenu

public TContextMenuPanel createContextMenu()

A utility method that creates and returns a new TContextMenuPanel instance for this TElement. Use this to create your own custom context menus for this TElement.

For TSelectWidget, a TContextMenuPanel must always be created, and this method must never return null.

Overrides:

createContextMenu in class TElement

Returns:

A TContextMenuPanel for this TElement, or null if this TElement does not support context menus.

addEntry

public final boolean addEntry(T entry)

Adds an TSelectWidget.Entry to this TSelectWidget.
Can not be null.

Parameters:

entry - The TSelectWidget.Entry to add.

See Also:

• TSelectWidget.Entry
• TSelectWidget.SimpleEntry

removeEntry

public final boolean removeEntry(T entry)

Removes an TSelectWidget.Entry from this TSelectWidget.

Parameters:

entry - The TSelectWidget.Entry to remove.

getSelected

@Nullable
public final T getSelected()

Returns the TSelectWidget.Entry that is currently selected, or null if no TSelectWidget.Entry is selected at the moment.

setSelected

public final void setSelected(@Nullable
 T selected)
                       throws IllegalArgumentException

Sets an TSelectWidget.Entry as the "selected" TSelectWidget.Entry.

Parameters:

selected - The TSelectWidget.Entry to set as "selected".

Throws:

IllegalArgumentException - If This TSelectWidget does not contain the TSelectWidget.Entry.

See Also:

• getSelected()

setSelected

public final void setSelected(@Nullable
 T selected,
 boolean invokeEvent)
                       throws IllegalArgumentException

Sets an TSelectWidget.Entry as the "selected" TSelectWidget.Entry.

Parameters:

selected - The TSelectWidget.Entry to set as "selected".

invokeEvent - Whether or not eSelectionChanged should be invoked.

Throws:

IllegalArgumentException - If This TSelectWidget does not contain the TSelectWidget.Entry.

See Also:

• getSelected()

onSelectionChanged

protected void onSelectionChanged()