io.github.cottonmc.cotton.gui.widget

Class WText

java.lang.Object

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

io.github.cottonmc.cotton.gui.widget.WText

public class WText
extends WWidget

A multiline label widget.

Since:

1.8.0

Field Summary

Fields

Modifier and Type	Field and Description
protected int	color
protected int	darkmodeColor
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
WText(net.minecraft.text.Text text)
WText(net.minecraft.text.Text text, int color)

Method Summary

Modifier and Type	Method and Description
boolean	canResize() Checks whether this widget can be resized using WWidget.setSize(int, int).
WText	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 alignment of this text widget.
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 alignment of this text widget.
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.
WText	setColor(int color) Sets the light mode color of this label.
WText	setColor(int color, int darkmodeColor) Sets the light and dark mode colors of this label.
WText	setDarkmodeColor(int darkmodeColor) Sets the dark mode color of this label.
WText	setHorizontalAlignment(HorizontalAlignment horizontalAlignment) Sets the horizontal alignment of this text widget.
void	setSize(int x, int y) Sets the size of this widget.
WText	setText(net.minecraft.text.Text text) Sets the text of this label.
WText	setVerticalAlignment(VerticalAlignment verticalAlignment) Sets the vertical alignment of this text widget.

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

color

protected int color

darkmodeColor

protected int darkmodeColor

horizontalAlignment

protected HorizontalAlignment horizontalAlignment

verticalAlignment

protected VerticalAlignment verticalAlignment

Constructor Detail

WText

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

WText

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

Method Detail

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

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

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

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.

getText

public net.minecraft.text.Text getText()

Gets the text of this label.

Returns:

the text

setText

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

Sets the text of this label.

Parameters:

text - the new text

Returns:

this label

getColor

public int getColor()

Gets the light mode color of this label.

Returns:

the color

setColor

public WText setColor(int color)

Sets the light mode color of this label.

Parameters:

color - the new color

Returns:

this text widget

getDarkmodeColor

public int getDarkmodeColor()

Gets the dark mode color of this label.

Returns:

the color

Since:

2.0.0

setDarkmodeColor

public WText setDarkmodeColor(int darkmodeColor)

Sets the dark mode color of this label.

Parameters:

darkmodeColor - the new color

Returns:

this text widget

setColor

public WText 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 text widget

disableDarkmode

public WText disableDarkmode()

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

Returns:

this text widget

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()

Gets the horizontal alignment of this text widget.

Returns:

the alignment

Since:

1.9.0

setHorizontalAlignment

public WText setHorizontalAlignment(HorizontalAlignment horizontalAlignment)

Sets the horizontal alignment of this text widget.

Parameters:

horizontalAlignment - the new alignment

Returns:

this widget

Since:

1.9.0

getVerticalAlignment

public VerticalAlignment getVerticalAlignment()

Gets the vertical alignment of this text widget.

Returns:

the alignment

Since:

2.0.0

setVerticalAlignment

public WText setVerticalAlignment(VerticalAlignment verticalAlignment)

Sets the vertical alignment of this text widget.

Parameters:

verticalAlignment - the new alignment

Returns:

this widget

Since:

2.0.0