Class TScrollBarWidget

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TScrollBarWidget.Flat

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

TSliderWidget acting as a scroll-bar for a given TPanelElement.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TScrollBarWidget.Flat	TScrollBarWidget whose visual appearance is more flat and does not use the vanilla button texture.
static enum	TScrollBarWidget.ScrollDirection	Represents an axis/scroll-direction a given TScrollBarWidget controls.

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
TScrollBarWidget()
TScrollBarWidget(@NotNull TPanelElement panel)
TScrollBarWidget(@NotNull TPanelElement panel, @NotNull TScrollBarWidget.ScrollDirection direction)

Method Summary

Modifier and Type	Method	Description
final boolean	inputCallback(@NotNull TInputContext.InputDiscoveryPhase phase, @NotNull TInputContext context)	A callback method that is invoked when the user makes an input.
final ObjectProperty<@Nullable TPanelElement>	panelProperty()	The ObjectProperty holding the TPanelElement this TSliderWidget is bound to.
final void	refresh()	Manually refreshes the value and knob side of this TScrollBarWidget.
final NotNullProperty<TScrollBarWidget.ScrollDirection>	scrollDirectionProperty()	The NotNullProperty holding the TScrollBarWidget.ScrollDirection of this TScrollBarWidget.

Methods inherited from class TSliderWidget

knobSizeProperty, postRenderCallback, refreshKnobQuietly, renderBackground, renderCallback, renderKnob, valueProperty

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

TScrollBarWidget

public TScrollBarWidget()

TScrollBarWidget

public TScrollBarWidget(@NotNull
 @NotNull TPanelElement panel)

TScrollBarWidget

public TScrollBarWidget(@NotNull
 @NotNull TPanelElement panel,
 @NotNull
 @NotNull TScrollBarWidget.ScrollDirection direction)

Method Details

refresh

public final void refresh()

Manually refreshes the value and knob side of this TScrollBarWidget.

See Also:

• TElement.clearAndInit()

API Note:

Automatically called whenever the target panel (re/)initializes.

panelProperty

public final ObjectProperty<@Nullable TPanelElement> panelProperty()

The ObjectProperty holding the TPanelElement this TSliderWidget is bound to.

scrollDirectionProperty

public final NotNullProperty<TScrollBarWidget.ScrollDirection> scrollDirectionProperty()

The NotNullProperty holding the TScrollBarWidget.ScrollDirection of this TScrollBarWidget. The scroll direction dictates the scroll axis this scroll-bar widget controls.

inputCallback

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

Description copied from class: TSliderWidget

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

Overrides:

inputCallback in class TSliderWidget

Parameters:

phase - The input discovery phase.

context - Information about the user's input.

Returns:

true if this TElement handled the input.