Package net.minecraft.client.gui.components

Class MultiLineEditBox

java.lang.Object

net.minecraft.client.gui.components.AbstractWidget

net.minecraft.client.gui.components.AbstractScrollArea

net.minecraft.client.gui.components.AbstractTextAreaWidget

net.minecraft.client.gui.components.MultiLineEditBox

All Implemented Interfaces:

GuiEventListener, Renderable, TabOrderedElement, LayoutElement, NarratableEntry, NarrationSupplier, IAbstractWidgetExtension

public class MultiLineEditBox
extends AbstractTextAreaWidget

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiLineEditBox.Builder

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

NarratableEntry.NarrationPriority

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	CURSOR_APPEND_CHARACTER
private static final int	CURSOR_BLINK_INTERVAL_MS
private static final int	CURSOR_COLOR
private static final int	CURSOR_INSERT_WIDTH
private final int	cursorColor
private long	focusedTime
private final Font	font
private final Component	placeholder
private static final int	PLACEHOLDER_TEXT_COLOR
private static final int	TEXT_COLOR
private final int	textColor
private final MultilineTextField	textField
private final boolean	textShadow

Fields inherited from class net.minecraft.client.gui.components.AbstractTextAreaWidget

DEFAULT_TOTAL_PADDING

Fields inherited from class net.minecraft.client.gui.components.AbstractScrollArea

SCROLLBAR_WIDTH

Fields inherited from class net.minecraft.client.gui.components.AbstractWidget

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

Fields inherited from interface net.minecraft.client.gui.components.events.GuiEventListener

DOUBLE_CLICK_THRESHOLD_MS

Constructor Summary

Constructors

Constructor	Description
MultiLineEditBox(Font font, int x, int y, int width, int height, Component placeholder, Component message, int textColor, boolean textShadow, int cursorColor, boolean showBackground, boolean showDecorations)

Method Summary

Modifier and Type	Method	Description
static MultiLineEditBox.Builder	builder()
boolean	charTyped(char codePoint, int modifiers)	Called when a character is typed within the GUI element.
int	getInnerHeight()
String	getValue()
boolean	keyPressed(int keyCode, int scanCode, int modifiers)	Called when a keyboard key is pressed within the GUI element.
void	onClick(double mouseX, double mouseY)
protected void	onDrag(double mouseX, double mouseY, double dragX, double dragY)
protected void	renderContents(GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick)
protected void	renderDecorations(GuiGraphics guiGraphics)
protected double	scrollRate()
private void	scrollToCursor()
private void	seekCursorScreen(double mouseX, double mouseY)
void	setCharacterLimit(int characterLimit)
void	setFocused(boolean focused)	Sets the focus state of the GUI element.
void	setLineLimit(int lineLimit)
void	setValue(String value)
void	setValue(String value, boolean force)
void	setValueListener(Consumer<String> valueListener)
void	updateWidgetNarration(NarrationElementOutput narrationElementOutput)

Methods inherited from class net.minecraft.client.gui.components.AbstractTextAreaWidget

contentHeight, getInnerLeft, getInnerTop, innerPadding, isMouseOver, mouseClicked, playDownSound, renderBackground, renderBorder, renderWidget, scrollBarX, totalInnerPadding, withinContentAreaTopBottom

Methods inherited from class net.minecraft.client.gui.components.AbstractScrollArea

maxScrollAmount, mouseDragged, mouseScrolled, onRelease, refreshScrollAmount, renderScrollbar, scrollAmount, scrollbarVisible, scrollBarY, scrollerHeight, setScrollAmount, updateScrolling

Methods inherited from class net.minecraft.client.gui.components.AbstractWidget

clearFGColor, createNarrationMessage, defaultButtonNarrationText, getBottom, getFGColor, getHeight, getMessage, getRectangle, getRight, getTabOrderGroup, getWidth, getX, getY, isActive, isFocused, isHovered, isHoveredOrFocused, isValidClickButton, mouseReleased, narrationPriority, nextFocusPath, playButtonClickSound, render, renderScrollingString, renderScrollingString, renderScrollingString, setAlpha, setFGColor, setHeight, setMessage, setRectangle, setSize, setTabOrderGroup, setTooltip, setTooltipDelay, setWidth, setX, setY, updateNarration, visitWidgets, wrapDefaultNarrationMessage

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

getBorderForArrowNavigation, getCurrentFocusPath, keyReleased, mouseMoved

Methods inherited from interface net.neoforged.neoforge.client.extensions.IAbstractWidgetExtension

onClick

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

setPosition

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

getNarratables

Field Details

CURSOR_INSERT_WIDTH

private static final int CURSOR_INSERT_WIDTH

See Also:

• Constant Field Values

CURSOR_COLOR

private static final int CURSOR_COLOR

See Also:

• Constant Field Values

CURSOR_APPEND_CHARACTER

private static final String CURSOR_APPEND_CHARACTER

See Also:

• Constant Field Values

TEXT_COLOR

private static final int TEXT_COLOR

See Also:

• Constant Field Values

PLACEHOLDER_TEXT_COLOR

private static final int PLACEHOLDER_TEXT_COLOR

See Also:

• Constant Field Values

CURSOR_BLINK_INTERVAL_MS

private static final int CURSOR_BLINK_INTERVAL_MS

See Also:

• Constant Field Values

font

private final Font font

placeholder

private final Component placeholder

textField

private final MultilineTextField textField

textColor

private final int textColor

textShadow

private final boolean textShadow

cursorColor

private final int cursorColor

focusedTime

private long focusedTime

Constructor Details

MultiLineEditBox

MultiLineEditBox(Font font,
 int x,
 int y,
 int width,
 int height,
 Component placeholder,
 Component message,
 int textColor,
 boolean textShadow,
 int cursorColor,
 boolean showBackground,
 boolean showDecorations)

Method Details

setCharacterLimit

public void setCharacterLimit(int characterLimit)

setLineLimit

public void setLineLimit(int lineLimit)

setValueListener

public void setValueListener(Consumer<String> valueListener)

setValue

public void setValue(String value)

setValue

public void setValue(String value,
 boolean force)

getValue

public String getValue()

updateWidgetNarration

public void updateWidgetNarration(NarrationElementOutput narrationElementOutput)

Specified by:

updateWidgetNarration in class AbstractWidget

onClick

public void onClick(double mouseX,
 double mouseY)

Overrides:

onClick in class AbstractWidget

onDrag

protected void onDrag(double mouseX,
 double mouseY,
 double dragX,
 double dragY)

Overrides:

onDrag in class AbstractWidget

keyPressed

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

Called when a keyboard key is pressed within the GUI element.

Specified by:

keyPressed in interface GuiEventListener

Overrides:

keyPressed in class AbstractTextAreaWidget

Parameters:

keyCode - the key code of the pressed key.

scanCode - the scan code of the pressed key.

modifiers - the keyboard modifiers.

Returns:

true if the event is consumed, false otherwise.

charTyped

public boolean charTyped(char codePoint,
 int modifiers)

Called when a character is typed within the GUI element.

Parameters:

codePoint - the code point of the typed character.

modifiers - the keyboard modifiers.

Returns:

true if the event is consumed, false otherwise.

renderContents

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

Specified by:

renderContents in class AbstractTextAreaWidget

renderDecorations

protected void renderDecorations(GuiGraphics guiGraphics)

Overrides:

renderDecorations in class AbstractTextAreaWidget

getInnerHeight

public int getInnerHeight()

Specified by:

getInnerHeight in class AbstractTextAreaWidget

scrollRate

protected double scrollRate()

Specified by:

scrollRate in class AbstractScrollArea

scrollToCursor

private void scrollToCursor()

seekCursorScreen

private void seekCursorScreen(double mouseX,
 double mouseY)

setFocused

public void setFocused(boolean focused)

Sets the focus state of the GUI element.

Specified by:

setFocused in interface GuiEventListener

Overrides:

setFocused in class AbstractWidget

Parameters:

focused - true to apply focus, false to remove focus

builder

public static MultiLineEditBox.Builder builder()