io.github.cottonmc.cotton.gui.widget

Class WButton

java.lang.Object

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

io.github.cottonmc.cotton.gui.widget.WButton

public class WButton
extends WWidget

Field Summary

Fields

Modifier and Type	Field and Description
protected HorizontalAlignment	alignment
protected int	color
protected int	darkmodeColor

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

height, host, parent, width, x, y

Constructor Summary

Constructors

Constructor and Description
WButton() Constructs a button with no label and no icon.
WButton(Icon icon) Constructs a button with an icon.
WButton(Icon icon, net.minecraft.text.Text label) Constructs a button with an icon and a label.
WButton(net.minecraft.text.Text label) Constructs a button with a label.

Method Summary

Modifier and Type	Method and Description
boolean	canFocus() Tests whether this widget can have the focus in the GUI.
boolean	canResize() Checks whether this widget can be resized using WWidget.setSize(int, int).
HorizontalAlignment	getAlignment()
@Nullable Icon	getIcon() Gets the icon of this button.
net.minecraft.text.Text	getLabel()
@Nullable java.lang.Runnable	getOnClick() Gets the click handler of this button.
boolean	isEnabled()
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	onKeyPressed(int ch, int key, int modifiers) Notifies this widget that a key has been pressed.
void	paint(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int mouseX, int mouseY) Paints this widget.
WButton	setAlignment(HorizontalAlignment alignment)
WButton	setEnabled(boolean enabled)
WButton	setIcon(@Nullable Icon icon) Sets the icon of this button.
WButton	setLabel(net.minecraft.text.Text label)
WButton	setOnClick(@Nullable java.lang.Runnable onClick) Sets the click handler of this button.
void	setSize(int x, int y) Sets the size of this widget.

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

addPainters, addTooltip, createPeers, cycleFocus, getAbsoluteX, getAbsoluteY, getHeight, getHost, getParent, getWidth, getX, getY, hit, isActivationKey, isFocused, isWithinBounds, onCharTyped, onFocusGained, onFocusLost, onHidden, 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

color

protected int color

darkmodeColor

protected int darkmodeColor

alignment

protected HorizontalAlignment alignment

Constructor Detail

WButton

public WButton()

Constructs a button with no label and no icon.

WButton

public WButton(Icon icon)

Constructs a button with an icon.

Parameters:

icon - the icon

Since:

2.2.0

WButton

public WButton(net.minecraft.text.Text label)

Constructs a button with a label.

Parameters:

label - the label

WButton

public WButton(Icon icon,
               net.minecraft.text.Text label)

Constructs a button with an icon and a label.

Parameters:

icon - the icon

label - the label

Since:

2.2.0

Method Detail

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

canFocus

public boolean canFocus()

Description copied from class: WWidget

Tests whether this widget can have the focus in the GUI.

Overrides:

canFocus in class WWidget

Returns:

true if this widget can be focused, false otherwise

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

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

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.

onKeyPressed

@Environment(value=CLIENT)
public void onKeyPressed(int ch,
                                                     int key,
                                                     int modifiers)

Description copied from class: WWidget

Notifies this widget that a key has been pressed.

Overrides:

onKeyPressed in class WWidget

key - the GLFW scancode of the key

getOnClick

@Nullable
public @Nullable java.lang.Runnable getOnClick()

Gets the click handler of this button.

Returns:

the click handler

Since:

2.2.0

setOnClick

public WButton setOnClick(@Nullable
                          @Nullable java.lang.Runnable onClick)

Sets the click handler of this button.

Parameters:

onClick - the new click handler

Returns:

this button

isEnabled

public boolean isEnabled()

setEnabled

public WButton setEnabled(boolean enabled)

getLabel

public net.minecraft.text.Text getLabel()

setLabel

public WButton setLabel(net.minecraft.text.Text label)

getAlignment

public HorizontalAlignment getAlignment()

setAlignment

public WButton setAlignment(HorizontalAlignment alignment)

getIcon

@Nullable
public @Nullable Icon getIcon()

Gets the icon of this button.

Returns:

the icon

Since:

2.2.0

setIcon

public WButton setIcon(@Nullable
                       @Nullable Icon icon)

Sets the icon of this button.

Parameters:

icon - the new icon

Returns:

this button

Since:

2.2.0