Package io.github.cottonmc.cotton.gui.widget

Class WDynamicLabel

java.lang.Object

io.github.cottonmc.cotton.gui.widget.WWidget

io.github.cottonmc.cotton.gui.widget.WDynamicLabel

public class WDynamicLabel
extends WWidget

Dynamic labels are labels that pull their text from a Supplier<String>. They can be used for automatically getting data from a block entity or another data source.

Translating strings in dynamic labels should be done using I18n.translate(String, Object...).

Field Summary

Fields

Modifier and Type	Field	Description
protected HorizontalAlignment	alignment
protected int	color
protected int	darkmodeColor
static final int	DEFAULT_DARKMODE_TEXT_COLOR
static final int	DEFAULT_TEXT_COLOR
protected Supplier<String>	text

Fields inherited from class io.github.cottonmc.cotton.gui.widget.WWidget

height, host, parent, width, x, y

Constructor Summary

Constructors

Constructor	Description
WDynamicLabel(Supplier<String> text)
WDynamicLabel(Supplier<String> text, int color)

Method Summary

Modifier and Type	Method	Description
boolean	canResize()	Checks whether this widget can be resized using WWidget.setSize(int, int).
WDynamicLabel	disableDarkmode()
void	paint(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int mouseX, int mouseY)	Paints this widget.
WDynamicLabel	setAlignment(HorizontalAlignment align)
WDynamicLabel	setColor(int color, int darkmodeColor)
WDynamicLabel	setDarkmodeColor(int color)
void	setSize(int x, int y)	Sets the size of this widget.
WDynamicLabel	setText(Supplier<String> text)

Methods inherited from class io.github.cottonmc.cotton.gui.widget.WWidget

addNarrations, addPainters, addTooltip, canFocus, canHover, cycleFocus, getAbsoluteX, getAbsoluteY, getHeight, getHost, getParent, getWidth, getX, getY, hit, hoveredProperty, isActivationKey, isFocused, isHovered, isNarratable, isWithinBounds, onCharTyped, onClick, onFocusGained, onFocusLost, onHidden, onKeyPressed, onKeyReleased, onMouseDown, onMouseDrag, onMouseMove, onMouseScroll, onMouseUp, onShown, releaseFocus, renderTooltip, requestFocus, setHost, setHovered, setLocation, setParent, tick, validate

Methods inherited from class java.lang.Object

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

Field Details

text

protected Supplier<String> text

alignment

protected HorizontalAlignment alignment

color

protected int color

darkmodeColor

protected int darkmodeColor

DEFAULT_TEXT_COLOR

public static final int DEFAULT_TEXT_COLOR

See Also:

• Constant Field Values

DEFAULT_DARKMODE_TEXT_COLOR

public static final int DEFAULT_DARKMODE_TEXT_COLOR

See Also:

• Constant Field Values

Constructor Details

WDynamicLabel

public WDynamicLabel(Supplier<String> text,
 int color)

WDynamicLabel

public WDynamicLabel(Supplier<String> text)

Method Details

paint

@Environment(CLIENT)
public void paint(net.minecraft.client.util.math.MatrixStack matrices,
 int x,
 int y,
 int mouseX,
 int mouseY)

Description copied from class: WWidget

Paints this widget.

Overrides:

paint in class WWidget

Parameters:

matrices - the rendering matrix stack

x - this widget's X coordinate on the screen

y - this widget's Y coordinate on the screen

mouseX - the X coordinate of the cursor

mouseY - the X coordinate of the cursor

canResize

public boolean canResize()

Description copied from class: WWidget

Checks whether this widget can be resized using WWidget.setSize(int, int).

Overrides:

canResize in class WWidget

Returns:

true if this widget can be resized, false otherwise

setSize

public void setSize(int x,
 int y)

Description copied from class: WWidget

Sets the size of this widget.

Overriding methods may restrict one of the dimensions to be a constant value, for example super.setSize(x, 20).

Overrides:

setSize in class WWidget

Parameters:

x - the new width

y - the new height

setDarkmodeColor

public WDynamicLabel setDarkmodeColor(int color)

disableDarkmode

public WDynamicLabel disableDarkmode()

setColor

public WDynamicLabel setColor(int color,
 int darkmodeColor)

setText

public WDynamicLabel setText(Supplier<String> text)

setAlignment

public WDynamicLabel setAlignment(HorizontalAlignment align)