io.github.cottonmc.cotton.gui.widget

Class WToggleButton

java.lang.Object

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

io.github.cottonmc.cotton.gui.widget.WToggleButton

public class WToggleButton
extends WWidget

Field Summary

Fields

Modifier and Type	Field and Description
protected int	color
protected int	darkmodeColor
protected static Texture	DEFAULT_FOCUS_IMAGE
protected static Texture	DEFAULT_OFF_IMAGE
protected static Texture	DEFAULT_ON_IMAGE
protected Texture	focusImage
protected boolean	isOn
protected @Nullable net.minecraft.text.Text	label
protected Texture	offImage
protected Texture	onImage
protected @Nullable java.util.function.Consumer<java.lang.Boolean>	onToggle

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

height, host, parent, width, x, y

Constructor Summary

Constructors

Constructor and Description
WToggleButton() Constructs a toggle button with default images and no label.
WToggleButton(net.minecraft.util.Identifier onImage, net.minecraft.util.Identifier offImage) Constructs a toggle button with custom images and no label.
WToggleButton(net.minecraft.util.Identifier onImage, net.minecraft.util.Identifier offImage, net.minecraft.text.Text label) Constructs a toggle button with custom images.
WToggleButton(net.minecraft.text.Text label) Constructs a toggle button with default images.
WToggleButton(Texture onImage, Texture offImage) Constructs a toggle button with custom images and no label.
WToggleButton(Texture onImage, Texture offImage, net.minecraft.text.Text label) Constructs a toggle button with custom images.

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).
Texture	getFocusImage()
@Nullable net.minecraft.text.Text	getLabel()
Texture	getOffImage()
Texture	getOnImage()
@Nullable java.util.function.Consumer<java.lang.Boolean>	getOnToggle()
boolean	getToggle()
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.
protected void	onToggle(boolean on)
void	paint(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int mouseX, int mouseY) Paints this widget.
WToggleButton	setColor(int light, int dark)
WToggleButton	setFocusImage(Texture focusImage)
WToggleButton	setLabel(@Nullable net.minecraft.text.Text label)
WToggleButton	setOffImage(Texture offImage)
WToggleButton	setOnImage(Texture onImage)
WToggleButton	setOnToggle(@Nullable java.util.function.Consumer<java.lang.Boolean> onToggle)
void	setToggle(boolean on)

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, setSize, tick, validate

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OFF_IMAGE

protected static final Texture DEFAULT_OFF_IMAGE

DEFAULT_ON_IMAGE

protected static final Texture DEFAULT_ON_IMAGE

DEFAULT_FOCUS_IMAGE

protected static final Texture DEFAULT_FOCUS_IMAGE

onImage

protected Texture onImage

offImage

protected Texture offImage

focusImage

protected Texture focusImage

label

@Nullable
protected @Nullable net.minecraft.text.Text label

isOn

protected boolean isOn

onToggle

@Nullable
protected @Nullable java.util.function.Consumer<java.lang.Boolean> onToggle

color

protected int color

darkmodeColor

protected int darkmodeColor

Constructor Detail

WToggleButton

public WToggleButton()

Constructs a toggle button with default images and no label.

WToggleButton

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

Constructs a toggle button with default images.

Parameters:

label - the button label

WToggleButton

public WToggleButton(net.minecraft.util.Identifier onImage,
                     net.minecraft.util.Identifier offImage)

Constructs a toggle button with custom images and no label.

Parameters:

onImage - the toggled on image

offImage - the toggled off image

WToggleButton

public WToggleButton(net.minecraft.util.Identifier onImage,
                     net.minecraft.util.Identifier offImage,
                     net.minecraft.text.Text label)

Constructs a toggle button with custom images.

Parameters:

onImage - the toggled on image

offImage - the toggled off image

label - the button label

WToggleButton

public WToggleButton(Texture onImage,
                     Texture offImage)

Constructs a toggle button with custom images and no label.

Parameters:

onImage - the toggled on image

offImage - the toggled off image

Since:

3.0.0

WToggleButton

public WToggleButton(Texture onImage,
                     Texture offImage,
                     net.minecraft.text.Text label)

Constructs a toggle button with custom images.

Parameters:

onImage - the toggled on image

offImage - the toggled off image

label - the button label

Since:

3.0.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

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

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

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

onToggle

protected void onToggle(boolean on)

getToggle

public boolean getToggle()

setToggle

public void setToggle(boolean on)

getOnToggle

@Nullable
public @Nullable java.util.function.Consumer<java.lang.Boolean> getOnToggle()

setOnToggle

public WToggleButton setOnToggle(@Nullable
                                 @Nullable java.util.function.Consumer<java.lang.Boolean> onToggle)

getLabel

@Nullable
public @Nullable net.minecraft.text.Text getLabel()

setLabel

public WToggleButton setLabel(@Nullable
                              @Nullable net.minecraft.text.Text label)

setColor

public WToggleButton setColor(int light,
                              int dark)

getOnImage

public Texture getOnImage()

setOnImage

public WToggleButton setOnImage(Texture onImage)

getOffImage

public Texture getOffImage()

setOffImage

public WToggleButton setOffImage(Texture offImage)

getFocusImage

public Texture getFocusImage()

setFocusImage

public WToggleButton setFocusImage(Texture focusImage)