io.github.cottonmc.cotton.gui.widget

Enum WAbstractSlider.Direction

java.lang.Object

java.lang.Enum<WAbstractSlider.Direction>

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WAbstractSlider.Direction>

Enclosing class:

WAbstractSlider

public static enum WAbstractSlider.Direction
extends java.lang.Enum<WAbstractSlider.Direction>

The direction enum represents all four directions a slider can face.

For example, a slider whose value grows towards the right faces right.

The default direction for vertical sliders is UP and the one for horizontal sliders is RIGHT.

Since:

2.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN
LEFT
RIGHT
UP

Method Summary

Modifier and Type	Method and Description
Axis	getAxis() Gets the direction's axis.
boolean	isInverted() Returns whether this slider is inverted.
static WAbstractSlider.Direction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WAbstractSlider.Direction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UP

public static final WAbstractSlider.Direction UP

DOWN

public static final WAbstractSlider.Direction DOWN

LEFT

public static final WAbstractSlider.Direction LEFT

RIGHT

public static final WAbstractSlider.Direction RIGHT

Method Detail

values

public static WAbstractSlider.Direction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WAbstractSlider.Direction c : WAbstractSlider.Direction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WAbstractSlider.Direction valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getAxis

public Axis getAxis()

Gets the direction's axis.

Returns:

the axis

isInverted

public boolean isInverted()

Returns whether this slider is inverted.

An inverted slider will have reversed keyboard control.

Returns:

whether this slider is inverted