Class TStretchedTextElement

java.lang.Object

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

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

com.thecsdev.commonmc.api.client.gui.label.TStretchedTextElement

All Implemented Interfaces:

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

@Environment(CLIENT)
public final class TStretchedTextElement
extends TElement

An element that renders a given text Component such that it is stretched to fit this element's TElement.getBounds().

Field Summary

Fields inherited from class TElement

eInitialized

Constructor Summary

Constructors

Constructor	Description
TStretchedTextElement()
TStretchedTextElement(@NotNull net.minecraft.network.chat.Component text)

Method Summary

Modifier and Type	Method	Description
final BooleanProperty	dropShadowProperty()	A BooleanProperty for whether the text should have a 'shadow' when rendered.
final NotNullProperty<net.minecraft.client.gui.Font>	fontProperty()	A NotNullProperty for this TStretchedTextElement's Font.
protected final void	initCallback()	Callback method that is invoked when this TElement is initializing.
final void	renderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked when this Node is being rendered.
final @NotNull IntegerProperty	textColorProperty()	Returns the IntegerProperty that stores the color used to render the text Component.
final @NotNull NotNullProperty<net.minecraft.network.chat.Component>	textProperty()	Returns the NotNullProperty that stores the text Component to be rendered by this element.
final @NotNull NotNullProperty<Point2d>	textScaleProperty()	Returns the NotNullProperty that stores the scale factor used when rendering the text Component.

Methods inherited from class TElement

addRel, boundsProperty, clearAndInit, clipsDescendantsProperty, contextMenuProperty, dragEndCallback, dragStartCallback, findElementAt, focusableProperty, focusGainedCallback, focusLostCallback, forEachVisible, getBaseType, getBounds, getClient, getContentBounds, getCursor, getSelf, getTooltip, hoverableProperty, hoverGainedCallback, hoverLostCallback, inputCallback, invalidateTooltipCache, isFocusable, isFocused, isHoverable, isHovered, isHoveredOrFocused, isVisible, move, moveChildren, moveTo, postRenderCallback, 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

TStretchedTextElement

public TStretchedTextElement()

TStretchedTextElement

public TStretchedTextElement(@NotNull
 @NotNull net.minecraft.network.chat.Component text)

Method Details

textProperty

@NotNull
public final @NotNull NotNullProperty<net.minecraft.network.chat.Component> textProperty()

Returns the NotNullProperty that stores the text Component to be rendered by this element.

fontProperty

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

A NotNullProperty for this TStretchedTextElement's Font.

textColorProperty

@NotNull
public final @NotNull IntegerProperty textColorProperty()

Returns the IntegerProperty that stores the color used to render the text Component.

textScaleProperty

@NotNull
public final @NotNull NotNullProperty<Point2d> textScaleProperty()

Returns the NotNullProperty that stores the scale factor used when rendering the text Component.

API Note:

Neither axis should have its scale value set to 0!

dropShadowProperty

public final BooleanProperty dropShadowProperty()

A BooleanProperty for whether the text should have a 'shadow' when rendered.

Since:

5.3.0

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

public final 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.