Class TSimpleTextFieldWidget

java.lang.Object

com.thecsdev.common.scene.Node<TElement>

com.thecsdev.commonmc.api.client.gui.TElement

com.thecsdev.commonmc.api.client.gui.widget.TClickableWidget

com.thecsdev.commonmc.api.client.gui.widget.text.TSimpleTextFieldWidget

All Implemented Interfaces:

INode<TElement>, INodeBounded<TElement,Bounds2i>, INodeRenderable<TElement, TGuiGraphics>, Iterable<TElement>, Collection<TElement>

@Environment(CLIENT)
public final class TSimpleTextFieldWidget
extends TClickableWidget

Text input widget where the user may type in text. Very minimal and does not feature the concept of cursors and multiline support.

API Note:

Uses unoptimal practices that cost extra memory and performance.

Field Summary

Fields inherited from class TClickableWidget

eClicked, ONCLICK_SOUND

Fields inherited from class TElement

eInitialized

Constructor Summary

Constructors

Constructor	Description
TSimpleTextFieldWidget()

Method Summary

Modifier and Type	Method	Description
final NotNullProperty<net.minecraft.client.gui.Font>	fontProperty()	The NotNullProperty for this TSimpleTextFieldWidget's Font used for text rendering.
@NotNull CursorType	getCursor()	Returns CursorType that represents the visual look the user's mouse cursor should have when this TElement is hovered.
final TLabelElement	getPlaceholderLabel()	Returns the TLabelElement that displays the placeholder text. Your access to this label is intended for label property changing only!
final TLabelElement	getTextLabel()	Returns the TLabelElement that displays the user-typed text. Your access to this label is intended for label property changing only!
protected final void	initCallback()	Callback method that is invoked when this TElement is initializing.
final boolean	inputBackspace(int amount)	Inputs backspace.
final boolean	inputCallback(@NotNull TInputContext.InputDiscoveryPhase phase, @NotNull TInputContext context)	A callback method that is invoked when the user makes an input.
final boolean	inputText(@NotNull String text)	Inputs a textual String.
final NotNullProperty<net.minecraft.network.chat.Component>	placeholderProperty()	The NotNullProperty for this TSimpleTextFieldWidget's placeholder text that is rendered when the user has yet to input (type) something.
void	postRenderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked after this Node and all of their children have been rendered.
void	renderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked when this Node is being rendered.
final NotNullProperty<String>	textProperty()	The NotNullProperty holding this TSimpleTextFieldWidget's text the user typed in.

Methods inherited from class TClickableWidget

click, clickCallback, dragEndCallback, dragStartCallback, enabledProperty, focusLostCallback, hoverGainedCallback, isFocusable, pressedProperty

Methods inherited from class TElement

addRel, boundsProperty, clearAndInit, clipsDescendantsProperty, contextMenuProperty, findElementAt, focusableProperty, focusGainedCallback, forEachVisible, getBaseType, getBounds, getClient, getContentBounds, getSelf, getTooltip, hoverableProperty, hoverLostCallback, invalidateTooltipCache, isFocused, isHoverable, isHovered, isHoveredOrFocused, isVisible, move, moveChildren, moveTo, removeRel, screenProperty, setBounds, setBounds, setBounds, showContextMenu, tickCallback, tooltipProperty, toString, visibleProperty

Methods inherited from class Node

add, addAll, childAddedCallback, childRemovedCallback, clear, contains, containsAll, equals, findChild, findParent, findSibling, forEach, get, getFirst, getLast, getParent, hashCode, indexOf, isEmpty, iterator, parentProperty, remove, remove, remove, removeAll, retainAll, rootProperty, size, toArray, toArray

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface Iterable

forEach

Constructor Details

TSimpleTextFieldWidget

public TSimpleTextFieldWidget()

Method Details

textProperty

public final NotNullProperty<String> textProperty()

The NotNullProperty holding this TSimpleTextFieldWidget's text the user typed in.

fontProperty

public final NotNullProperty<net.minecraft.client.gui.Font> fontProperty()

The NotNullProperty for this TSimpleTextFieldWidget's Font used for text rendering.

placeholderProperty

public final NotNullProperty<net.minecraft.network.chat.Component> placeholderProperty()

The NotNullProperty for this TSimpleTextFieldWidget's placeholder text that is rendered when the user has yet to input (type) something.

getTextLabel

public final TLabelElement getTextLabel()

Returns the TLabelElement that displays the user-typed text.
Your access to this label is intended for label property changing only!

getPlaceholderLabel

public final TLabelElement getPlaceholderLabel()

Returns the TLabelElement that displays the placeholder text.
Your access to this label is intended for label property changing only!

getCursor

@Virtual
@NotNull
public @NotNull CursorType getCursor()

Description copied from class: TElement

Returns CursorType that represents the visual look the user's mouse cursor should have when this TElement is hovered.

Overrides:

getCursor in class TClickableWidget

initCallback

protected final void initCallback()

Description copied from class: TElement

Callback method that is invoked when this TElement is initializing. You may override this method to create and add child TElements.

Overrides:

initCallback in class TElement

See Also:

• TElement.clearAndInit()

renderCallback

@Virtual
public void renderCallback(@NotNull
 @NotNull TGuiGraphics pencil)

Description copied from interface: INodeRenderable

Callback method that is invoked when this Node is being rendered.

Specified by:

renderCallback in interface INodeRenderable<TElement, TGuiGraphics>

Overrides:

renderCallback in class TElement

Parameters:

pencil - The rendering context.

postRenderCallback

@Virtual
public void postRenderCallback(@NotNull
 @NotNull TGuiGraphics pencil)

Description copied from interface: INodeRenderable

Callback method that is invoked after this Node and all of their children have been rendered.

Specified by:

postRenderCallback in interface INodeRenderable<TElement, TGuiGraphics>

Overrides:

postRenderCallback in class TClickableWidget

Parameters:

pencil - The rendering context.

inputCallback

public final boolean inputCallback(@NotNull TInputContext.InputDiscoveryPhase phase,
 @NotNull
 @NotNull TInputContext context)

Description copied from class: TElement

A callback method that is invoked when the user makes an input.

Overrides:

inputCallback in class TClickableWidget

Parameters:

phase - The input discovery phase.

context - Information about the user's input.

Returns:

true if this TElement handled the input.

inputText

public final boolean inputText(@NotNull
 @NotNull String text)

Inputs a textual String.

Parameters:

text - The text to insert.

Returns:

true if the text changed as a result of this operation.

inputBackspace

public final boolean inputBackspace(int amount)

Inputs backspace.

Parameters:

amount - The amount of times to input backspace.

Returns:

true if the text changed as a result of this operation.