Class TSliderWidget

java.lang.Object

com.thecsdev.common.scene.Node<TElement>

com.thecsdev.commonmc.api.client.gui.TElement

com.thecsdev.commonmc.api.client.gui.widget.TClickableWidget

com.thecsdev.commonmc.api.client.gui.widget.TButtonWidget

com.thecsdev.commonmc.api.client.gui.widget.TSliderWidget

All Implemented Interfaces:

INode<TElement>, INodeBounded<TElement,Bounds2i>, INodeRenderable<TElement, TGuiGraphics>, Iterable<TElement>, Collection<TElement>

Direct Known Subclasses:

TScrollBarWidget, TSliderWidget.Flat

@Environment(CLIENT)
@Virtual
public class TSliderWidget
extends TButtonWidget

A GUI slider that lets a user select a value by moving a handle along a track. It's often used when a precise numerical input isn't required and a visual representation of the value range is helpful.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TSliderWidget.Flat	TSliderWidget whose visual appearance is more flat and does not use the vanilla button texture.

Nested classes/interfaces inherited from class TButtonWidget

TButtonWidget.Paintable, TButtonWidget.Transparent

Field Summary

Fields inherited from class TButtonWidget

LBL_PAD_X, LBL_PAD_Y

Fields inherited from class TClickableWidget

eClicked, ONCLICK_SOUND

Fields inherited from class TElement

eInitialized

Constructor Summary

Constructors

Constructor	Description
TSliderWidget()
TSliderWidget(@NotNull Point2d value)

Method Summary

Modifier and Type	Method	Description
boolean	inputCallback(TInputContext.InputDiscoveryPhase phase, @NotNull TInputContext context)	A callback method that is invoked when the user makes an input.
final NotNullProperty<UDim2>	knobSizeProperty()	The NotNullProperty holding the XY size of the know, in 0 to 1 number range.
void	postRenderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked after this Node and all of their children have been rendered.
protected final void	refreshKnobQuietly()	Recalculates the knobBounds given the current knobSizeProperty() and valueProperty() values.
void	renderBackground(@NotNull TGuiGraphics pencil)	Renders the background of this TSliderWidget.
final void	renderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked when this Node is being rendered.
void	renderKnob(@NotNull TGuiGraphics pencil, @NotNull Bounds2i kbb)	Renders the knob of this TSliderWidget.
final NotNullProperty<Point2d>	valueProperty()	The NotNullProperty holding the value of this TSliderWidget.

Methods inherited from class TButtonWidget

getLabel, initCallback

Methods inherited from class TClickableWidget

click, clickCallback, dragEndCallback, dragStartCallback, enabledProperty, focusLostCallback, getCursor, hoverGainedCallback, isFocusable, pressedProperty

Methods inherited from class TElement

addRel, boundsProperty, clearAndInit, clipsDescendantsProperty, contextMenuProperty, findElementAt, focusableProperty, focusGainedCallback, forEachVisible, getBaseType, getBounds, getClient, getContentBounds, getSelf, getTooltip, hoverableProperty, hoverLostCallback, invalidateTooltipCache, isFocused, isHoverable, isHovered, isHoveredOrFocused, isVisible, move, moveChildren, moveTo, removeRel, screenProperty, setBounds, setBounds, setBounds, showContextMenu, tickCallback, tooltipProperty, toString, visibleProperty

Methods inherited from class Node

add, addAll, childAddedCallback, childRemovedCallback, clear, contains, containsAll, equals, findChild, findParent, findSibling, forEach, get, getFirst, getLast, getParent, hashCode, indexOf, isEmpty, iterator, parentProperty, remove, remove, remove, removeAll, retainAll, rootProperty, size, toArray, toArray

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface Iterable

forEach

Constructor Details

TSliderWidget

public TSliderWidget(@NotNull
 @NotNull Point2d value)

TSliderWidget

public TSliderWidget()

Method Details

refreshKnobQuietly

@Internal
protected final void refreshKnobQuietly()

Recalculates the knobBounds given the current knobSizeProperty() and valueProperty() values.

Does not invoke change listeners for knobBounds. This is because invoking change listeners would affect the value, and we do not wish to update the value while resizing the knob.

valueProperty

public final NotNullProperty<Point2d> valueProperty()

The NotNullProperty holding the value of this TSliderWidget.

knobSizeProperty

public final NotNullProperty<UDim2> knobSizeProperty()

The NotNullProperty holding the XY size of the know, in 0 to 1 number range. For example, a value of [0.5, 0,5] means the knob takes half the size of the TSliderWidget on both axis.

API Note:

Set an axis to 0 to use the minimum size, of around 10 units.

renderCallback

public final void renderCallback(@NotNull
 @NotNull TGuiGraphics pencil)

Description copied from interface: INodeRenderable

Callback method that is invoked when this Node is being rendered.

Specified by:

renderCallback in interface INodeRenderable<TElement, TGuiGraphics>

Overrides:

renderCallback in class TButtonWidget

Parameters:

pencil - The rendering context.

postRenderCallback

@Virtual
public void postRenderCallback(@NotNull
 @NotNull TGuiGraphics pencil)

Description copied from interface: INodeRenderable

Callback method that is invoked after this Node and all of their children have been rendered.

Specified by:

postRenderCallback in interface INodeRenderable<TElement, TGuiGraphics>

Overrides:

postRenderCallback in class TClickableWidget

Parameters:

pencil - The rendering context.

renderBackground

@Virtual
public void renderBackground(@NotNull
 @NotNull TGuiGraphics pencil)

Renders the background of this TSliderWidget.

renderKnob

@Virtual
public void renderKnob(@NotNull
 @NotNull TGuiGraphics pencil,
 @NotNull
 @NotNull Bounds2i kbb)

Renders the knob of this TSliderWidget.

inputCallback

@NonExtendable
public boolean inputCallback(@NotNull
 TInputContext.InputDiscoveryPhase phase,
 @NotNull
 @NotNull TInputContext context)

A callback method that is invoked when the user makes an input.

Overrides:

inputCallback in class TClickableWidget

Parameters:

phase - The input discovery phase.

context - Information about the user's input.

Returns:

true if this TElement handled the input.

API Note:

Do not override, as this implementation uses internal variables.