Class AbstractSelectionList<E extends AbstractSelectionList.Entry<E>>

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

All Implemented Interfaces:

ContainerEventHandler, GuiEventListener, Renderable, TabOrderedElement, LayoutElement, NarratableEntry, NarrationSupplier

Direct Known Subclasses:

ContainerObjectSelectionList, ObjectSelectionList

public abstract class AbstractSelectionList<E extends AbstractSelectionList.Entry<E>>
extends AbstractContainerWidget

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractSelectionList.Entry<E extends AbstractSelectionList.Entry<E>>
private class	AbstractSelectionList.TrackedList

Nested classes/interfaces inherited from class AbstractScrollArea

AbstractScrollArea.ScrollbarSettings

Nested classes/interfaces inherited from class AbstractWidget

AbstractWidget.WithInactiveMessage

Nested classes/interfaces inherited from interface NarratableEntry

NarratableEntry.NarrationPriority

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	centerListVertically
private final List<E>	children
protected final int	defaultEntryHeight
private @Nullable E	hovered
private static final Identifier	INWORLD_MENU_LIST_BACKGROUND
private static final Identifier	MENU_LIST_BACKGROUND
protected final Minecraft	minecraft
private @Nullable E	selected
private static final int	SEPARATOR_HEIGHT

Fields inherited from class AbstractScrollArea

SCROLLBAR_WIDTH

Fields inherited from class AbstractWidget

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

Constructor Summary

Constructors

Constructor	Description
AbstractSelectionList(Minecraft minecraft, int width, int height, int y, int defaultEntryHeight)

Method Summary

Modifier and Type	Method	Description
protected int	addEntry(E entry)
protected int	addEntry(E entry, int height)
protected void	addEntryToTop(E entry)
protected void	addEntryToTop(E entry, int height)
private void	bindEntryToSelf(AbstractSelectionList.Entry<E> entry)
protected void	centerScrollOn(E entry)
final List<E>	children()
void	clearEntries()
protected void	clearEntriesExcept(E exception)
protected int	contentHeight()
protected void	enableScissor(GuiGraphics graphics)
protected boolean	entriesCanBeSelected()
Optional<GuiEventListener>	getChildAt(double x, double y)	Returns the first event listener that intersects with the mouse coordinates.
protected final @Nullable E	getEntryAtPosition(double posX, double posY)
private int	getFirstEntryY()
@Nullable E	getFocused()
protected @Nullable E	getHovered()
protected int	getItemCount()
int	getNextY()
int	getRowBottom(int row)
int	getRowLeft()
int	getRowRight()
int	getRowTop(int row)
int	getRowWidth()
@Nullable E	getSelected()
protected void	narrateListElementPosition(NarrationElementOutput output, E element)
NarratableEntry.NarrationPriority	narrationPriority()
protected @Nullable E	nextEntry(ScreenDirection dir)
protected @Nullable E	nextEntry(ScreenDirection dir, Predicate<E> canSelect)
protected @Nullable E	nextEntry(ScreenDirection dir, Predicate<E> canSelect, @Nullable E startEntry)
protected void	removeEntries(List<E> entries)
protected void	removeEntry(E entry)
protected void	removeEntryFromTop(E entry)
protected void	renderItem(GuiGraphics graphics, int mouseX, int mouseY, float a, E entry)
protected void	renderListBackground(GuiGraphics graphics)
protected void	renderListItems(GuiGraphics graphics, int mouseX, int mouseY, float a)
protected void	renderListSeparators(GuiGraphics graphics)
protected void	renderSelection(GuiGraphics graphics, E entry, int outlineColor)
void	renderWidget(GuiGraphics graphics, int mouseX, int mouseY, float a)
void	replaceEntries(Collection<E> newChildren)
private void	repositionEntries()
private void	scroll(int amount)
protected int	scrollBarX()
protected void	scrollToEntry(E entry)
void	setFocused(@Nullable GuiEventListener focused)	Sets the focus state of the GUI element.
void	setScrollAmount(double scrollAmount)
void	setSelected(@Nullable E selected)
protected void	sort(Comparator<E> comparator)
protected void	swap(int firstIndex, int secondIndex)
void	updateSize(int width, HeaderAndFooterLayout layout)
void	updateSizeAndPosition(int width, int height, int y)
void	updateSizeAndPosition(int width, int height, int x, int y)

Methods inherited from class AbstractContainerWidget

isDragging, isFocused, mouseClicked, mouseDragged, mouseReleased, nextFocusPath, setDragging, setFocused

Methods inherited from class AbstractScrollArea

defaultSettings, isOverScrollbar, maxScrollAmount, mouseScrolled, onRelease, refreshScrollAmount, renderScrollbar, scrollable, scrollAmount, scrollbarWidth, scrollBarY, scrollerHeight, scrollRate, updateScrolling

Methods inherited from class AbstractWidget

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

Methods inherited from class Object

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

Methods inherited from interface ContainerEventHandler

charTyped, getBorderForArrowNavigation, getCurrentFocusPath, keyPressed, keyReleased, mouseScrolled

Methods inherited from interface GuiEventListener

getRectangle, isMouseOver, mouseMoved, shouldTakeFocusAfterInteraction

Methods inherited from interface LayoutElement

setPosition

Methods inherited from interface NarratableEntry

getNarratables

Methods inherited from interface TabOrderedElement

getTabOrderGroup

Field Details

MENU_LIST_BACKGROUND

private static final Identifier MENU_LIST_BACKGROUND

INWORLD_MENU_LIST_BACKGROUND

private static final Identifier INWORLD_MENU_LIST_BACKGROUND

SEPARATOR_HEIGHT

private static final int SEPARATOR_HEIGHT

See Also:

• Constant Field Values

minecraft

protected final Minecraft minecraft

defaultEntryHeight

protected final int defaultEntryHeight

children

private final List<E extends AbstractSelectionList.Entry<E>> children

centerListVertically

protected boolean centerListVertically

selected

private @Nullable E extends AbstractSelectionList.Entry<E> selected

hovered

private @Nullable E extends AbstractSelectionList.Entry<E> hovered

Constructor Details

AbstractSelectionList

public AbstractSelectionList(Minecraft minecraft,
 int width,
 int height,
 int y,
 int defaultEntryHeight)

Method Details

getSelected

public @Nullable E getSelected()

setSelected

public void setSelected(@Nullable E selected)

getFocused

public @Nullable E getFocused()

Specified by:

getFocused in interface ContainerEventHandler

Overrides:

getFocused in class AbstractContainerWidget

children

public final List<E> children()

sort

protected void sort(Comparator<E> comparator)

swap

protected void swap(int firstIndex,
 int secondIndex)

clearEntries

public void clearEntries()

clearEntriesExcept

protected void clearEntriesExcept(E exception)

replaceEntries

public void replaceEntries(Collection<E> newChildren)

getFirstEntryY

private int getFirstEntryY()

getNextY

public int getNextY()

addEntry

protected int addEntry(E entry)

addEntry

protected int addEntry(E entry,
 int height)

addEntryToTop

protected void addEntryToTop(E entry)

addEntryToTop

protected void addEntryToTop(E entry,
 int height)

repositionEntries

private void repositionEntries()

removeEntryFromTop

protected void removeEntryFromTop(E entry)

getItemCount

protected int getItemCount()

entriesCanBeSelected

protected boolean entriesCanBeSelected()

getEntryAtPosition

protected final @Nullable E getEntryAtPosition(double posX,
 double posY)

updateSize

public void updateSize(int width,
 HeaderAndFooterLayout layout)

updateSizeAndPosition

public void updateSizeAndPosition(int width,
 int height,
 int y)

updateSizeAndPosition

public void updateSizeAndPosition(int width,
 int height,
 int x,
 int y)

contentHeight

protected int contentHeight()

Specified by:

contentHeight in class AbstractScrollArea

renderWidget

public void renderWidget(GuiGraphics graphics,
 int mouseX,
 int mouseY,
 float a)

Specified by:

renderWidget in class AbstractWidget

renderListSeparators

protected void renderListSeparators(GuiGraphics graphics)

renderListBackground

protected void renderListBackground(GuiGraphics graphics)

enableScissor

protected void enableScissor(GuiGraphics graphics)

scrollToEntry

protected void scrollToEntry(E entry)

centerScrollOn

protected void centerScrollOn(E entry)

scroll

private void scroll(int amount)

setScrollAmount

public void setScrollAmount(double scrollAmount)

Overrides:

setScrollAmount in class AbstractScrollArea

scrollBarX

protected int scrollBarX()

Overrides:

scrollBarX in class AbstractScrollArea

getChildAt

public Optional<GuiEventListener> getChildAt(double x,
 double y)

Description copied from interface: ContainerEventHandler

Returns the first event listener that intersects with the mouse coordinates.

setFocused

public void setFocused(@Nullable GuiEventListener focused)

Description copied from interface: ContainerEventHandler

Sets the focus state of the GUI element.

Specified by:

setFocused in interface ContainerEventHandler

Overrides:

setFocused in class AbstractContainerWidget

Parameters:

focused - the focused GUI element.

nextEntry

protected @Nullable E nextEntry(ScreenDirection dir)

nextEntry

protected @Nullable E nextEntry(ScreenDirection dir,
 Predicate<E> canSelect)

nextEntry

protected @Nullable E nextEntry(ScreenDirection dir,
 Predicate<E> canSelect,
 @Nullable E startEntry)

renderListItems

protected void renderListItems(GuiGraphics graphics,
 int mouseX,
 int mouseY,
 float a)

renderItem

protected void renderItem(GuiGraphics graphics,
 int mouseX,
 int mouseY,
 float a,
 E entry)

renderSelection

protected void renderSelection(GuiGraphics graphics,
 E entry,
 int outlineColor)

getRowLeft

public int getRowLeft()

getRowRight

public int getRowRight()

getRowTop

public int getRowTop(int row)

getRowBottom

public int getRowBottom(int row)

getRowWidth

public int getRowWidth()

narrationPriority

public NarratableEntry.NarrationPriority narrationPriority()

Specified by:

narrationPriority in interface NarratableEntry

Overrides:

narrationPriority in class AbstractWidget

removeEntries

protected void removeEntries(List<E> entries)

removeEntry

protected void removeEntry(E entry)

getHovered

protected @Nullable E getHovered()

bindEntryToSelf

private void bindEntryToSelf(AbstractSelectionList.Entry<E> entry)

narrateListElementPosition

protected void narrateListElementPosition(NarrationElementOutput output,
 E element)