Package net.minecraft.client.gui.widget
Class EditBoxWidget
java.lang.Object
net.minecraft.client.gui.DrawableHelper
net.minecraft.client.gui.widget.ClickableWidget
net.minecraft.client.gui.widget.ScrollableWidget
net.minecraft.client.gui.widget.EditBoxWidget
- All Implemented Interfaces:
Drawable
,Element
,Narratable
,Selectable
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 official eib
intermediary net/minecraft/class_7529
named net/minecraft/client/gui/widget/EditBoxWidget
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.minecraft.client.gui.Selectable
Selectable.SelectionType
-
Field Summary
Modifier and TypeFieldDescriptionprivate static final int
private static final int
private final EditBox
private static final int
private final Text
The placeholder text that gets rendered when the edit box is empty.private final TextRenderer
private int
private static final String
private static final int
Fields inherited from class net.minecraft.client.gui.widget.ClickableWidget
active, alpha, height, hovered, visible, WIDGETS_TEXTURE, width, x, y
Fields inherited from class net.minecraft.client.gui.DrawableHelper
GUI_ICONS_TEXTURE, OPTIONS_BACKGROUND_TEXTURE, STATS_ICON_TEXTURE
Fields inherited from interface net.minecraft.client.gui.Element
MAX_DOUBLE_CLICK_INTERVAL
-
Constructor Summary
ConstructorDescriptionEditBoxWidget
(TextRenderer textRenderer, int x, int y, int width, int height, Text placeholder, Text message) -
Method Summary
Modifier and TypeMethodDescriptionvoid
appendNarrations
(NarrationMessageBuilder builder) boolean
charTyped
(char chr, int modifiers) Callback for when a character input has been captured.private void
drawSelection
(MatrixStack matrices, int left, int top, int right, int bottom) int
Returns the total height of the contents.protected double
private double
Returns the maximum amount of lines the widget can hold without overflowing.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.boolean
mouseClicked
(double mouseX, double mouseY, int button) Callback for when a mouse button down event has been captured.boolean
mouseDragged
(double mouseX, double mouseY, int button, double deltaX, double deltaY) Callback for when a mouse button drag event has been captured.private void
moveCursor
(double mouseX, double mouseY) private void
protected boolean
Returns whether the contents overflow and needs a scrollbar.protected void
renderContents
(MatrixStack matrices, int mouseX, int mouseY, float delta) Renders the scrolled contents.protected void
renderOverlay
(MatrixStack matrices) Renders overlays that are not scrolled but part of the widget.void
setChangeListener
(Consumer<String> changeListener) Sets the change listener that is called every time the text changes.void
setMaxLength
(int maxLength) Sets the maximum length of the edit box text in characters.void
Sets the text of the edit box and moves the cursor to the end of the edit box.void
tick()
Methods inherited from class net.minecraft.client.gui.widget.ScrollableWidget
getMaxScrollY, getPadding, getPaddingDoubled, getScrollY, isVisible, isWithinBounds, mouseReleased, mouseScrolled, renderButton, setScrollY
Methods inherited from class net.minecraft.client.gui.widget.ClickableWidget
appendDefaultNarrations, changeFocus, clicked, getHeight, getMessage, getNarrationMessage, getNarrationMessage, getType, getWidth, getYImage, isFocused, isHovered, isMouseOver, isNarratable, isValidClickButton, onClick, onDrag, onFocusedChanged, onRelease, playDownSound, render, renderBackground, renderTooltip, setAlpha, setFocused, setMessage, setWidth
Methods inherited from class net.minecraft.client.gui.DrawableHelper
disableScissor, drawCenteredText, drawCenteredText, drawCenteredTextWithShadow, drawHorizontalLine, drawSprite, drawStringWithShadow, drawTexture, drawTexture, drawTexture, drawTexture, drawTextWithShadow, drawVerticalLine, drawWithOutline, drawWithShadow, enableScissor, fill, fillGradient, fillGradient, fillGradient, getZOffset, setZOffset
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
changeFocus, isMouseOver, keyReleased, mouseMoved
-
Field Details
-
CURSOR_PADDING
private static final int CURSOR_PADDING- See Also:
- Mappings:
Namespace Name Mixin selector official a
Leib;a:I
intermediary field_39502
Lnet/minecraft/class_7529;field_39502:I
named CURSOR_PADDING
Lnet/minecraft/client/gui/widget/EditBoxWidget;CURSOR_PADDING:I
-
CURSOR_COLOR
private static final int CURSOR_COLOR- See Also:
- Mappings:
Namespace Name Mixin selector official b
Leib;b:I
intermediary field_39503
Lnet/minecraft/class_7529;field_39503:I
named CURSOR_COLOR
Lnet/minecraft/client/gui/widget/EditBoxWidget;CURSOR_COLOR:I
-
UNDERSCORE
- See Also:
- Mappings:
Namespace Name Mixin selector official c
Leib;c:Ljava/lang/String;
intermediary field_39504
Lnet/minecraft/class_7529;field_39504:Ljava/lang/String;
named UNDERSCORE
Lnet/minecraft/client/gui/widget/EditBoxWidget;UNDERSCORE:Ljava/lang/String;
-
FOCUSED_BOX_TEXT_COLOR
private static final int FOCUSED_BOX_TEXT_COLOR- See Also:
- Mappings:
Namespace Name Mixin selector official d
Leib;d:I
intermediary field_39505
Lnet/minecraft/class_7529;field_39505:I
named FOCUSED_BOX_TEXT_COLOR
Lnet/minecraft/client/gui/widget/EditBoxWidget;FOCUSED_BOX_TEXT_COLOR:I
-
UNFOCUSED_BOX_TEXT_COLOR
private static final int UNFOCUSED_BOX_TEXT_COLOR- See Also:
- Mappings:
Namespace Name Mixin selector official e
Leib;e:I
intermediary field_39506
Lnet/minecraft/class_7529;field_39506:I
named UNFOCUSED_BOX_TEXT_COLOR
Lnet/minecraft/client/gui/widget/EditBoxWidget;UNFOCUSED_BOX_TEXT_COLOR:I
-
textRenderer
- Mappings:
Namespace Name Mixin selector official f
Leib;f:Leha;
intermediary field_39507
Lnet/minecraft/class_7529;field_39507:Lnet/minecraft/class_327;
named textRenderer
Lnet/minecraft/client/gui/widget/EditBoxWidget;textRenderer:Lnet/minecraft/client/font/TextRenderer;
-
placeholder
The placeholder text that gets rendered when the edit box is empty. This does not get returned fromgetText()
; an empty string will be returned in such cases.- Mappings:
Namespace Name Mixin selector official s
Leib;s:Lrq;
intermediary field_39508
Lnet/minecraft/class_7529;field_39508:Lnet/minecraft/class_2561;
named placeholder
Lnet/minecraft/client/gui/widget/EditBoxWidget;placeholder:Lnet/minecraft/text/Text;
-
editBox
- Mappings:
Namespace Name Mixin selector official t
Leib;t:Leid;
intermediary field_39509
Lnet/minecraft/class_7529;field_39509:Lnet/minecraft/class_7530;
named editBox
Lnet/minecraft/client/gui/widget/EditBoxWidget;editBox:Lnet/minecraft/client/gui/EditBox;
-
tick
private int tick- Mappings:
Namespace Name Mixin selector official u
Leib;u:I
intermediary field_39510
Lnet/minecraft/class_7529;field_39510:I
named tick
Lnet/minecraft/client/gui/widget/EditBoxWidget;tick:I
-
-
Constructor Details
-
EditBoxWidget
public EditBoxWidget(TextRenderer textRenderer, int x, int y, int width, int height, Text placeholder, Text message) - Mappings:
Namespace Name Mixin selector official <init>
Leib;<init>(Leha;IIIILrq;Lrq;)V
intermediary <init>
Lnet/minecraft/class_7529;<init>(Lnet/minecraft/class_327;IIIILnet/minecraft/class_2561;Lnet/minecraft/class_2561;)V
named <init>
Lnet/minecraft/client/gui/widget/EditBoxWidget;<init>(Lnet/minecraft/client/font/TextRenderer;IIIILnet/minecraft/text/Text;Lnet/minecraft/text/Text;)V
-
-
Method Details
-
setMaxLength
public void setMaxLength(int maxLength) Sets the maximum length of the edit box text in characters.If
maxLength
equalsEditBox.UNLIMITED_LENGTH
, the edit box does not have a length limit, and the widget does not show the current text length indicator.- Throws:
IllegalArgumentException
- ifmaxLength
is negative- See Also:
- Mappings:
Namespace Name Mixin selector official c
Leib;c(I)V
intermediary method_44402
Lnet/minecraft/class_7529;method_44402(I)V
named setMaxLength
Lnet/minecraft/client/gui/widget/EditBoxWidget;setMaxLength(I)V
-
setChangeListener
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 official a
Leib;a(Ljava/util/function/Consumer;)V
intermediary method_44401
Lnet/minecraft/class_7529;method_44401(Ljava/util/function/Consumer;)V
named setChangeListener
Lnet/minecraft/client/gui/widget/EditBoxWidget;setChangeListener(Ljava/util/function/Consumer;)V
-
setText
Sets the text of the edit box and moves the cursor to the end of the edit box.- Mappings:
Namespace Name Mixin selector official a
Leib;a(Ljava/lang/String;)V
intermediary method_44400
Lnet/minecraft/class_7529;method_44400(Ljava/lang/String;)V
named setText
Lnet/minecraft/client/gui/widget/EditBoxWidget;setText(Ljava/lang/String;)V
-
getText
Returns the current text of the edit box.- Returns:
- the current text of the edit box
- Mappings:
Namespace Name Mixin selector official p
Leib;p()Ljava/lang/String;
intermediary method_44405
Lnet/minecraft/class_7529;method_44405()Ljava/lang/String;
named getText
Lnet/minecraft/client/gui/widget/EditBoxWidget;getText()Ljava/lang/String;
-
tick
public void tick()- Mappings:
Namespace Name Mixin selector official q
Leib;q()V
intermediary method_44406
Lnet/minecraft/class_7529;method_44406()V
named tick
Lnet/minecraft/client/gui/widget/EditBoxWidget;tick()V
-
appendNarrations
- Mappings:
Namespace Name Mixin selector official a
Lejw;a(Lejv;)V
intermediary method_37020
Lnet/minecraft/class_6383;method_37020(Lnet/minecraft/class_6382;)V
named appendNarrations
Lnet/minecraft/client/gui/Narratable;appendNarrations(Lnet/minecraft/client/gui/screen/narration/NarrationMessageBuilder;)V
-
mouseClicked
public boolean mouseClicked(double mouseX, double mouseY, int button) Callback for when a mouse button down event has been captured. The button number is identified by the constants inGLFW
class.- Specified by:
mouseClicked
in interfaceElement
- Overrides:
mouseClicked
in classScrollableWidget
- Parameters:
mouseX
- the X coordinate of the mousemouseY
- the Y coordinate of the mousebutton
- the mouse button number- Returns:
true
to indicate that the event handling is successful/valid- See Also:
- Mappings:
Namespace Name Mixin selector official a
Leir;a(DDI)Z
intermediary method_25402
Lnet/minecraft/class_364;method_25402(DDI)Z
named mouseClicked
Lnet/minecraft/client/gui/Element;mouseClicked(DDI)Z
-
mouseDragged
public boolean mouseDragged(double mouseX, double mouseY, int button, double deltaX, double deltaY) Callback for when a mouse button drag event has been captured. The button number is identified by the constants inGLFW
class.- Specified by:
mouseDragged
in interfaceElement
- Overrides:
mouseDragged
in classScrollableWidget
- Parameters:
mouseX
- the current X coordinate of the mousemouseY
- the current Y coordinate of the mousebutton
- the mouse button numberdeltaX
- the difference of the current X with the previous X coordinatedeltaY
- the difference of the current Y with the previous Y coordinate- Returns:
true
to indicate that the event handling is successful/valid- See Also:
- Mappings:
Namespace Name Mixin selector official a
Leir;a(DDIDD)Z
intermediary method_25403
Lnet/minecraft/class_364;method_25403(DDIDD)Z
named mouseDragged
Lnet/minecraft/client/gui/Element;mouseDragged(DDIDD)Z
-
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 inGLFW
class.- Parameters:
keyCode
- the named key code of the event as described in theGLFW
classscanCode
- the unique/platform-specific scan code of the keyboard inputmodifiers
- 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:
- Mappings:
Namespace Name Mixin selector official a
Leir;a(III)Z
intermediary method_25404
Lnet/minecraft/class_364;method_25404(III)Z
named keyPressed
Lnet/minecraft/client/gui/Element;keyPressed(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 inGLFW
class.- Parameters:
chr
- the captured charactermodifiers
- 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:
- Mappings:
Namespace Name Mixin selector official a
Leir;a(CI)Z
intermediary method_25400
Lnet/minecraft/class_364;method_25400(CI)Z
named charTyped
Lnet/minecraft/client/gui/Element;charTyped(CI)Z
-
renderContents
Renders the scrolled contents. Subclasses must override this. The rendered contents may overflow; the caller should trim those usingDrawableHelper.enableScissor(int, int, int, int)
.- Specified by:
renderContents
in classScrollableWidget
- Mappings:
Namespace Name Mixin selector official c
Lehk;c(Leaq;IIF)V
intermediary method_44389
Lnet/minecraft/class_7528;method_44389(Lnet/minecraft/class_4587;IIF)V
named renderContents
Lnet/minecraft/client/gui/widget/ScrollableWidget;renderContents(Lnet/minecraft/client/util/math/MatrixStack;IIF)V
-
renderOverlay
Renders overlays that are not scrolled but part of the widget.This renders the scrollbar by default. Subclasses can override this to render other overlays, but
super
call is necessary to make sure the scrollbar renders when it should.- Overrides:
renderOverlay
in classScrollableWidget
- Mappings:
Namespace Name Mixin selector official a
Lehk;a(Leaq;)V
intermediary method_44384
Lnet/minecraft/class_7528;method_44384(Lnet/minecraft/class_4587;)V
named renderOverlay
Lnet/minecraft/client/gui/widget/ScrollableWidget;renderOverlay(Lnet/minecraft/client/util/math/MatrixStack;)V
-
getContentsHeight
public int getContentsHeight()Returns the total height of the contents.- Specified by:
getContentsHeight
in classScrollableWidget
- Returns:
- the total height of the contents
- Mappings:
Namespace Name Mixin selector official e
Lehk;e()I
intermediary method_44391
Lnet/minecraft/class_7528;method_44391()I
named getContentsHeight
Lnet/minecraft/client/gui/widget/ScrollableWidget;getContentsHeight()I
-
overflows
protected boolean overflows()Returns whether the contents overflow and needs a scrollbar.- Specified by:
overflows
in classScrollableWidget
- Returns:
- whether the contents overflow and needs a scrollbar
- Mappings:
Namespace Name Mixin selector official f
Lehk;f()Z
intermediary method_44392
Lnet/minecraft/class_7528;method_44392()Z
named overflows
Lnet/minecraft/client/gui/widget/ScrollableWidget;overflows()Z
-
getDeltaYPerScroll
protected double getDeltaYPerScroll()- Specified by:
getDeltaYPerScroll
in classScrollableWidget
- Mappings:
Namespace Name Mixin selector official g
Lehk;g()D
intermediary method_44393
Lnet/minecraft/class_7528;method_44393()D
named getDeltaYPerScroll
Lnet/minecraft/client/gui/widget/ScrollableWidget;getDeltaYPerScroll()D
-
drawSelection
- Mappings:
Namespace Name Mixin selector official c
Leib;c(Leaq;IIII)V
intermediary method_44403
Lnet/minecraft/class_7529;method_44403(Lnet/minecraft/class_4587;IIII)V
named drawSelection
Lnet/minecraft/client/gui/widget/EditBoxWidget;drawSelection(Lnet/minecraft/client/util/math/MatrixStack;IIII)V
-
onCursorChange
private void onCursorChange()- Mappings:
Namespace Name Mixin selector official r
Leib;r()V
intermediary method_44407
Lnet/minecraft/class_7529;method_44407()V
named onCursorChange
Lnet/minecraft/client/gui/widget/EditBoxWidget;onCursorChange()V
-
getMaxLinesWithoutOverflow
private double getMaxLinesWithoutOverflow()Returns the maximum amount of lines the widget can hold without overflowing.- Returns:
- the maximum amount of lines the widget can hold without overflowing
- Mappings:
Namespace Name Mixin selector official s
Leib;s()D
intermediary method_44408
Lnet/minecraft/class_7529;method_44408()D
named getMaxLinesWithoutOverflow
Lnet/minecraft/client/gui/widget/EditBoxWidget;getMaxLinesWithoutOverflow()D
-
moveCursor
private void moveCursor(double mouseX, double mouseY) - Mappings:
Namespace Name Mixin selector official f
Leib;f(DD)V
intermediary method_44404
Lnet/minecraft/class_7529;method_44404(DD)V
named moveCursor
Lnet/minecraft/client/gui/widget/EditBoxWidget;moveCursor(DD)V
-