Package io.github.thecsdev.tcdcommons.api.client.gui.widget

Class TScrollBarWidget

java.lang.Object

io.github.thecsdev.tcdcommons.api.client.gui.TElement

io.github.thecsdev.tcdcommons.api.client.gui.widget.TClickableWidget

io.github.thecsdev.tcdcommons.api.client.gui.widget.TButtonWidget

io.github.thecsdev.tcdcommons.api.client.gui.widget.TSliderWidget

io.github.thecsdev.tcdcommons.api.client.gui.widget.TScrollBarWidget

All Implemented Interfaces:

TParentElement, ITooltipProvider, IEnableStateProvider, IEnableStateProviderSetter, ITextProvider, ITextProviderSetter

public class TScrollBarWidget
extends TSliderWidget

Nested Class Summary

Nested classes/interfaces inherited from class io.github.thecsdev.tcdcommons.api.client.gui.widget.TClickableWidget

TClickableWidget.TClickableWidgetEvent_Clicked

Nested classes/interfaces inherited from class io.github.thecsdev.tcdcommons.api.client.gui.TElement

TElement.TElementEvent_ChildAR, TElement.TElementEvent_ContextMenu, TElement.TElementEvent_Moved, TElement.TElementEvent_ParentChanged, TElement.TElementEvent_Resized

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isKnobSizeDirty
protected boolean	isValueDirty
protected final TPanelElement	target

Fields inherited from class io.github.thecsdev.tcdcommons.api.client.gui.widget.TSliderWidget

knobSize, sliderDirection, value

Fields inherited from class io.github.thecsdev.tcdcommons.api.client.gui.widget.TButtonWidget

icon, iconColor, onClick, text

Fields inherited from class io.github.thecsdev.tcdcommons.api.client.gui.widget.TClickableWidget

BUTTON_TEXTURE_SLICE_SIZE, BUTTON_TEXTURES, eClicked, enabled, T_WIDGETS_TEXTURE

Fields inherited from class io.github.thecsdev.tcdcommons.api.client.gui.TElement

alpha, eChildAdded, eChildRemoved, eContextMenu, eMoved, eParentChanged, eResized, height, SP_ALL, SP_INVOKE_EVENT, SP_MOVE_CHILDREN, SP_RELATIVE, SP_UPDATE_TOPMOST, SS_ALL, SS_INVOKE_EVENT, SS_UPDATE_TOPMOST, tooltip, tooltipPositioner, width, x, y, zOffset

Fields inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.TParentElement

MAX_CHILD_NESTING_DEPTH

Constructor Summary

Constructors

Constructor	Description
TScrollBarWidget(int x, int y, int width, int height, TPanelElement target)
TScrollBarWidget(int x, int y, int width, int height, TPanelElement target, boolean autoSetScrollFlags)

Method Summary

Modifier and Type	Method	Description
protected final void	applyValueToScroll()	Applies the TSliderWidget.getValue() to the getTarget()'s scroll amount.
final TPanelElement	getTarget()
boolean	input(TInputContext inputContext)	An input handler that handles inputs on the TInputContext.InputDiscoveryPhase.MAIN input phase.
void	refreshKnobSize()	Refreshes this slider's TSliderWidget.getKnobSize() based on the getTarget()'s elements.
void	refreshValue()	Refreshes this slider's TSliderWidget.getValue() based on the getTarget()'s current scroll value.
void	setValue(double value, boolean applyValue)
void	tick()	Used for periodic updates for this TElement.

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.widget.TSliderWidget

getKnobSize, getSliderDirection, getValue, render, renderSliderKnob, renderSliderKnob, renderSliderProgressBar, setKnobSize, setSliderDirection, setValue, setValueFromMouse

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.widget.TButtonWidget

getIcon, getIconColor, getOnClick, getText, onClick, renderBackground, renderIcon, setIcon, setIconColor, setIconColor, setOnClick, setText

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.widget.TClickableWidget

click, getEnabled, isFocusable, setEnabled

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.TElement

canBeAddedTo, createContextMenu, getAlpha, getChildren, getHeight, getItemRenderer, getParent, getParentTElement, getParentTScreen, getTextRenderer, getTooltip, getTooltipPositioner, getWidth, getX, getY, getZIndex, getZOffset, isDragging, isEnabled, isEnabledAndVisible, isFocused, isFocusedOrHovered, isHoverable, isHovered, isVisible, move, moveChildren, next, postRender, previous, setAlpha, setPosition, setPosition, setSize, setSize, setTooltip, setZOffset, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.TParentElement

addChild, addChild, clearChildren, findChild, findLastChild, findParent, findParentTElement, forEachChild, getEndX, getEndY, input, removeChild, removeChild

Field Details

target

protected final TPanelElement target

isValueDirty

protected boolean isValueDirty

isKnobSizeDirty

protected boolean isKnobSizeDirty

Constructor Details

TScrollBarWidget

public TScrollBarWidget(int x,
 int y,
 int width,
 int height,
 TPanelElement target)

TScrollBarWidget

public TScrollBarWidget(int x,
 int y,
 int width,
 int height,
 TPanelElement target,
 boolean autoSetScrollFlags)

Method Details

getTarget

public final TPanelElement getTarget()

tick

public void tick()

Description copied from class: TElement

Used for periodic updates for this TElement.

Overrides:

tick in class TElement

refreshValue

public void refreshValue()

Refreshes this slider's TSliderWidget.getValue() based on the getTarget()'s current scroll value.

refreshKnobSize

public void refreshKnobSize()

Refreshes this slider's TSliderWidget.getKnobSize() based on the getTarget()'s elements.

setValue

public void setValue(double value,
 boolean applyValue)

Overrides:

setValue in class TSliderWidget

applyValueToScroll

protected final void applyValueToScroll()

Applies the TSliderWidget.getValue() to the getTarget()'s scroll amount.

input

public boolean input(TInputContext inputContext)

Description copied from interface: TParentElement

An input handler that handles inputs on the TInputContext.InputDiscoveryPhase.MAIN input phase.

Specified by:

input in interface TParentElement

Overrides:

input in class TSliderWidget

Parameters:

inputContext - The TInputContext containing information about a given input.

See Also:

• TParentElement.input(TInputContext, TInputContext.InputDiscoveryPhase)