Class AbstractWidget

java.lang.Object

net.minecraft.client.gui.components.AbstractWidget

All Implemented Interfaces:

GuiEventListener, Renderable, TabOrderedElement, LayoutElement, NarratableEntry, NarrationSupplier

Direct Known Subclasses:

AbstractScrollArea, AbstractStringWidget, AbstractWidget.WithInactiveMessage, EditBox, GameModeSwitcherScreen.GameModeSlot, ImageWidget, ItemDisplayWidget, LoadingDotsWidget, OverlayRecipeComponent.OverlayRecipeButton, PlayerSkinWidget, RecipeButton

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractWidget.WithInactiveMessage

Nested classes/interfaces inherited from interface 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
protected Component	message
protected int	packedFGColor
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 output)
final void	extractRenderState(GuiGraphicsExtractor graphics, int mouseX, int mouseY, float a)
void	extractScrollingStringOverContents(ActiveTextCollector output, Component message, int margin)
protected abstract void	extractWidgetRenderState(GuiGraphicsExtractor graphics, int mouseX, int mouseY, float a)
float	getAlpha()
int	getBottom()
int	getFGColor()
int	getHeight()
Component	getMessage()
ScreenRectangle	getRectangle()
int	getRight()
int	getTabOrderGroup()
int	getWidth()
int	getX()
int	getY()
protected void	handleCursor(GuiGraphicsExtractor graphics)
boolean	isActive()
boolean	isFocused()
boolean	isHovered()
boolean	isHoveredOrFocused()
boolean	isMouseOver(double mouseX, double mouseY)
protected boolean	isValidClickButton(MouseButtonInfo buttonInfo)
boolean	mouseClicked(MouseButtonEvent event, boolean doubleClick)
boolean	mouseDragged(MouseButtonEvent event, double dx, double dy)
boolean	mouseReleased(MouseButtonEvent event)
NarratableEntry.NarrationPriority	narrationPriority()
@Nullable ComponentPath	nextFocusPath(FocusNavigationEvent navigationEvent)
void	onClick(MouseButtonEvent event, boolean doubleClick)
protected void	onDrag(MouseButtonEvent event, double dx, double dy)
void	onRelease(MouseButtonEvent event)
static void	playButtonClickSound(SoundManager soundManager)
void	playDownSound(SoundManager soundManager)
void	setAlpha(float alpha)
void	setFGColor(int color)
void	setFocused(boolean focused)
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(@Nullable Tooltip tooltip)
void	setTooltipDelay(Duration delay)
void	setWidth(int width)
void	setX(int x)
void	setY(int y)
final void	updateNarration(NarrationElementOutput output)
protected abstract void	updateWidgetNarration(NarrationElementOutput output)
void	visitWidgets(Consumer<AbstractWidget> widgetVisitor)
static MutableComponent	wrapDefaultNarrationMessage(Component message)

Methods inherited from class Object

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

Methods inherited from interface GuiEventListener

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

Methods inherited from interface LayoutElement

setPosition

Methods inherited from interface NarratableEntry

getNarratables

Field Details

width

protected int width

height

protected int height

x

private int x

y

private int y

message

protected 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

extractRenderState

public final void extractRenderState(GuiGraphicsExtractor graphics,
 int mouseX,
 int mouseY,
 float a)

Specified by:

extractRenderState in interface Renderable

handleCursor

protected void handleCursor(GuiGraphicsExtractor graphics)

setTooltip

public void setTooltip(@Nullable Tooltip tooltip)

setTooltipDelay

public void setTooltipDelay(Duration delay)

createNarrationMessage

protected MutableComponent createNarrationMessage()

wrapDefaultNarrationMessage

public static MutableComponent wrapDefaultNarrationMessage(Component message)

extractWidgetRenderState

protected abstract void extractWidgetRenderState(GuiGraphicsExtractor graphics,
 int mouseX,
 int mouseY,
 float a)

extractScrollingStringOverContents

public void extractScrollingStringOverContents(ActiveTextCollector output,
 Component message,
 int margin)

onClick

public void onClick(MouseButtonEvent event,
 boolean doubleClick)

onRelease

public void onRelease(MouseButtonEvent event)

onDrag

protected void onDrag(MouseButtonEvent event,
 double dx,
 double dy)

mouseClicked

public boolean mouseClicked(MouseButtonEvent event,
 boolean doubleClick)

Specified by:

mouseClicked in interface GuiEventListener

mouseReleased

public boolean mouseReleased(MouseButtonEvent event)

Specified by:

mouseReleased in interface GuiEventListener

isValidClickButton

protected boolean isValidClickButton(MouseButtonInfo buttonInfo)

mouseDragged

public boolean mouseDragged(MouseButtonEvent event,
 double dx,
 double dy)

Specified by:

mouseDragged in interface GuiEventListener

nextFocusPath

public @Nullable ComponentPath nextFocusPath(FocusNavigationEvent navigationEvent)

Specified by:

nextFocusPath in interface GuiEventListener

isMouseOver

public boolean isMouseOver(double mouseX,
 double mouseY)

Specified by:

isMouseOver in interface GuiEventListener

playDownSound

public void playDownSound(SoundManager soundManager)

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)

getAlpha

public float getAlpha()

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)

Specified by:

setFocused in interface GuiEventListener

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 output)

Specified by:

updateNarration in interface NarrationSupplier

updateWidgetNarration

protected abstract void updateWidgetNarration(NarrationElementOutput output)

defaultButtonNarrationText

protected void defaultButtonNarrationText(NarrationElementOutput output)

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> widgetVisitor)

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)