Package io.github.thecsdev.tcdcommons.api.client.gui.widget

Class TTextFieldWidget

java.lang.Object

io.github.thecsdev.tcdcommons.api.client.gui.TElement

io.github.thecsdev.tcdcommons.api.client.gui.widget.TClickableWidget

io.github.thecsdev.tcdcommons.api.client.gui.widget.TTextFieldWidget

All Implemented Interfaces:

TParentElement, ITooltipProvider, IEnableStateProvider, IEnableStateProviderSetter, ITextProvider, ITextProviderSetter

Direct Known Subclasses:

ActionBar.FileNameInputField

public class TTextFieldWidget
extends TClickableWidget
implements ITextProviderSetter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TTextFieldWidget.TTextFieldWidgetEvent_TextChanged

Nested classes/interfaces inherited from class io.github.thecsdev.tcdcommons.api.client.gui.widget.TClickableWidget

TClickableWidget.TClickableWidgetEvent_Clicked

Nested classes/interfaces inherited from class io.github.thecsdev.tcdcommons.api.client.gui.TElement

TElement.TElementEvent_ChildAR, TElement.TElementEvent_ContextMenu, TElement.TElementEvent_Moved, TElement.TElementEvent_ParentChanged, TElement.TElementEvent_Resized

Field Summary

Fields

Modifier and Type	Field	Description
protected net.minecraft.text.Text	__displayText
protected int	__displayTextWidth
protected net.minecraft.text.Text	__placeholderText
protected String	__text
final TEvent<TTextFieldWidget.TTextFieldWidgetEvent_TextChanged>	eTextChanged

Fields inherited from class io.github.thecsdev.tcdcommons.api.client.gui.widget.TClickableWidget

BUTTON_TEXTURE_SLICE_SIZE, BUTTON_TEXTURES, eClicked, enabled, T_WIDGETS_TEXTURE

Fields inherited from class io.github.thecsdev.tcdcommons.api.client.gui.TElement

alpha, eChildAdded, eChildRemoved, eContextMenu, eMoved, eParentChanged, eResized, height, SP_ALL, SP_INVOKE_EVENT, SP_MOVE_CHILDREN, SP_RELATIVE, SP_UPDATE_TOPMOST, SS_ALL, SS_INVOKE_EVENT, SS_UPDATE_TOPMOST, tooltip, tooltipPositioner, width, x, y, zOffset

Fields inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.TParentElement

MAX_CHILD_NESTING_DEPTH

Constructor Summary

Constructors

Constructor	Description
TTextFieldWidget(int x, int y, int width, int height)

Method Summary

Modifier and Type	Method	Description
final String	getInput()
final @Nullable net.minecraft.text.Text	getPlaceholderText()
final net.minecraft.text.Text	getText()	Deprecated.
boolean	input(TInputContext inputContext)	An input handler that handles inputs on the TInputContext.InputDiscoveryPhase.MAIN input phase.
final boolean	inputBackspace(boolean isDelete)	Inputs a single backspace/delete key command, erasing a single Character from the getInput() text.
final boolean	inputChar(char character)	Writes a single Character to the getInput() text.
boolean	inputText(String text)	Writes a String of text to the getInput() text.
boolean	isCharacterAllowed(char c)	Returns true if a given Character is allowed to be typed into this TTextFieldWidget by the user.
boolean	isFocusable()
protected void	onClick()	Called when this TClickableWidget is clicked, either by a mouse or a keyboard input, or by TClickableWidget.click(boolean).
void	postRender(TDrawContext pencil)
void	render(TDrawContext pencil)	Renders this GUI element on the screen.
protected void	renderText(TDrawContext pencil)	Renders the input text of this TTextFieldWidget.
protected String	sanitizeInput(String input)	Sanitizes an input String that is being set as the input text for this TTextFieldWidget.
final void	setInput(String text)
final void	setInput(String text, boolean invokeEvent)
final void	setPlaceholderText(@Nullable net.minecraft.text.Text text)
final void	setText(net.minecraft.text.Text text)	Deprecated.

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.widget.TClickableWidget

click, getEnabled, setEnabled

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.TElement

canBeAddedTo, createContextMenu, getAlpha, getChildren, getHeight, getItemRenderer, getParent, getParentTElement, getParentTScreen, getTextRenderer, getTooltip, getTooltipPositioner, getWidth, getX, getY, getZIndex, getZOffset, isDragging, isEnabled, isEnabledAndVisible, isFocused, isFocusedOrHovered, isHoverable, isHovered, isVisible, move, moveChildren, next, previous, setAlpha, setPosition, setPosition, setSize, setSize, setTooltip, setZOffset, tick, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.TParentElement

addChild, addChild, clearChildren, findChild, findLastChild, findParent, findParentTElement, forEachChild, getEndX, getEndY, input, removeChild, removeChild

Field Details

__text

protected String __text

__displayText

protected net.minecraft.text.Text __displayText

__displayTextWidth

protected int __displayTextWidth

__placeholderText

protected net.minecraft.text.Text __placeholderText

eTextChanged

public final TEvent<TTextFieldWidget.TTextFieldWidgetEvent_TextChanged> eTextChanged

Constructor Details

TTextFieldWidget

public TTextFieldWidget(int x,
 int y,
 int width,
 int height)

Method Details

isFocusable

public boolean isFocusable()

Overrides:

isFocusable in class TClickableWidget

onClick

protected void onClick()

Description copied from class: TClickableWidget

Called when this TClickableWidget is clicked, either by a mouse or a keyboard input, or by TClickableWidget.click(boolean).

Specified by:

onClick in class TClickableWidget

getText

@Deprecated
public final net.minecraft.text.Text getText()

Deprecated.

Important note: This returns the display text for this TTextFieldWidget.

To see the user input text, use getInput().

Specified by:

getText in interface ITextProvider

See Also:

• getInput()

setText

@Deprecated
public final void setText(net.minecraft.text.Text text)

Deprecated.

Specified by:

setText in interface ITextProviderSetter

getInput

public final String getInput()

setInput

public final void setInput(String text)

setInput

public final void setInput(String text,
 boolean invokeEvent)

getPlaceholderText

@Nullable
public final @Nullable net.minecraft.text.Text getPlaceholderText()

setPlaceholderText

public final void setPlaceholderText(@Nullable
 @Nullable net.minecraft.text.Text text)

sanitizeInput

protected String sanitizeInput(String input)

Sanitizes an input String that is being set as the input text for this TTextFieldWidget.

isCharacterAllowed

public boolean isCharacterAllowed(char c)

Returns true if a given Character is allowed to be typed into this TTextFieldWidget by the user.

Parameters:

c - The Character being checked.

input

public boolean input(TInputContext inputContext)

Description copied from interface: TParentElement

An input handler that handles inputs on the TInputContext.InputDiscoveryPhase.MAIN input phase.

Specified by:

input in interface TParentElement

Overrides:

input in class TClickableWidget

Parameters:

inputContext - The TInputContext containing information about a given input.

See Also:

• TParentElement.input(TInputContext, TInputContext.InputDiscoveryPhase)

inputChar

public final boolean inputChar(char character)

Writes a single Character to the getInput() text.

Parameters:

character - The Character to write.

inputText

public boolean inputText(String text)

Writes a String of text to the getInput() text.

Parameters:

text - The String of text to write.

inputBackspace

public final boolean inputBackspace(boolean isDelete)

Inputs a single backspace/delete key command, erasing a single Character from the getInput() text.

Parameters:

isDelete - If true, the delete key is used; If false, the backspace key is used;

render

public void render(TDrawContext pencil)

Description copied from interface: TParentElement

Renders this GUI element on the screen.

Specified by:

render in interface TParentElement

Specified by:

render in class TElement

Parameters:

pencil - The TDrawContext.

renderText

protected void renderText(TDrawContext pencil)

Renders the input text of this TTextFieldWidget.

Parameters:

pencil - The TDrawContext.

See Also:

• getText()
• getInput()

postRender

public void postRender(TDrawContext pencil)

Overrides:

postRender in class TElement