Package net.minecraft.client.gui.components

Class AbstractWidget

java.lang.Object

net.minecraft.client.gui.components.AbstractWidget

All Implemented Interfaces:

GuiEventListener, Renderable, TabOrderedElement, LayoutElement, NarratableEntry, NarrationSupplier

Direct Known Subclasses:

AbstractButton, AbstractScrollArea, AbstractSliderButton, AbstractStringWidget, EditBox, GameModeSwitcherScreen.GameModeSlot, ImageWidget, ItemDisplayWidget, LoadingDotsWidget, OverlayRecipeComponent.OverlayRecipeButton, PlayerSkinWidget, RecipeButton, StateSwitchingButton, TabButton

public abstract class AbstractWidget
extends Object
implements Renderable, GuiEventListener, LayoutElement, NarratableEntry

Nested Class Summary

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

NarratableEntry.NarrationPriority

Field Summary

Fields

Modifier and Type	Field	Description
boolean	active
protected float	alpha
private boolean	focused
protected int	height
protected boolean	isHovered
private Component	message
private static final double	MIN_SCROLL_PERIOD
protected int	packedFGColor
private static final double	PERIOD_PER_SCROLLED_PIXEL
private int	tabOrderGroup
private final WidgetTooltipHolder	tooltip
static final int	UNSET_FG_COLOR
boolean	visible
protected int	width
private int	x
private int	y

Constructor Summary

Constructors

Constructor	Description
AbstractWidget(int x, int y, int width, int height, Component message)

Method Summary

Modifier and Type	Method	Description
private boolean	areCoordinatesInRectangle(double x, double y)
void	clearFGColor()
protected MutableComponent	createNarrationMessage()
protected void	defaultButtonNarrationText(NarrationElementOutput narrationElementOutput)
int	getBottom()
int	getFGColor()
int	getHeight()
Component	getMessage()
ScreenRectangle	getRectangle()
int	getRight()
int	getTabOrderGroup()
int	getWidth()
int	getX()
int	getY()
boolean	isActive()
boolean	isFocused()
boolean	isHovered()
boolean	isHoveredOrFocused()
boolean	isMouseOver(double mouseX, double mouseY)	Checks if the given mouse coordinates are over the GUI element.
protected boolean	isValidClickButton(MouseButtonInfo buttonInfo)
boolean	mouseClicked(MouseButtonEvent p_447133_, boolean p_434606_)
boolean	mouseDragged(MouseButtonEvent p_445646_, double p_93645_, double p_93646_)
boolean	mouseReleased(MouseButtonEvent p_446092_)
NarratableEntry.NarrationPriority	narrationPriority()
ComponentPath	nextFocusPath(FocusNavigationEvent p_265640_)	Retrieves the next focus path based on the given focus navigation event.
void	onClick(MouseButtonEvent event, boolean isDoubleClick)
protected void	onDrag(MouseButtonEvent event, double mouseX, double mouseY)
void	onRelease(MouseButtonEvent event)
static void	playButtonClickSound(SoundManager soundManager)
void	playDownSound(SoundManager handler)
final void	render(GuiGraphics p_282421_, int p_93658_, int p_93659_, float p_93660_)	Renders the graphical user interface (GUI) element.
protected void	renderScrollingString(GuiGraphics guiGraphics, Font font, int padding, int color)
static void	renderScrollingString(GuiGraphics guiGraphics, Font font, Component text, int minX, int minY, int maxX, int maxY, int color)
static void	renderScrollingString(GuiGraphics guiGraphics, Font font, Component text, int centerX, int minX, int minY, int maxX, int maxY, int color)
protected abstract void	renderWidget(GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick)
void	setAlpha(float alpha)
void	setFGColor(int color)
void	setFocused(boolean focused)	Sets the focus state of the GUI element.
void	setHeight(int height)
void	setMessage(Component message)
void	setRectangle(int width, int height, int x, int y)
void	setSize(int width, int height)
void	setTabOrderGroup(int tabOrderGroup)
void	setTooltip(Tooltip tooltip)
void	setTooltipDelay(Duration tooltipDelay)
void	setWidth(int width)
void	setX(int x)
void	setY(int y)
final void	updateNarration(NarrationElementOutput p_259921_)	Updates the narration output with the current narration information.
protected abstract void	updateWidgetNarration(NarrationElementOutput narrationElementOutput)
void	visitWidgets(Consumer<AbstractWidget> p_265566_)
static MutableComponent	wrapDefaultNarrationMessage(Component message)

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.GuiEventListener

charTyped, getBorderForArrowNavigation, getCurrentFocusPath, keyPressed, keyReleased, mouseMoved, mouseScrolled, shouldTakeFocusAfterInteraction

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

setPosition

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

getNarratables

Field Details

PERIOD_PER_SCROLLED_PIXEL

private static final double PERIOD_PER_SCROLLED_PIXEL

See Also:

• Constant Field Values

MIN_SCROLL_PERIOD

private static final double MIN_SCROLL_PERIOD

See Also:

• Constant Field Values

width

protected int width

height

protected int height

x

private int x

y

private int y

message

private Component message

isHovered

protected boolean isHovered

active

public boolean active

visible

public boolean visible

alpha

protected float alpha

tabOrderGroup

private int tabOrderGroup

focused

private boolean focused

tooltip

private final WidgetTooltipHolder tooltip

UNSET_FG_COLOR

public static final int UNSET_FG_COLOR

See Also:

• Constant Field Values

packedFGColor

protected int packedFGColor

Constructor Details

AbstractWidget

public AbstractWidget(int x,
 int y,
 int width,
 int height,
 Component message)

Method Details

getHeight

public int getHeight()

Specified by:

getHeight in interface LayoutElement

render

public final void render(GuiGraphics p_282421_,
 int p_93658_,
 int p_93659_,
 float p_93660_)

Description copied from interface: Renderable

Renders the graphical user interface (GUI) element.

Specified by:

render in interface Renderable

Parameters:

p_282421_ - the GuiGraphics object used for rendering.

p_93658_ - the x-coordinate of the mouse cursor.

p_93659_ - the y-coordinate of the mouse cursor.

p_93660_ - the partial tick time.

setTooltip

public void setTooltip(@Nullable
 Tooltip tooltip)

setTooltipDelay

public void setTooltipDelay(Duration tooltipDelay)

createNarrationMessage

protected MutableComponent createNarrationMessage()

wrapDefaultNarrationMessage

public static MutableComponent wrapDefaultNarrationMessage(Component message)

renderWidget

protected abstract void renderWidget(GuiGraphics guiGraphics,
 int mouseX,
 int mouseY,
 float partialTick)

renderScrollingString

public static void renderScrollingString(GuiGraphics guiGraphics,
 Font font,
 Component text,
 int minX,
 int minY,
 int maxX,
 int maxY,
 int color)

renderScrollingString

public static void renderScrollingString(GuiGraphics guiGraphics,
 Font font,
 Component text,
 int centerX,
 int minX,
 int minY,
 int maxX,
 int maxY,
 int color)

renderScrollingString

protected void renderScrollingString(GuiGraphics guiGraphics,
 Font font,
 int padding,
 int color)

onClick

public void onClick(MouseButtonEvent event,
 boolean isDoubleClick)

onRelease

public void onRelease(MouseButtonEvent event)

onDrag

protected void onDrag(MouseButtonEvent event,
 double mouseX,
 double mouseY)

mouseClicked

public boolean mouseClicked(MouseButtonEvent p_447133_,
 boolean p_434606_)

Specified by:

mouseClicked in interface GuiEventListener

mouseReleased

public boolean mouseReleased(MouseButtonEvent p_446092_)

Specified by:

mouseReleased in interface GuiEventListener

isValidClickButton

protected boolean isValidClickButton(MouseButtonInfo buttonInfo)

mouseDragged

public boolean mouseDragged(MouseButtonEvent p_445646_,
 double p_93645_,
 double p_93646_)

Specified by:

mouseDragged in interface GuiEventListener

nextFocusPath

@Nullable
public ComponentPath nextFocusPath(FocusNavigationEvent p_265640_)

Description copied from interface: GuiEventListener

Retrieves the next focus path based on the given focus navigation event.

Specified by:

nextFocusPath in interface GuiEventListener

Parameters:

p_265640_ - the focus navigation event.

Returns:

the next focus path as a ComponentPath, or null if there is no next focus path.

isMouseOver

public boolean isMouseOver(double mouseX,
 double mouseY)

Description copied from interface: GuiEventListener

Checks if the given mouse coordinates are over the GUI element.

Specified by:

isMouseOver in interface GuiEventListener

Parameters:

mouseX - the X coordinate of the mouse.

mouseY - the Y coordinate of the mouse.

Returns:

true if the mouse is over the GUI element, false otherwise.

playDownSound

public void playDownSound(SoundManager handler)

playButtonClickSound

public static void playButtonClickSound(SoundManager soundManager)

getWidth

public int getWidth()

Specified by:

getWidth in interface LayoutElement

setWidth

public void setWidth(int width)

setHeight

public void setHeight(int height)

setAlpha

public void setAlpha(float alpha)

setMessage

public void setMessage(Component message)

getMessage

public Component getMessage()

isFocused

public boolean isFocused()

Specified by:

isFocused in interface GuiEventListener

isHovered

public boolean isHovered()

isHoveredOrFocused

public boolean isHoveredOrFocused()

isActive

public boolean isActive()

Specified by:

isActive in interface NarratableEntry

setFocused

public void setFocused(boolean focused)

Description copied from interface: GuiEventListener

Sets the focus state of the GUI element.

Specified by:

setFocused in interface GuiEventListener

Parameters:

focused - true to apply focus, false to remove focus

getFGColor

public int getFGColor()

setFGColor

public void setFGColor(int color)

clearFGColor

public void clearFGColor()

narrationPriority

public NarratableEntry.NarrationPriority narrationPriority()

Specified by:

narrationPriority in interface NarratableEntry

updateNarration

public final void updateNarration(NarrationElementOutput p_259921_)

Description copied from interface: NarrationSupplier

Updates the narration output with the current narration information.

Specified by:

updateNarration in interface NarrationSupplier

Parameters:

p_259921_ - the output to update with narration information.

updateWidgetNarration

protected abstract void updateWidgetNarration(NarrationElementOutput narrationElementOutput)

defaultButtonNarrationText

protected void defaultButtonNarrationText(NarrationElementOutput narrationElementOutput)

getX

public int getX()

Specified by:

getX in interface LayoutElement

setX

public void setX(int x)

Specified by:

setX in interface LayoutElement

getY

public int getY()

Specified by:

getY in interface LayoutElement

setY

public void setY(int y)

Specified by:

setY in interface LayoutElement

getRight

public int getRight()

getBottom

public int getBottom()

visitWidgets

public void visitWidgets(Consumer<AbstractWidget> p_265566_)

Specified by:

visitWidgets in interface LayoutElement

setSize

public void setSize(int width,
 int height)

getRectangle

public ScreenRectangle getRectangle()

Specified by:

getRectangle in interface GuiEventListener

Specified by:

getRectangle in interface LayoutElement

areCoordinatesInRectangle

private boolean areCoordinatesInRectangle(double x,
 double y)

setRectangle

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

getTabOrderGroup

public int getTabOrderGroup()

Specified by:

getTabOrderGroup in interface TabOrderedElement

setTabOrderGroup

public void setTabOrderGroup(int tabOrderGroup)