io.github.cottonmc.cotton.gui.widget

Class WAbstractSlider

java.lang.Object

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

io.github.cottonmc.cotton.gui.widget.WAbstractSlider

Direct Known Subclasses:

WLabeledSlider, WSlider

public abstract class WAbstractSlider
extends WWidget

A base class for slider widgets that can be used to select int values.

You can set two listeners on a slider:

• A value change listener that gets all value changes.
• A dragging finished listener that gets called when the player stops dragging the slider or modifies the value with the keyboard. For example, this can be used for sending sync packets to the server when the player has selected a value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WAbstractSlider.Direction The direction enum represents all four directions a slider can face.

Field Summary

Fields

Modifier and Type	Field and Description
protected Axis	axis
protected float	coordToValueRatio A coordinate:value ratio.
protected WAbstractSlider.Direction	direction
protected boolean	dragging True if the user is currently dragging the thumb.
protected int	max
protected int	min
protected int	value
protected float	valueToCoordRatio A value:coordinate ratio.

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

height, host, parent, width, x, y

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WAbstractSlider(int min, int max, Axis axis)

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).
Axis	getAxis()
WAbstractSlider.Direction	getDirection() Gets the direction of this slider.
@Nullable java.util.function.IntConsumer	getDraggingFinishedListener()
int	getMaxValue()
int	getMinValue()
protected abstract int	getThumbWidth()
int	getValue()
@Nullable java.util.function.IntConsumer	getValueChangeListener()
static boolean	isDecreasingKey(int ch, WAbstractSlider.Direction direction) Tests if the key should decrease sliders with the specified direction.
boolean	isDragging() Tests whether the user is dragging this slider.
static boolean	isIncreasingKey(int ch, WAbstractSlider.Direction direction) Tests if the key should increase sliders with the specified direction.
protected abstract boolean	isMouseInsideBounds(int x, int y) Checks if the mouse cursor is close enough to the slider that the user can start dragging.
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	onKeyReleased(int ch, int key, int modifiers) Notifies this widget that a key has been released
InputResult	onMouseDown(int x, int y, int button) Notifies this widget that the mouse has been pressed while inside its bounds
InputResult	onMouseDrag(int x, int y, int button, double deltaX, double deltaY) Notifies this widget that the mouse has been moved while pressed and inside its bounds.
InputResult	onMouseScroll(int x, int y, double amount) Notifies this widget that the mouse has been scrolled inside its bounds.
InputResult	onMouseUp(int x, int y, int button) Notifies this widget that the mouse has been released while inside its bounds
protected void	onValueChanged(int value)
void	setDirection(WAbstractSlider.Direction direction) Sets the direction of this slider.
void	setDraggingFinishedListener(@Nullable java.util.function.IntConsumer draggingFinishedListener)
void	setMaxValue(int max)
void	setMinValue(int min)
void	setSize(int x, int y) Sets the size of this widget.
void	setValue(int value) Sets the slider value without calling listeners.
void	setValue(int value, boolean callListeners) Sets the slider value.
void	setValueChangeListener(@Nullable java.util.function.IntConsumer valueChangeListener)
void	tick() Executes a client-side tick for 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, onMouseMove, onShown, paint, releaseFocus, renderTooltip, requestFocus, setHost, setLocation, setParent, validate

Methods inherited from class java.lang.Object

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

Field Detail

min

protected int min

max

protected int max

axis

protected final Axis axis

direction

protected WAbstractSlider.Direction direction

value

protected int value

dragging

protected boolean dragging

True if the user is currently dragging the thumb. Used for visuals.

valueToCoordRatio

protected float valueToCoordRatio

A value:coordinate ratio. Used for converting user input into values.

coordToValueRatio

protected float coordToValueRatio

A coordinate:value ratio. Used for rendering the thumb.

Constructor Detail

WAbstractSlider

protected WAbstractSlider(int min,
                          int max,
                          Axis axis)

Method Detail

getThumbWidth

protected abstract int getThumbWidth()

Returns:

the thumb size along the slider axis

isMouseInsideBounds

protected abstract boolean isMouseInsideBounds(int x,
                                               int y)

Checks if the mouse cursor is close enough to the slider that the user can start dragging.

Parameters:

x - the mouse x position

y - the mouse y position

Returns:

if the cursor is inside dragging bounds

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

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

onMouseDown

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

Description copied from class: WWidget

Notifies this widget that the mouse has been pressed while inside its bounds

Overrides:

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

onMouseDrag

@Environment(value=CLIENT)
public InputResult onMouseDrag(int x,
                                                           int y,
                                                           int button,
                                                           double deltaX,
                                                           double deltaY)

Description copied from class: WWidget

Notifies this widget that the mouse has been moved while pressed and inside its bounds.

Overrides:

onMouseDrag 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)

deltaX - The amount of dragging on the X axis

deltaY - The amount of dragging on the Y axis

Returns:

InputResult.PROCESSED if the event is handled, InputResult.IGNORED 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.

onMouseUp

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

Description copied from class: WWidget

Notifies this widget that the mouse has been released while inside its bounds

Overrides:

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

onMouseScroll

@Environment(value=CLIENT)
public InputResult onMouseScroll(int x,
                                                             int y,
                                                             double amount)

Description copied from class: WWidget

Notifies this widget that the mouse has been scrolled inside its bounds.

Overrides:

onMouseScroll 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)

amount - The scrolled amount. Positive values are up and negative values are down.

Returns:

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

tick

@Environment(value=CLIENT)
public void tick()

Description copied from class: WWidget

Executes a client-side tick for this widget.

Overrides:

tick in class WWidget

getValue

public int getValue()

setValue

public void setValue(int value)

Sets the slider value without calling listeners.

Parameters:

value - the new value

setValue

public void setValue(int value,
                     boolean callListeners)

Sets the slider value.

Parameters:

value - the new value

callListeners - if true, call all slider listeners

getValueChangeListener

@Nullable
public @Nullable java.util.function.IntConsumer getValueChangeListener()

setValueChangeListener

public void setValueChangeListener(@Nullable
                                   @Nullable java.util.function.IntConsumer valueChangeListener)

getDraggingFinishedListener

@Nullable
public @Nullable java.util.function.IntConsumer getDraggingFinishedListener()

setDraggingFinishedListener

public void setDraggingFinishedListener(@Nullable
                                        @Nullable java.util.function.IntConsumer draggingFinishedListener)

getMinValue

public int getMinValue()

getMaxValue

public int getMaxValue()

setMinValue

public void setMinValue(int min)

setMaxValue

public void setMaxValue(int max)

getAxis

public Axis getAxis()

getDirection

public WAbstractSlider.Direction getDirection()

Gets the direction of this slider.

Returns:

the direction

Since:

2.0.0

setDirection

public void setDirection(WAbstractSlider.Direction direction)

Sets the direction of this slider.

Parameters:

direction - the new direction

Throws:

java.lang.IllegalArgumentException - if the direction axis is not equal to axis.

Since:

2.0.0

onValueChanged

protected void onValueChanged(int value)

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

onKeyReleased

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

Description copied from class: WWidget

Notifies this widget that a key has been released

Overrides:

onKeyReleased in class WWidget

key - the GLFW scancode of the key

isDragging

public boolean isDragging()

Tests whether the user is dragging this slider.

Returns:

true if this slider is being dragged, false otherwise

Since:

4.0.0

isDecreasingKey

public static boolean isDecreasingKey(int ch,
                                      WAbstractSlider.Direction direction)

Tests if the key should decrease sliders with the specified direction.

Parameters:

ch - the key code

direction - the direction

Returns:

true if the key should decrease sliders with the direction, false otherwise

Since:

2.0.0

isIncreasingKey

public static boolean isIncreasingKey(int ch,
                                      WAbstractSlider.Direction direction)

Tests if the key should increase sliders with the specified direction.

Parameters:

ch - the key code

direction - the direction

Returns:

true if the key should increase sliders with the direction, false otherwise

Since:

2.0.0