Package net.minecraft.client.gui.widget

Class EditBoxWidget

java.lang.Object

net.minecraft.client.gui.widget.ClickableWidget

net.minecraft.client.gui.widget.ScrollableWidget

net.minecraft.client.gui.widget.ScrollableTextFieldWidget

net.minecraft.client.gui.widget.EditBoxWidget

All Implemented Interfaces:

Drawable, Element, Narratable, Navigable, Selectable, Widget

@Environment(CLIENT)
public class EditBoxWidget
extends ScrollableTextFieldWidget

A widget of EditBox, a multiline edit box with support for basic keyboard shortcuts. This class implements the rendering and scrolling for the edit box.

Mappings:

Namespace	Name
named	net/minecraft/client/gui/widget/EditBoxWidget
intermediary	net/minecraft/class_7529
official	fpm

Nested Class Summary

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

Selectable.SelectionType

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	CURSOR_BLINK_INTERVAL
private static final int	CURSOR_COLOR
private static final int	CURSOR_PADDING
private final EditBox	editBox
private static final int	FOCUSED_BOX_TEXT_COLOR
private long	lastSwitchFocusTime
private final Text	placeholder	The placeholder text that gets rendered when the edit box is empty.
private final TextRenderer	textRenderer
private static final String	UNDERSCORE
private static final int	UNFOCUSED_BOX_TEXT_COLOR

Fields inherited from class net.minecraft.client.gui.widget.ScrollableWidget

SCROLLBAR_WIDTH

Fields inherited from class net.minecraft.client.gui.widget.ClickableWidget

active, alpha, height, hovered, visible, width

Fields inherited from interface net.minecraft.client.gui.Element

MAX_DOUBLE_CLICK_INTERVAL

Constructor Summary

Constructors

Constructor	Description
EditBoxWidget(TextRenderer textRenderer, int x, int y, int width, int height, Text placeholder, Text message)

Method Summary

Modifier and Type	Method	Description
void	appendClickableNarrations(NarrationMessageBuilder builder)
boolean	charTyped(char chr, int modifiers)	Callback for when a character input has been captured.
private void	drawSelection(DrawContext context, int left, int top, int right, int bottom)
int	getContentsHeight()
protected double	getDeltaYPerScroll()
String	getText()	Returns the current text of the edit box.
boolean	keyPressed(int keyCode, int scanCode, int modifiers)	Callback for when a key down event has been captured.
private void	moveCursor(double mouseX, double mouseY)
void	onClick(double mouseX, double mouseY)
private void	onCursorChange()
protected void	onDrag(double mouseX, double mouseY, double deltaX, double deltaY)
protected void	renderContents(DrawContext context, int mouseX, int mouseY, float delta)
protected void	renderOverlay(DrawContext context)
void	setChangeListener(Consumer<String> changeListener)	Sets the change listener that is called every time the text changes.
void	setFocused(boolean focused)
void	setMaxLength(int maxLength)	Sets the maximum length of the edit box text in characters.
void	setText(String text)	Sets the text of the edit box and moves the cursor to the end of the edit box.

Methods inherited from class net.minecraft.client.gui.widget.ScrollableTextFieldWidget

draw, drawBox, getContentsHeightWithPadding, getPadding, getScrollbarX, getTextMargin, getTextX, getTextY, isMouseOver, isVisible, mouseClicked, playDownSound, renderWidget

Methods inherited from class net.minecraft.client.gui.widget.ScrollableWidget

checkScrollbarDragged, drawScrollbar, getMaxScrollY, getScrollbarThumbHeight, getScrollbarThumbY, getScrollY, mouseDragged, mouseScrolled, onRelease, overflows, refreshScroll, setScrollY

Methods inherited from class net.minecraft.client.gui.widget.ClickableWidget

appendDefaultNarrations, appendNarrations, drawScrollableText, drawScrollableText, drawScrollableText, forEachChild, getBottom, getHeight, getMessage, getNarrationMessage, getNarrationMessage, getNavigationFocus, getNavigationOrder, getNavigationPath, getRight, getTooltip, getType, getWidth, getX, getY, isFocused, isHovered, isNarratable, isSelected, isValidClickButton, mouseReleased, playClickSound, render, setAlpha, setDimensions, setDimensionsAndPosition, setHeight, setMessage, setNavigationOrder, setTooltip, setTooltipDelay, setWidth, setX, setY

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

getBorder, getFocusedPath, keyReleased, mouseMoved

Methods inherited from interface net.minecraft.client.gui.Selectable

getNarratedParts

Methods inherited from interface net.minecraft.client.gui.widget.Widget

setPosition

Field Details

CURSOR_PADDING

private static final int CURSOR_PADDING

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
named	CURSOR_PADDING	Lnet/minecraft/client/gui/widget/EditBoxWidget;CURSOR_PADDING:I
intermediary	field_39502	Lnet/minecraft/class_7529;field_39502:I
official	a	Lfpm;a:I

CURSOR_COLOR

private static final int CURSOR_COLOR

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
named	CURSOR_COLOR	Lnet/minecraft/client/gui/widget/EditBoxWidget;CURSOR_COLOR:I
intermediary	field_39503	Lnet/minecraft/class_7529;field_39503:I
official	c	Lfpm;c:I

UNDERSCORE

private static final String UNDERSCORE

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
named	UNDERSCORE	Lnet/minecraft/client/gui/widget/EditBoxWidget;UNDERSCORE:Ljava/lang/String;
intermediary	field_39504	Lnet/minecraft/class_7529;field_39504:Ljava/lang/String;
official	d	Lfpm;d:Ljava/lang/String;

FOCUSED_BOX_TEXT_COLOR

private static final int FOCUSED_BOX_TEXT_COLOR

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
named	FOCUSED_BOX_TEXT_COLOR	Lnet/minecraft/client/gui/widget/EditBoxWidget;FOCUSED_BOX_TEXT_COLOR:I
intermediary	field_39505	Lnet/minecraft/class_7529;field_39505:I
official	e	Lfpm;e:I

UNFOCUSED_BOX_TEXT_COLOR

private static final int UNFOCUSED_BOX_TEXT_COLOR

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
named	UNFOCUSED_BOX_TEXT_COLOR	Lnet/minecraft/client/gui/widget/EditBoxWidget;UNFOCUSED_BOX_TEXT_COLOR:I
intermediary	field_39506	Lnet/minecraft/class_7529;field_39506:I
official	f	Lfpm;f:I

CURSOR_BLINK_INTERVAL

private static final int CURSOR_BLINK_INTERVAL

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
named	CURSOR_BLINK_INTERVAL	Lnet/minecraft/client/gui/widget/EditBoxWidget;CURSOR_BLINK_INTERVAL:I
intermediary	field_45363	Lnet/minecraft/class_7529;field_45363:I
official	m	Lfpm;m:I

textRenderer

private final TextRenderer textRenderer

Mappings:

Namespace	Name	Mixin selector
named	textRenderer	Lnet/minecraft/client/gui/widget/EditBoxWidget;textRenderer:Lnet/minecraft/client/font/TextRenderer;
intermediary	field_39507	Lnet/minecraft/class_7529;field_39507:Lnet/minecraft/class_327;
official	n	Lfpm;n:Lfod;

placeholder

private final Text placeholder

The placeholder text that gets rendered when the edit box is empty. This does not get returned from getText(); an empty string will be returned in such cases.

Mappings:

Namespace	Name	Mixin selector
named	placeholder	Lnet/minecraft/client/gui/widget/EditBoxWidget;placeholder:Lnet/minecraft/text/Text;
intermediary	field_39508	Lnet/minecraft/class_7529;field_39508:Lnet/minecraft/class_2561;
official	o	Lfpm;o:Lwp;

editBox

private final EditBox editBox

Mappings:

Namespace	Name	Mixin selector
named	editBox	Lnet/minecraft/client/gui/widget/EditBoxWidget;editBox:Lnet/minecraft/client/gui/EditBox;
intermediary	field_39509	Lnet/minecraft/class_7529;field_39509:Lnet/minecraft/class_7530;
official	p	Lfpm;p:Lfpp;

lastSwitchFocusTime

private long lastSwitchFocusTime

Mappings:

Namespace	Name	Mixin selector
named	lastSwitchFocusTime	Lnet/minecraft/client/gui/widget/EditBoxWidget;lastSwitchFocusTime:J
intermediary	field_45364	Lnet/minecraft/class_7529;field_45364:J
official	q	Lfpm;q:J

Constructor Details

EditBoxWidget

public EditBoxWidget(TextRenderer textRenderer,
 int x,
 int y,
 int width,
 int height,
 Text placeholder,
 Text message)

Mappings:

Namespace	Name	Mixin selector
named	<init>	Lnet/minecraft/client/gui/widget/EditBoxWidget;<init>(Lnet/minecraft/client/font/TextRenderer;IIIILnet/minecraft/text/Text;Lnet/minecraft/text/Text;)V
intermediary	<init>	Lnet/minecraft/class_7529;<init>(Lnet/minecraft/class_327;IIIILnet/minecraft/class_2561;Lnet/minecraft/class_2561;)V
official	<init>	Lfpm;<init>(Lfod;IIIILwp;Lwp;)V

Method Details

setMaxLength

public void setMaxLength(int maxLength)

Sets the maximum length of the edit box text in characters.

If maxLength equals EditBox.UNLIMITED_LENGTH, the edit box does not have a length limit, and the widget does not show the current text length indicator.

Throws:

IllegalArgumentException - if maxLength is negative

See Also:

• EditBox.setMaxLength(int)

Mappings:

Namespace	Name	Mixin selector
named	setMaxLength	Lnet/minecraft/client/gui/widget/EditBoxWidget;setMaxLength(I)V
intermediary	method_44402	Lnet/minecraft/class_7529;method_44402(I)V
official	a	Lfpm;a(I)V

setChangeListener

public void setChangeListener(Consumer<String> changeListener)

Sets the change listener that is called every time the text changes.

Parameters:

changeListener - the listener that takes the new text of the edit box

Mappings:

Namespace	Name	Mixin selector
named	setChangeListener	Lnet/minecraft/client/gui/widget/EditBoxWidget;setChangeListener(Ljava/util/function/Consumer;)V
intermediary	method_44401	Lnet/minecraft/class_7529;method_44401(Ljava/util/function/Consumer;)V
official	b	Lfpm;b(Ljava/util/function/Consumer;)V

setText

public void setText(String text)

Sets the text of the edit box and moves the cursor to the end of the edit box.

Mappings:

Namespace	Name	Mixin selector
named	setText	Lnet/minecraft/client/gui/widget/EditBoxWidget;setText(Ljava/lang/String;)V
intermediary	method_44400	Lnet/minecraft/class_7529;method_44400(Ljava/lang/String;)V
official	a	Lfpm;a(Ljava/lang/String;)V

getText

public String getText()

Returns the current text of the edit box.

Returns:

the current text of the edit box

Mappings:

Namespace	Name	Mixin selector
named	getText	Lnet/minecraft/client/gui/widget/EditBoxWidget;getText()Ljava/lang/String;
intermediary	method_44405	Lnet/minecraft/class_7529;method_44405()Ljava/lang/String;
official	q	Lfpm;q()Ljava/lang/String;

appendClickableNarrations

public void appendClickableNarrations(NarrationMessageBuilder builder)

Specified by:

appendClickableNarrations in class ClickableWidget

Mappings:

Namespace	Name	Mixin selector
named	appendClickableNarrations	Lnet/minecraft/client/gui/widget/ClickableWidget;appendClickableNarrations(Lnet/minecraft/client/gui/screen/narration/NarrationMessageBuilder;)V
intermediary	method_47399	Lnet/minecraft/class_339;method_47399(Lnet/minecraft/class_6382;)V
official	a	Lfos;a(Lfsr;)V

onClick

public void onClick(double mouseX,
 double mouseY)

Overrides:

onClick in class ClickableWidget

Mappings:

Namespace	Name	Mixin selector
named	onClick	Lnet/minecraft/client/gui/widget/ClickableWidget;onClick(DD)V
intermediary	method_25348	Lnet/minecraft/class_339;method_25348(DD)V
official	a	Lfos;a(DD)V

onDrag

protected void onDrag(double mouseX,
 double mouseY,
 double deltaX,
 double deltaY)

Overrides:

onDrag in class ClickableWidget

Mappings:

Namespace	Name	Mixin selector
named	onDrag	Lnet/minecraft/client/gui/widget/ClickableWidget;onDrag(DDDD)V
intermediary	method_25349	Lnet/minecraft/class_339;method_25349(DDDD)V
official	b	Lfos;b(DDDD)V

keyPressed

public boolean keyPressed(int keyCode,
 int scanCode,
 int modifiers)

Callback for when a key down event has been captured. The key code is identified by the constants in GLFW class.

Specified by:

keyPressed in interface Element

Overrides:

keyPressed in class ScrollableTextFieldWidget

Parameters:

keyCode - the named key code of the event as described in the GLFW class

scanCode - the unique/platform-specific scan code of the keyboard input

modifiers - a GLFW bitfield describing the modifier keys that are held down (see GLFW Modifier key flags)

Returns:

true to indicate that the event handling is successful/valid

See Also:

• Keyboard.onKey(long, int, int, int, int)
• GLFW.GLFW_KEY_Q
• GLFWKeyCallbackI.invoke(long, int, int, int, int)

Mappings:

Namespace	Name	Mixin selector
named	keyPressed	Lnet/minecraft/client/gui/Element;keyPressed(III)Z
intermediary	method_25404	Lnet/minecraft/class_364;method_25404(III)Z
official	a	Lfqr;a(III)Z

charTyped

public boolean charTyped(char chr,
 int modifiers)

Callback for when a character input has been captured. The key code is identified by the constants in GLFW class.

Parameters:

chr - the captured character

modifiers - a GLFW bitfield describing the modifier keys that are held down (see GLFW Modifier key flags)

Returns:

true to indicate that the event handling is successful/valid

See Also:

• Keyboard.onChar(long, int, int)
• GLFW.GLFW_KEY_Q
• GLFWKeyCallbackI.invoke(long, int, int, int, int)

Mappings:

Namespace	Name	Mixin selector
named	charTyped	Lnet/minecraft/client/gui/Element;charTyped(CI)Z
intermediary	method_25400	Lnet/minecraft/class_364;method_25400(CI)Z
official	a	Lfqr;a(CI)Z

renderContents

protected void renderContents(DrawContext context,
 int mouseX,
 int mouseY,
 float delta)

Specified by:

renderContents in class ScrollableTextFieldWidget

Mappings:

Namespace	Name	Mixin selector
named	renderContents	Lnet/minecraft/client/gui/widget/ScrollableTextFieldWidget;renderContents(Lnet/minecraft/client/gui/DrawContext;IIF)V
intermediary	method_44389	Lnet/minecraft/class_10415;method_44389(Lnet/minecraft/class_332;IIF)V
official	c	Lfoq;c(Lfof;IIF)V

renderOverlay

protected void renderOverlay(DrawContext context)

Overrides:

renderOverlay in class ScrollableTextFieldWidget

Mappings:

Namespace	Name	Mixin selector
named	renderOverlay	Lnet/minecraft/client/gui/widget/ScrollableTextFieldWidget;renderOverlay(Lnet/minecraft/client/gui/DrawContext;)V
intermediary	method_44384	Lnet/minecraft/class_10415;method_44384(Lnet/minecraft/class_332;)V
official	b	Lfoq;b(Lfof;)V

getContentsHeight

public int getContentsHeight()

Specified by:

getContentsHeight in class ScrollableTextFieldWidget

Mappings:

Namespace	Name	Mixin selector
named	getContentsHeight	Lnet/minecraft/client/gui/widget/ScrollableTextFieldWidget;getContentsHeight()I
intermediary	method_44391	Lnet/minecraft/class_10415;method_44391()I
official	c	Lfoq;c()I

getDeltaYPerScroll

protected double getDeltaYPerScroll()

Specified by:

getDeltaYPerScroll in class ScrollableWidget

Mappings:

Namespace	Name	Mixin selector
named	getDeltaYPerScroll	Lnet/minecraft/client/gui/widget/ScrollableWidget;getDeltaYPerScroll()D
intermediary	method_44393	Lnet/minecraft/class_7528;method_44393()D
official	o	Lfom;o()D

drawSelection

private void drawSelection(DrawContext context,
 int left,
 int top,
 int right,
 int bottom)

Mappings:

Namespace	Name	Mixin selector
named	drawSelection	Lnet/minecraft/client/gui/widget/EditBoxWidget;drawSelection(Lnet/minecraft/client/gui/DrawContext;IIII)V
intermediary	method_44403	Lnet/minecraft/class_7529;method_44403(Lnet/minecraft/class_332;IIII)V
official	b	Lfpm;b(Lfof;IIII)V

onCursorChange

private void onCursorChange()

Mappings:

Namespace	Name	Mixin selector
named	onCursorChange	Lnet/minecraft/client/gui/widget/EditBoxWidget;onCursorChange()V
intermediary	method_44407	Lnet/minecraft/class_7529;method_44407()V
official	r	Lfpm;r()V

moveCursor

private void moveCursor(double mouseX,
 double mouseY)

Mappings:

Namespace	Name	Mixin selector
named	moveCursor	Lnet/minecraft/client/gui/widget/EditBoxWidget;moveCursor(DD)V
intermediary	method_44404	Lnet/minecraft/class_7529;method_44404(DD)V
official	c	Lfpm;c(DD)V

setFocused

public void setFocused(boolean focused)

Specified by:

setFocused in interface Element

Overrides:

setFocused in class ClickableWidget

Mappings:

Namespace	Name	Mixin selector
named	setFocused	Lnet/minecraft/client/gui/Element;setFocused(Z)V
intermediary	method_25365	Lnet/minecraft/class_364;method_25365(Z)V
official	a	Lfqr;a(Z)V