Package net.minecraft.client.gui.components

Class MultiLineEditBox

java.lang.Object

net.minecraft.client.gui.components.AbstractWidget

net.minecraft.client.gui.components.AbstractScrollWidget

net.minecraft.client.gui.components.MultiLineEditBox

All Implemented Interfaces:

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

public class MultiLineEditBox
extends AbstractScrollWidget

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
private static final String	CURSOR_APPEND_CHARACTER
private static final int	CURSOR_BLINK_INTERVAL_MS
private static final int	CURSOR_INSERT_COLOR
private static final int	CURSOR_INSERT_WIDTH
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 MultilineTextField	textField

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 pFont, int pX, int pY, int pWidth, int pHeight, Component pPlaceholder, Component pMessage)

Method Summary

Modifier and Type	Method	Description
boolean	charTyped(char pCodePoint, int pModifiers)	Called when a character is typed within the GUI element.
private double	getDisplayableLineCount()
int	getInnerHeight()
String	getValue()
boolean	keyPressed(int pKeyCode, int pScanCode, int pModifiers)	Called when a keyboard key is pressed within the GUI element.
boolean	mouseClicked(double pMouseX, double pMouseY, int pButton)	Called when a mouse button is clicked within the GUI element.
boolean	mouseDragged(double pMouseX, double pMouseY, int pButton, double pDragX, double pDragY)	Called when the mouse is dragged within the GUI element.
protected void	renderContents(GuiGraphics pGuiGraphics, int pMouseX, int pMouseY, float pPartialTick)
protected void	renderDecorations(GuiGraphics pGuiGraphics)
private void	renderHighlight(GuiGraphics pGuiGraphics, int pMinX, int pMinY, int pMaxX, int pMaxY)
protected boolean	scrollbarVisible()
protected double	scrollRate()
private void	scrollToCursor()
private void	seekCursorScreen(double pMouseX, double pMouseY)
void	setCharacterLimit(int pCharacterLimit)
void	setFocused(boolean pFocused)	Sets the focus state of the GUI element.
void	setValue(String pFullText)
void	setValueListener(Consumer<String> pValueListener)
void	updateWidgetNarration(NarrationElementOutput pNarrationElementOutput)

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

getMaxScrollAmount, innerPadding, mouseReleased, mouseScrolled, renderBackground, renderBorder, renderWidget, scrollAmount, scrollbarWidth, setScrollAmount, totalInnerPadding, withinContentAreaPoint, withinContentAreaTopBottom

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

clearFGColor, clicked, createNarrationMessage, defaultButtonNarrationText, getBottom, getFGColor, getHeight, getMessage, getRectangle, getRight, getTabOrderGroup, getTooltip, getWidth, getX, getY, isActive, isFocused, isHovered, isHoveredOrFocused, isMouseOver, isValidClickButton, narrationPriority, nextFocusPath, onClick, onDrag, onRelease, playDownSound, 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

getCurrentFocusPath, getRectangle, isFocused, isMouseOver, keyReleased, mouseMoved, nextFocusPath

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.components.Renderable

render

Methods inherited from interface net.minecraft.client.gui.components.TabOrderedElement

getTabOrderGroup

Field Details

CURSOR_INSERT_WIDTH

private static final int CURSOR_INSERT_WIDTH

See Also:

• Constant Field Values

CURSOR_INSERT_COLOR

private static final int CURSOR_INSERT_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

focusedTime

private long focusedTime

Constructor Details

MultiLineEditBox

public MultiLineEditBox(Font pFont,
 int pX,
 int pY,
 int pWidth,
 int pHeight,
 Component pPlaceholder,
 Component pMessage)

Method Details

setCharacterLimit

public void setCharacterLimit(int pCharacterLimit)

setValueListener

public void setValueListener(Consumer<String> pValueListener)

setValue

public void setValue(String pFullText)

getValue

public String getValue()

updateWidgetNarration

public void updateWidgetNarration(NarrationElementOutput pNarrationElementOutput)

Specified by:

updateWidgetNarration in class AbstractWidget

mouseClicked

public boolean mouseClicked(double pMouseX,
 double pMouseY,
 int pButton)

Description copied from class: AbstractWidget

Called when a mouse button is clicked within the GUI element.

Specified by:

mouseClicked in interface GuiEventListener

Overrides:

mouseClicked in class AbstractScrollWidget

Parameters:

pMouseX - the X coordinate of the mouse.

pMouseY - the Y coordinate of the mouse.

pButton - the button that was clicked.

Returns:

true if the event is consumed, false otherwise.

mouseDragged

public boolean mouseDragged(double pMouseX,
 double pMouseY,
 int pButton,
 double pDragX,
 double pDragY)

Description copied from class: AbstractWidget

Called when the mouse is dragged within the GUI element.

Specified by:

mouseDragged in interface GuiEventListener

Overrides:

mouseDragged in class AbstractScrollWidget

Parameters:

pMouseX - the X coordinate of the mouse.

pMouseY - the Y coordinate of the mouse.

pButton - the button that is being dragged.

pDragX - the X distance of the drag.

pDragY - the Y distance of the drag.

Returns:

true if the event is consumed, false otherwise.

keyPressed

public boolean keyPressed(int pKeyCode,
 int pScanCode,
 int pModifiers)

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

Specified by:

keyPressed in interface GuiEventListener

Overrides:

keyPressed in class AbstractScrollWidget

Parameters:

pKeyCode - the key code of the pressed key.

pScanCode - the scan code of the pressed key.

pModifiers - the keyboard modifiers.

Returns:

true if the event is consumed, false otherwise.

charTyped

public boolean charTyped(char pCodePoint,
 int pModifiers)

Called when a character is typed within the GUI element.

Parameters:

pCodePoint - the code point of the typed character.

pModifiers - the keyboard modifiers.

Returns:

true if the event is consumed, false otherwise.

renderContents

protected void renderContents(GuiGraphics pGuiGraphics,
 int pMouseX,
 int pMouseY,
 float pPartialTick)

Specified by:

renderContents in class AbstractScrollWidget

renderDecorations

protected void renderDecorations(GuiGraphics pGuiGraphics)

Overrides:

renderDecorations in class AbstractScrollWidget

getInnerHeight

public int getInnerHeight()

Specified by:

getInnerHeight in class AbstractScrollWidget

scrollbarVisible

protected boolean scrollbarVisible()

Overrides:

scrollbarVisible in class AbstractScrollWidget

scrollRate

protected double scrollRate()

Specified by:

scrollRate in class AbstractScrollWidget

renderHighlight

private void renderHighlight(GuiGraphics pGuiGraphics,
 int pMinX,
 int pMinY,
 int pMaxX,
 int pMaxY)

scrollToCursor

private void scrollToCursor()

getDisplayableLineCount

private double getDisplayableLineCount()

seekCursorScreen

private void seekCursorScreen(double pMouseX,
 double pMouseY)

setFocused

public void setFocused(boolean pFocused)

Sets the focus state of the GUI element.

Specified by:

setFocused in interface GuiEventListener

Overrides:

setFocused in class AbstractWidget

Parameters:

pFocused - true to apply focus, false to remove focus