Package net.uku3lig.ukulib.config.option.widget

Class WidgetCreatorList

java.lang.Object

net.minecraft.client.gui.components.AbstractWidget

net.minecraft.client.gui.components.AbstractScrollArea

net.minecraft.client.gui.components.AbstractContainerWidget

net.minecraft.client.gui.components.AbstractSelectionList<WidgetCreatorList.ButtonEntry>

net.minecraft.client.gui.components.ContainerObjectSelectionList<@NotNull WidgetCreatorList.ButtonEntry>

net.uku3lig.ukulib.config.option.widget.WidgetCreatorList

All Implemented Interfaces:

net.minecraft.client.gui.components.events.ContainerEventHandler, net.minecraft.client.gui.components.events.GuiEventListener, net.minecraft.client.gui.components.Renderable, net.minecraft.client.gui.components.TabOrderedElement, net.minecraft.client.gui.layouts.LayoutElement, net.minecraft.client.gui.narration.NarratableEntry, net.minecraft.client.gui.narration.NarrationSupplier

public class WidgetCreatorList
extends net.minecraft.client.gui.components.ContainerObjectSelectionList<@NotNull WidgetCreatorList.ButtonEntry>

A list of WidgetCreator, used to construct a vertical list of widgets

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WidgetCreatorList.ButtonEntry	A widget entry, made of one or two creators.

Nested classes/interfaces inherited from class net.minecraft.client.gui.components.ContainerObjectSelectionList

net.minecraft.client.gui.components.ContainerObjectSelectionList.Entry<E extends net.minecraft.client.gui.components.ContainerObjectSelectionList.Entry<E>>

Nested classes/interfaces inherited from class net.minecraft.client.gui.components.AbstractWidget

net.minecraft.client.gui.components.AbstractWidget.WithInactiveMessage

Nested classes/interfaces inherited from interface net.minecraft.client.gui.narration.NarratableEntry

net.minecraft.client.gui.narration.NarratableEntry.NarrationPriority

Field Summary

Fields inherited from class net.minecraft.client.gui.components.AbstractSelectionList

centerListVertically, defaultEntryHeight, minecraft

Fields inherited from class net.minecraft.client.gui.components.AbstractScrollArea

SCROLLBAR_WIDTH

Fields inherited from class net.minecraft.client.gui.components.AbstractWidget

active, alpha, height, isHovered, message, visible, width

Constructor Summary

Constructors

Constructor	Description
WidgetCreatorList(net.minecraft.client.Minecraft minecraftClient, int width, int height, int top, int itemHeight)	Deprecated, for removal: This API element is subject to removal in a future version. You should be wrapping the widget in the body of a HeaderAndFooterLayout
WidgetCreatorList(net.minecraft.client.Minecraft minecraftClient, int width, int height, int top, int bottom, int itemHeight)	Deprecated, for removal: This API element is subject to removal in a future version. Mojang (rightfully) removed the bottom in 1.20.3, use WidgetCreatorList(Minecraft, int, int, int, int) instead
WidgetCreatorList(net.minecraft.client.Minecraft minecraftClient, int width, net.minecraft.client.gui.layouts.HeaderAndFooterLayout layout)	Creates an empty widget list

Method Summary

Modifier and Type	Method	Description
void	addAll(WidgetCreator[] options)	Add an array of widget creators.
void	addEntries(WidgetCreator first, @Nullable WidgetCreator other)	Add two entries.
void	addWideEntry(WidgetCreator creator)	Add a single, wide entry.
int	getRowWidth()

Methods inherited from class net.minecraft.client.gui.components.ContainerObjectSelectionList

entriesCanBeSelected, narrationPriority, nextFocusPath, setFocused, updateWidgetNarration

Methods inherited from class net.minecraft.client.gui.components.AbstractSelectionList

addEntry, addEntry, addEntryToTop, addEntryToTop, centerScrollOn, children, clearEntries, clearEntriesExcept, contentHeight, enableScissor, getChildAt, getEntryAtPosition, getFocused, getHovered, getItemCount, getNextY, getRowBottom, getRowLeft, getRowRight, getRowTop, getSelected, narrateListElementPosition, nextEntry, nextEntry, nextEntry, removeEntries, removeEntry, removeEntryFromTop, renderItem, renderListBackground, renderListItems, renderListSeparators, renderSelection, renderWidget, replaceEntries, scrollBarX, scrollRate, scrollToEntry, setFocused, setScrollAmount, setSelected, sort, swap, updateSize, updateSizeAndPosition, updateSizeAndPosition

Methods inherited from class net.minecraft.client.gui.components.AbstractContainerWidget

isDragging, isFocused, mouseClicked, mouseDragged, mouseReleased, setDragging

Methods inherited from class net.minecraft.client.gui.components.AbstractScrollArea

isOverScrollbar, maxScrollAmount, mouseScrolled, onRelease, refreshScrollAmount, renderScrollbar, scrollAmount, scrollbarVisible, scrollBarY, scrollerHeight, updateScrolling

Methods inherited from class net.minecraft.client.gui.components.AbstractWidget

createNarrationMessage, defaultButtonNarrationText, getAlpha, getBottom, getHeight, getMessage, getRectangle, getRight, getTabOrderGroup, getWidth, getX, getY, handleCursor, isActive, isHovered, isHoveredOrFocused, isMouseOver, isValidClickButton, onClick, onDrag, playButtonClickSound, playDownSound, render, renderScrollingStringOverContents, setAlpha, setHeight, setMessage, setRectangle, setSize, setTabOrderGroup, setTooltip, setTooltipDelay, setWidth, setX, setY, updateNarration, visitWidgets, wrapDefaultNarrationMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.client.gui.components.events.ContainerEventHandler

charTyped, getCurrentFocusPath, keyPressed, keyReleased, mouseScrolled

Methods inherited from interface net.minecraft.client.gui.components.events.GuiEventListener

getBorderForArrowNavigation, getRectangle, isMouseOver, mouseMoved, shouldTakeFocusAfterInteraction

Methods inherited from interface net.minecraft.client.gui.layouts.LayoutElement

setPosition

Methods inherited from interface net.minecraft.client.gui.narration.NarratableEntry

getNarratables

Methods inherited from interface net.minecraft.client.gui.components.TabOrderedElement

getTabOrderGroup

Constructor Details

WidgetCreatorList

@Deprecated(since="1.1.0",
            forRemoval=true)
public WidgetCreatorList(net.minecraft.client.Minecraft minecraftClient,
 int width,
 int height,
 int top,
 int bottom,
 int itemHeight)

Deprecated, for removal: This API element is subject to removal in a future version.

Mojang (rightfully) removed the bottom in 1.20.3, use WidgetCreatorList(Minecraft, int, int, int, int) instead

Creates an empty widget list

Parameters:

minecraftClient - The Minecraft client instance

width - The width of the list

height - The height of the list

top - The top position of the list

bottom - UNUSED PARAMETER, USE OTHER CONSTRUCTOR

itemHeight - The height of each widget, usually 20

See Also:

• WidgetCreatorList(Minecraft, int, int, int, int)

WidgetCreatorList

@Deprecated(since="1.10.0",
            forRemoval=true)
public WidgetCreatorList(net.minecraft.client.Minecraft minecraftClient,
 int width,
 int height,
 int top,
 int itemHeight)

Deprecated, for removal: This API element is subject to removal in a future version.

You should be wrapping the widget in the body of a HeaderAndFooterLayout

Creates an empty widget list

Parameters:

minecraftClient - The Minecraft client instance

width - The width of the list

height - The height of the list

top - The top position of the list

itemHeight - The height of each widget, usually 20

See Also:

• WidgetCreatorList(Minecraft, int, HeaderAndFooterLayout)

WidgetCreatorList

public WidgetCreatorList(net.minecraft.client.Minecraft minecraftClient,
 int width,
 net.minecraft.client.gui.layouts.HeaderAndFooterLayout layout)

Creates an empty widget list

Parameters:

minecraftClient - The Minecraft client instance

width - The width of the list

layout - The containing HeaderAndFooterLayout, used to compute the size

Method Details

addEntries

public void addEntries(WidgetCreator first,
 @Nullable
 @Nullable WidgetCreator other)

Add two entries. If other is null, first will *not* take up the full width.

Parameters:

first - The first widget creator

other - The second widget creator; nullable

addWideEntry

public void addWideEntry(WidgetCreator creator)

Add a single, wide entry.

Parameters:

creator - The widget creator

addAll

public void addAll(WidgetCreator[] options)

Add an array of widget creators.

Parameters:

options - The widget creator

See Also:

• addEntries(WidgetCreator, WidgetCreator)

getRowWidth

public int getRowWidth()

Overrides:

getRowWidth in class net.minecraft.client.gui.components.AbstractSelectionList<WidgetCreatorList.ButtonEntry>