io.github.cottonmc.cotton.gui.widget

Class WLabel

java.lang.Object

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

io.github.cottonmc.cotton.gui.widget.WLabel

public class WLabel
extends WWidget

A single-line label widget.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	color
protected int	darkmodeColor
static int	DEFAULT_DARKMODE_TEXT_COLOR The default text color for dark mode labels.
static int	DEFAULT_TEXT_COLOR The default text color for light mode labels.
protected HorizontalAlignment	horizontalAlignment
protected net.minecraft.text.Text	text
protected VerticalAlignment	verticalAlignment

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

height, host, parent, width, x, y

Constructor Summary

Constructors

Constructor and Description
WLabel(java.lang.String text) Constructs a new label with the default text color.
WLabel(java.lang.String text, int color) Constructs a new label.
WLabel(net.minecraft.text.Text text) Constructs a new label with the default text color.
WLabel(net.minecraft.text.Text text, int color) Constructs a new label.

Method Summary

Modifier and Type	Method and Description
boolean	canResize() Checks whether this widget can be resized using WWidget.setSize(int, int).
WLabel	disableDarkmode() Disables separate dark mode coloring by copying the dark color to be the light color.
int	getColor() Gets the light mode color of this label.
int	getDarkmodeColor() Gets the dark mode color of this label.
HorizontalAlignment	getHorizontalAlignment() Gets the horizontal text alignment of this label.
net.minecraft.text.Text	getText() Gets the text of this label.
@Nullable net.minecraft.text.Style	getTextStyleAt(int x, int y) Gets the text style at the specific widget-space coordinates.
VerticalAlignment	getVerticalAlignment() Gets the vertical text alignment of this label.
InputResult	onClick(int x, int y, int button) Notifies this widget that the mouse has been pressed and released, both while inside its bounds.
void	paint(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int mouseX, int mouseY) Paints this widget.
WLabel	setColor(int color) Sets the light mode color of this label.
WLabel	setColor(int color, int darkmodeColor) Sets the light and dark mode colors of this label.
WLabel	setDarkmodeColor(int color) Sets the dark mode color of this label.
WLabel	setHorizontalAlignment(HorizontalAlignment align) Sets the horizontal text alignment of this label.
void	setSize(int x, int y) Sets the size of this widget.
WLabel	setText(net.minecraft.text.Text text) Sets the text of this label.
WLabel	setVerticalAlignment(VerticalAlignment align) Sets the vertical text alignment of this label.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

text

protected net.minecraft.text.Text text

horizontalAlignment

protected HorizontalAlignment horizontalAlignment

verticalAlignment

protected VerticalAlignment verticalAlignment

color

protected int color

darkmodeColor

protected int darkmodeColor

DEFAULT_TEXT_COLOR

public static final int DEFAULT_TEXT_COLOR

The default text color for light mode labels.

See Also:

Constant Field Values

DEFAULT_DARKMODE_TEXT_COLOR

public static final int DEFAULT_DARKMODE_TEXT_COLOR

The default text color for dark mode labels.

See Also:

Constant Field Values

Constructor Detail

WLabel

public WLabel(java.lang.String text,
              int color)

Constructs a new label.

Parameters:

text - the text of the label

color - the color of the label

WLabel

public WLabel(net.minecraft.text.Text text,
              int color)

Constructs a new label.

Parameters:

text - the text of the label

color - the color of the label

WLabel

public WLabel(java.lang.String text)

Constructs a new label with the default text color.

Parameters:

text - the text of the label

WLabel

public WLabel(net.minecraft.text.Text text)

Constructs a new label with the default text color.

Parameters:

text - the text of the label

Since:

1.8.0

Method Detail

paint

@Environment(value=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

onClick

@Environment(value=CLIENT)
public InputResult onClick(int x,
                                                       int y,
                                                       int button)

Description copied from class: WWidget

Notifies this widget that the mouse has been pressed and released, both while inside its bounds.

Overrides:

onClick in class WWidget

Parameters:

x - The X coordinate of the event, in widget-space (0 is the left edge of this widget)

y - The Y coordinate of the event, in widget-space (0 is the top edge of this widget)

button - The mouse button that was used. Button numbering is consistent with LWJGL Mouse (0=left, 1=right, 2=mousewheel click)

Returns:

InputResult.PROCESSED if the event is handled, InputResult.IGNORED otherwise.

getTextStyleAt

@Environment(value=CLIENT)
 @Nullable
public @Nullable net.minecraft.text.Style getTextStyleAt(int x,
                                                                                                 int y)

Gets the text style at the specific widget-space coordinates.

Parameters:

x - the X coordinate in widget space

y - the Y coordinate in widget space

Returns:

the text style at the position, or null if not found

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

getDarkmodeColor

public int getDarkmodeColor()

Gets the dark mode color of this label.

Returns:

the color

Since:

2.0.0

setDarkmodeColor

public WLabel setDarkmodeColor(int color)

Sets the dark mode color of this label.

Parameters:

color - the new color

Returns:

this label

disableDarkmode

public WLabel disableDarkmode()

Disables separate dark mode coloring by copying the dark color to be the light color.

Returns:

this label

getColor

public int getColor()

Gets the light mode color of this label.

Returns:

the color

setColor

public WLabel setColor(int color)

Sets the light mode color of this label.

Parameters:

color - the new color

Returns:

this label

setColor

public WLabel setColor(int color,
                       int darkmodeColor)

Sets the light and dark mode colors of this label.

Parameters:

color - the new light color

darkmodeColor - the new dark color

Returns:

this label

getText

public net.minecraft.text.Text getText()

Gets the text of this label.

Returns:

the text

setText

public WLabel setText(net.minecraft.text.Text text)

Sets the text of this label.

Parameters:

text - the new text

Returns:

this label

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()

Gets the horizontal text alignment of this label.

Returns:

the alignment

Since:

2.0.0

setHorizontalAlignment

public WLabel setHorizontalAlignment(HorizontalAlignment align)

Sets the horizontal text alignment of this label.

Parameters:

align - the new text alignment

Returns:

this label

getVerticalAlignment

public VerticalAlignment getVerticalAlignment()

Gets the vertical text alignment of this label.

Returns:

the alignment

Since:

2.0.0

setVerticalAlignment

public WLabel setVerticalAlignment(VerticalAlignment align)

Sets the vertical text alignment of this label.

Parameters:

align - the new text alignment

Returns:

this label