Class TLabelElement

java.lang.Object

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

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

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

All Implemented Interfaces:

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

@Environment(CLIENT)
public final class TLabelElement
extends TElement

A TElement that draws text on the screen.

Field Summary

Fields inherited from class TElement

eInitialized

Constructor Summary

Constructors

Constructor	Description
TLabelElement()
TLabelElement(@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 TLabelElement's Font.
final @NotNull net.minecraft.network.chat.Component	getText()	Convenience method for getting the value of textProperty().
final int	getTextHeight()	Returns the height this TLabelElement would need, to fit all lines of text it has.
final int	getTextWidth()	Returns the width this TLabelElement would need, to fit all lines of text it has.
protected final void	initCallback()	Callback method that is invoked when this TElement is initializing.
final IntegerProperty	lineSpacingProperty()	An IntegerProperty for the spacing between lines of text.
void	postRenderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked after this Node and all of their children have been rendered.
final void	refresh()	Refreshes this TLabelElement.
final void	renderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked when this Node is being rendered.
final void	setBoundsToFitText(int maxWidth)	Sets this TLabelElement's bounds to fit its text, given a maximum width.
final void	setBoundsToFitText(int x, int y, int maxWidth)	Sets this TLabelElement's bounds to fit its text, given a maximum width.
final void	setText(@NotNull net.minecraft.network.chat.Component text)	Convenience method for setting the value of textProperty().
final NotNullProperty<CompassDirection>	textAlignmentProperty()	A NotNullProperty for the horizontal and vertical alignment of text.
final IntegerProperty	textColorProperty()	An IntegerProperty for the color of the text that will be rendered.
final NotNullProperty<net.minecraft.network.chat.Component>	textProperty()	A NotNullProperty for this TLabelElement's text.
final DoubleProperty	textScaleProperty()	A DoubleProperty for the visual scale of the text.
final BooleanProperty	wrapTextProperty()	A BooleanProperty for whether the text should be wrapped.

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, 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

TLabelElement

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

TLabelElement

public TLabelElement()

Method Details

textProperty

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

A NotNullProperty for this TLabelElement's text.

fontProperty

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

A NotNullProperty for this TLabelElement's Font.

lineSpacingProperty

public final IntegerProperty lineSpacingProperty()

An IntegerProperty for the spacing between lines of text.

textColorProperty

public final IntegerProperty textColorProperty()

An IntegerProperty for the color of the text that will be rendered.

wrapTextProperty

public final BooleanProperty wrapTextProperty()

A BooleanProperty for whether the text should be wrapped.

API Note:

Wikipedia article

textAlignmentProperty

public final NotNullProperty<CompassDirection> textAlignmentProperty()

A NotNullProperty for the horizontal and vertical alignment of text.

textScaleProperty

public final DoubleProperty textScaleProperty()

A DoubleProperty for the visual scale of the text.

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.

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 TElement

Parameters:

pencil - The rendering context.

refresh

public final void refresh()

Refreshes this TLabelElement. This may be called in the event a property was updated without triggering change listeners.

getText

@NotNull
public final @NotNull net.minecraft.network.chat.Component getText()

Convenience method for getting the value of textProperty().

Returns:

The current textProperty() value.

setText

public final void setText(@NotNull
 @NotNull net.minecraft.network.chat.Component text)

Convenience method for setting the value of textProperty().

Parameters:

text - The new textProperty() value.

setBoundsToFitText

public final void setBoundsToFitText(int maxWidth)

Sets this TLabelElement's bounds to fit its text, given a maximum width.

Parameters:

maxWidth - The maximum width the bounds can have.

setBoundsToFitText

public final void setBoundsToFitText(int x,
 int y,
 int maxWidth)

Sets this TLabelElement's bounds to fit its text, given a maximum width.

Parameters:

x - The x position to set the bounds to.

y - The y position to set the bounds to.

maxWidth - The maximum width the bounds can have.

getTextWidth

public final int getTextWidth()

Returns the width this TLabelElement would need, to fit all lines of text it has. This accounts for textScaleProperty() value as well.

Note: If you have wrapTextProperty() enabled, this will likely return a value that's around the width of this TLabelElement.

See Also:

• TElement.getBounds()

API Note:

Relies on this TLabelElement's bounding box.

getTextHeight

public final int getTextHeight()

Returns the height this TLabelElement would need, to fit all lines of text it has. This accounts for textScaleProperty() value as well.

See Also:

• TElement.getBounds()

API Note:

Relies on this TLabelElement's bounding box.